Docs

Start here

Read an invitation before accepting it

POST/v1/studio/invites/peekon https://api.auray.ai/v1

What an invitation is to — the project's name, cover and size, the role, who invited you and until when — and nothing of the inside.

What an invitation is to — the project's name, cover and size, the role, who invited you and until when — and nothing of the inside. Every token that opens nothing answers invite_invalid alike. 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

#Body

application/json, required.

FieldTypeRequiredDefaultDescription
tokenstringyes—The token the invitation's link carries in its fragment (#studio-invite=<token>).

#Example request

curl -X POST https://api.auray.ai/v1/studio/invites/peek \
  -H "Authorization: Bearer $AURAY_API_KEY" \
  -H "content-type: application/json" \
  -d '{
  "token": "…"
}'

#Responses

#200 OK

OK.

FieldTypeRequiredDefaultDescription
objectstringyes—One of "invite_preview".
projectobjectyes—
project.namestringyes—
project.cover_urlstringyes—A URL. May be null.
project.membersintegeryes—1 to ….
rolestringyes—One of "admin", "collaborator", "viewer".
invited_byobjectyes—Somebody as a project shows them: their membership's id while they are in it and the public Community profile they chose — never an account or an address.
invited_by.member_idstringyes—May be null.
invited_by.namestringyes—May be null.
invited_by.handlestringyes—May be null.
invited_by.avatar_urlstringyes—A URL. May be null.
invited_by.leftbooleanyes—Gone from the project since; what they wrote stays, with their name.
expires_atstringyes—
memberbooleanyes—Already a member: accepting only opens the project.
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

#410 Gone

#413 Payload Too Large

#429 Too Many Requests

#500 Internal Server Error

#503 Service Unavailable

#Status codes

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