Docs

Start here

Ask to join a project

POST/v1/studio/access-requestson https://api.auray.ai/v1

Ask to join a project, or for a higher role in it.

Ask to join a project, or for a higher role in it. The project is named in the body, and the answer is received alike whether it exists, whether you may see it, and whether you may ask for that role there — a project id is never a way to learn that a private project is there. The members who decide see a real request and are told; you hear back only if it is approved. 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

#Body

application/json, required.

FieldTypeRequiredDefaultDescription
project_idstringyes—
rolestringyes—One of "admin", "collaborator", "viewer".
messagestringno—0 to 300 characters. May be null.

#Example request

curl -X POST https://api.auray.ai/v1/studio/access-requests \
  -H "Authorization: Bearer $AURAY_API_KEY" \
  -H "content-type: application/json" \
  -d '{
  "project_id": "3f0c8a52-6a1d-4e8b-9c2d-7e5f4a3b2c1d",
  "role": "viewer",
  "message": "Cutting the trailer, and need the clips."
}'

#Responses

#201 Created

Created.

FieldTypeRequiredDefaultDescription
objectstringyes—One of "access_request".
receivedbooleanyes—One of true.
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

#409 Conflict

#413 Payload Too Large

#429 Too Many Requests

#500 Internal Server Error

#503 Service Unavailable

#Status codes

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