Start here
List elements
GET
/v1/studio/elementson https://api.auray.ai/v1A page of your elements — characters, locations and props, every version — or one project's, newest change first.
A page of your elements — characters, locations and props, every version — or one project's, newest change first. Takes a key holding studio:read (or studio:write, which reads too) — Account offers both unticked — or the desktop's own session key. Spends nothing.
#Authentication
Authorization: Bearer auray_sk_… — studio:read, or studio:write, which reads too — Account offers both unticked; the desktop's session key holds both.
#Request
#Query parameters
| Name | Type | Required | Description |
|---|---|---|---|
cursor | string | no | The next_cursor the previous page answered, unchanged, with the same filters. None for the first page. 0 to 120 characters. |
limit | integer | no | How many on a page. 1 to 100. |
category | string | no | One of "character", "location", "prop". |
status | string | no | One of "draft", "ready", "archived". |
project | string | no | One project's elements, every member's; left out, your own across every project. |
q | string | no | Words of an element's name, handle or description. 0 to 200 characters. |
#Example request
curl https://api.auray.ai/v1/studio/elements \
-H "Authorization: Bearer $AURAY_API_KEY"const res = await fetch("https://api.auray.ai/v1/studio/elements", {
method: "GET",
headers: { Authorization: `Bearer ${process.env.AURAY_API_KEY}` },
});
console.log(await res.json());import os, requests
r = requests.get(
"https://api.auray.ai/v1/studio/elements",
headers={"Authorization": f"Bearer {os.environ['AURAY_API_KEY']}"},
)
r.raise_for_status()
print(r.json())package main
import (
"fmt"
"io"
"net/http"
"os"
)
func main() {
req, err := http.NewRequest("GET", "https://api.auray.ai/v1/studio/elements", nil)
if err != nil {
panic(err)
}
req.Header.Set("Authorization", "Bearer "+os.Getenv("AURAY_API_KEY"))
res, err := http.DefaultClient.Do(req)
if err != nil {
panic(err)
}
defer res.Body.Close()
out, _ := io.ReadAll(res.Body)
fmt.Println(res.Status, string(out))
}<?php
$ch = curl_init("https://api.auray.ai/v1/studio/elements");
curl_setopt_array($ch, [
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_HTTPHEADER => [
"Authorization: Bearer " . getenv("AURAY_API_KEY"),
],
]);
$response = curl_exec($ch);
echo curl_getinfo($ch, CURLINFO_HTTP_CODE), " ", $response, PHP_EOL;require "net/http"
uri = URI("https://api.auray.ai/v1/studio/elements")
req = Net::HTTP::Get.new(uri)
req["Authorization"] = "Bearer #{ENV.fetch("AURAY_API_KEY")}"
res = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) { |http| http.request(req) }
puts res.code, res.bodyimport java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;
public class Main {
public static void main(String[] args) throws Exception {
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("https://api.auray.ai/v1/studio/elements"))
.header("Authorization", "Bearer " + System.getenv("AURAY_API_KEY"))
.GET()
.build();
HttpResponse<String> response = HttpClient.newHttpClient()
.send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.statusCode() + " " + response.body());
}
}using System.Net.Http.Headers;
using var client = new HttpClient();
client.DefaultRequestHeaders.Authorization =
new AuthenticationHeaderValue("Bearer", Environment.GetEnvironmentVariable("AURAY_API_KEY"));
using var request = new HttpRequestMessage(HttpMethod.Get, "https://api.auray.ai/v1/studio/elements");
using var response = await client.SendAsync(request);
Console.WriteLine($"{(int)response.StatusCode} {await response.Content.ReadAsStringAsync()}");#Responses
#200 OK
OK.
| Field | Type | Required | Default | Description |
|---|---|---|---|---|
object | string | yes | — | One of "list". |
data | object[] | yes | — | |
data[].object | string | yes | — | One of "element". |
data[].id | string | yes | — | |
data[].handle | string | yes | — | What a prompt names it by: @char_aliya_v1. Every version has its own. |
data[].name | string | yes | — | 0 to 60 characters. |
data[].category | string | yes | — | One of "character", "location", "prop". |
data[].version | integer | yes | — | 1 to …. |
data[].lineage_id | string | yes | — | Every version of one element shares it. |
data[].description | string | yes | — | 0 to 1000 characters. May be null. |
data[].files | object[] | yes | — | |
data[].files[].role | string | yes | — | original as made or uploaded; thumbnail a smaller picture for a card; poster a frame of a clip or a view of a mesh. One of "original", "thumbnail", "poster". |
data[].files[].url | string | yes | — | A URL. |
data[].files[].expires_at | string | yes | — | |
data[].files[].content_type | string | yes | — | |
data[].files[].bytes | integer | yes | — | May be null. |
data[].files[].width | integer | yes | — | May be null. |
data[].files[].height | integer | yes | — | May be null. |
data[].files[].duration_ms | integer | yes | — | May be null. |
data[].properties | object[] | yes | — | |
data[].properties[].key | string | yes | — | 0 to 40 characters. |
data[].properties[].value | string | yes | — | 0 to 200 characters. |
data[].status | string | yes | — | One of "draft", "ready", "archived". |
data[].project_id | string | yes | — | The project it was made in; null for one of your own across every project. May be null. |
data[].created_at | string | yes | — | |
data[].updated_at | string | yes | — | |
next_cursor | string | yes | — | Send it as cursor for the next page; null on the last. May be null. |
request_id | string | no | — | Mirrored in the X-Request-Id header. |
Headers:
| Header | Description |
|---|---|
RateLimit-Limit | Burst capacity. |
RateLimit-Remaining | |
RateLimit-Reset | Seconds until refill. |
X-RateLimit-Limit | |
X-RateLimit-Remaining | |
X-RateLimit-Reset | Unix seconds. The X- spelling is what client libraries read. |
X-Request-Id |
#400 Bad Request
#401 Unauthorized
#403 Forbidden
#429 Too Many Requests
#500 Internal Server Error
#503 Service Unavailable
#Status codes
| Status | Meaning |
|---|---|
200 | OK. |
400 | Bad Request |
401 | Unauthorized |
403 | Forbidden |
429 | Too Many Requests |
500 | Internal Server Error |
503 | Service Unavailable |
Every refusal names its code, and every code is explained at Errors.