Docs

Start here

Read a script

GET/v1/studio/projects/{project}/scripts/{script}on https://api.auray.ai/v1

A script, every scene's heading and who speaks in it, and a part of its words: one scene (scene), or from a place in the text (from, 0 for its start) — at most 20,000 characters a read, ending on a…

A script, every scene's heading and who speaks in it, and a part of its words: one scene (scene), or from a place in the text (from, 0 for its start) — at most 20,000 characters a read, ending on a whole line; part.next_from is where the next read starts, and part.more says whether what was asked runs on. Places count characters as the text holds 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_… — a key with the scope the route names.

#Request

#Path parameters

NameTypeRequiredDescription
projectstringyes
scriptstringyes

#Query parameters

NameTypeRequiredDescription
sceneintegernoThe scene to read, 1 for the first. 1 to 1000.
fromintegernoWhere in the text — or in the scene — to start, in characters. 0 to 600000.

#Example request

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

#Responses

#200 OK

OK.

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