Docs

Start here

Get a project's brief

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

A project's brief: a rich-text document, and the revision it is at.

A project's brief: a rich-text document, and the revision it is at. 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

#Example request

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

#Responses

#200 OK

OK.

FieldTypeRequiredDefaultDescription
objectstringyes—One of "brief".
project_idstringyes—
docobjectyes—A rich-text document as an editor writes it (a ProseMirror document), at most 256 KB of JSON.
doc.typestringyes—One of "doc".
doc.contentany[]no—
revintegeryes—0 for a brief nobody has written. A save names the rev it was written from. 0 to ….
updated_atstringyes—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

#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