Docs

Start here

Get a canvas

GET/v1/studio/projects/{project}/canvases/{canvas}on https://api.auray.ai/v1

A canvas and its document, with every node that runs carrying its last run: its status, the jobs it started, what they made (items of the project once filed, the job until then), the failure, the m…

A canvas and its document, with every node that runs carrying its last run: its status, the jobs it started, what they made (items of the project once filed, the job until then), the failure, the member who ran it and whose credits it spent. A run is read off the jobs themselves, never off anything a window sent. 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

#Path parameters

NameTypeRequiredDescription
projectstringyes
canvasstringyes

#Example request

curl https://api.auray.ai/v1/studio/projects/3f0c8a52-6a1d-4e8b-9c2d-7e5f4a3b2c1d/canvases/… \
  -H "Authorization: Bearer $AURAY_API_KEY"

#Responses

#200 OK

OK.

FieldTypeRequiredDefaultDescription
objectstringyes—One of "canvas".
idstringyes—
project_idstringyes—
namestringyes—0 to 80 characters.
revintegeryes—A save names the rev it was drawn from. 1 to ….
pagesintegeryes—1 to ….
nodesintegeryes—0 to ….
updated_atstringyes—
updated_bynull or objectyes—Who saved it last, while they are a member; null once they left.
docobjectyes—A canvas document, version 1: pages (up to 20), each with its viewport, its nodes (up to 1,500 — prompts, generators, uploads and the project's assets, upscalers, editors, notes, stickies, shapes, text, drawn strokes, tables, comment pins, reactions and frames) and the edges wiring an output port into an input port that takes its type. The full shape is published with the Studio's contract; a document that does not read is refused canvas_invalid, naming each problem. A node's run is the server's: anything sent there is ignored.
doc.vintegeryes—One of 1.
doc.pagesobject[]yes—
doc.pages[].idstringyes—
doc.pages[].namestringyes—0 to 80 characters.
doc.pages[].viewportobjectyes—
doc.pages[].viewport.xnumberno—
doc.pages[].viewport.ynumberno—
doc.pages[].viewport.zoomnumberno—0.05 to 4.
doc.pages[].nodesobject[]yes—
doc.pages[].nodes[].idstringyes—
doc.pages[].nodes[].kindstringyes—One of "prompt", "number", "upload", "assets", "image_gen", "video_gen", "audio_gen", "llm", "upscale", "edit", "note", "sticky", "shape", "text", "stroke", "table", "comment_pin", "reaction", "frame".
doc.pages[].nodes[].xnumberyes—
doc.pages[].nodes[].ynumberyes—
doc.pages[].nodes[].wnumberyes—
doc.pages[].nodes[].hnumberyes—
doc.pages[].nodes[].parentstringno—May be null.
doc.pages[].nodes[].zintegerno—
doc.pages[].nodes[].lockedbooleanno—
doc.pages[].nodes[].dataobjectyes—
doc.pages[].nodes[].runobjectno—A node's last run, read off the jobs it started — never written by a request. Null before it ran. May be null.
doc.pages[].edgesobject[]yes—
doc.pages[].edges[].idstringyes—
doc.pages[].edges[].fromobjectyes—
doc.pages[].edges[].toobjectyes—
bytesintegeryes—The document's size as JSON, which is kept up to 2 MB. 0 to ….
crdtstringyes—The name the canvas's live edits travel under: canvas: and its id.
request_idstringno—Mirrored in the X-Request-Id header.

Headers:

HeaderDescription
RateLimit-LimitBurst capacity.
RateLimit-Remaining
RateLimit-ResetSeconds until refill.
X-RateLimit-Limit
X-RateLimit-Remaining
X-RateLimit-ResetUnix seconds. The X- spelling is what client libraries read.
X-Request-Id

#401 Unauthorized

#403 Forbidden

#404 Not Found

#429 Too Many Requests

#500 Internal Server Error

#503 Service Unavailable

#Status codes

StatusMeaning
200OK.
401Unauthorized
403Forbidden
404Not Found
429Too Many Requests
500Internal Server Error
503Service Unavailable

Every refusal names its code, and every code is explained at Errors.

Start typing to search every page of the documentation.

Up arrow Down arrow to moveEnter to openEscape to close