Docs

Start here

List saved presets

GET/v1/studio/presetson https://api.auray.ai/v1

Your saved palettes and lighting rigs, newest change first.

Your saved palettes and lighting rigs, newest change first. 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

#Query parameters

NameTypeRequiredDescription
kindstringnoOne of "palette", "lighting".

#Example request

curl https://api.auray.ai/v1/studio/presets \
  -H "Authorization: Bearer $AURAY_API_KEY"

#Responses

#200 OK

OK.

FieldTypeRequiredDefaultDescription
objectstringyes—One of "list".
dataobject[]yes—
data[].objectstringyes—One of "preset".
data[].idstringyes—
data[].kindstringyes—One of "palette", "lighting".
data[].namestringyes—0 to 60 characters.
data[].paletteobjectno—
data[].palette.namestringyes—0 to 60 characters.
data[].palette.swatchesstring[]yes—
data[].rigobjectno—
data[].rig.lightsobject[]yes—
data[].rig.lights[].colorstringyes—
data[].rig.lights[].intensitynumberyes—0 to 1.
data[].rig.lights[].diffusionnumberyes—0 a bare bulb, 1 a cloud. 0 to 1.
data[].rig.lights[].azimuthnumberyes—Degrees around the subject, 0 in front. 0 to ….
data[].rig.lights[].elevationnumberyes—-90 to 90.
data[].rig.ambientobjectyes—
data[].rig.ambient.colorstringyes—
data[].rig.ambient.intensitynumberyes—0 to 1.
data[].created_atstringyes—
data[].updated_atstringyes—
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

#429 Too Many Requests

#500 Internal Server Error

#503 Service Unavailable

#Status codes

StatusMeaning
200OK.
400Bad Request
401Unauthorized
403Forbidden
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