Docs

Start here

List a project's canvases

GET/v1/studio/projects/{project}/canvaseson https://api.auray.ai/v1

A project's canvases, most recently changed first, each without its document: its name, revision, how many pages and nodes it has, and the member who last changed it.

A project's canvases, most recently changed first, each without its document: its name, revision, how many pages and nodes it has, and the member who last changed it. Every member reads them. 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

#Query parameters

NameTypeRequiredDescription
cursorstringnoThe next_cursor the previous page answered, unchanged. None for the first page. 0 to 120 characters.
limitintegernoHow many on a page. 1 to 100.

#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 "list".
dataobject[]yes—
data[].objectstringyes—One of "canvas".
data[].idstringyes—
data[].project_idstringyes—
data[].namestringyes—0 to 80 characters.
data[].revintegeryes—A save names the rev it was drawn from. 1 to ….
data[].pagesintegeryes—1 to ….
data[].nodesintegeryes—0 to ….
data[].updated_atstringyes—
data[].updated_bynull or objectyes—Who saved it last, while they are a member; null once they left.
next_cursorstringyes—Send it as cursor for the next page; null on the last. May be null.
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

#400 Bad Request

#401 Unauthorized

#403 Forbidden

#404 Not Found

#429 Too Many Requests

#500 Internal Server Error

#503 Service Unavailable

#Status codes

StatusMeaning
200OK.
400Bad Request
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