Docs

Start here

Merge changes into the brief's shared document

POST/v1/studio/projects/{project}/brief/stateon https://api.auray.ai/v1

Merge a window's Yjs update (base64) into the brief's shared document.

Merge a window's Yjs update (base64) into the brief's shared document. The API merges it over whatever other windows wrote first — nobody's words are lost — and keeps the brief's JSON for every other reader. seed is the first write of a brief that existed before it was shared, taken only while nothing is stored: a second seed is refused revision_conflict and loads the first. From the first push on, a whole-document save (POST /v1/studio/projects/{project}/brief) is written into the shared document as a change of it, block by block. Takes a key holding studio:write — Account offers it unticked — or the desktop's own session key. Spends nothing.

#Authentication

Authorization: Bearer auray_sk_… — a key with the scope the route names.

#Request

#Path parameters

NameTypeRequiredDescription
projectstringyes

#Body

application/json, required.

FieldTypeRequiredDefaultDescription
updatestringyes—The bytes, base64. 1 to … characters.
seedbooleanno—

#Example request

curl -X POST https://api.auray.ai/v1/studio/projects/3f0c8a52-6a1d-4e8b-9c2d-7e5f4a3b2c1d/brief/state \
  -H "Authorization: Bearer $AURAY_API_KEY" \
  -H "content-type: application/json" \
  -d '{
  "update": "<base64>"
}'

#Responses

#200 OK

OK.

FieldTypeRequiredDefaultDescription
objectstringyes—One of "crdt_ack".
docstringyes—brief, or canvas: and the canvas's id.
revintegeryes—0 to ….
state_vectorstringyes—The bytes, base64.
bytesintegeryes—0 to 2097152.
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

#409 Conflict

#413 Payload Too Large

#429 Too Many Requests

#500 Internal Server Error

#503 Service Unavailable

#Status codes

StatusMeaning
200OK.
400Bad Request
401Unauthorized
403Forbidden
404Not Found
409Conflict
413Payload Too Large
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