Docs

Start here

Rename or move a folder

POST/v1/studio/projects/{project}/folders/{folder}on https://api.auray.ai/v1

Rename a folder, or move it in the list.

Rename a folder, or move it in the list. Takes a key holding studio:write — Account offers it unticked — or the desktop's own session key. Spends nothing.

#Authentication

Authorization: Bearer auray_sk_… — studio:write — Account offers it unticked; the desktop's session key holds it.

#Request

#Path parameters

NameTypeRequiredDescription
projectstringyes
folderstringyes

#Body

application/json, required.

FieldTypeRequiredDefaultDescription
namestringno—0 to 60 characters.
positionintegerno—0 to ….

#Example request

curl -X POST https://api.auray.ai/v1/studio/projects/3f0c8a52-6a1d-4e8b-9c2d-7e5f4a3b2c1d/folders/9e8d7c6b-5a4f-4e3d-8c2b-1a0f9e8d7c6b \
  -H "Authorization: Bearer $AURAY_API_KEY" \
  -H "content-type: application/json" \
  -d '{
  "position": 2
}'

#Responses

#200 OK

OK.

FieldTypeRequiredDefaultDescription
objectstringyes—One of "folder".
idstringyes—
systemstringyes—One of "all", "generations", "uploads", "elements", null. May be null.
namestringyes—0 to 60 characters. May be null.
countintegeryes—Items in it (for elements, elements), the Trash not counted.
positionintegeryes—
created_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

#400 Bad Request

#401 Unauthorized

#403 Forbidden

#404 Not Found

#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
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