Docs

Start here

Set an item's review status

POST/v1/studio/projects/{project}/items/{item}/reviewson https://api.auray.ai/v1

Set an item's review status, with a note.

Set an item's review status, with a note. Setting the status it already has is kept as a line of its own, the note being the point of it. A request for review tells the project; an approval or a rejection tells the item's maker. 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

#Path parameters

NameTypeRequiredDescription
projectstringyes
itemstringyes

#Body

application/json, required.

FieldTypeRequiredDefaultDescription
statusstringyes—One of "none", "in_progress", "needs_review", "approved", "rejected".
notestringno—0 to 500 characters. May be null.

#Example request

curl -X POST https://api.auray.ai/v1/studio/projects/3f0c8a52-6a1d-4e8b-9c2d-7e5f4a3b2c1d/items/0a1b2c3d-4e5f-4a6b-8c7d-9e0f1a2b3c4d/reviews \
  -H "Authorization: Bearer $AURAY_API_KEY" \
  -H "content-type: application/json" \
  -d '{
  "status": "needs_review",
  "note": "Check the colours against the palette."
}'

#Responses

#201 Created

Created.

FieldTypeRequiredDefaultDescription
objectstringyes—One of "review".
idstringyes—
item_idstringyes—
fromstringyes—One of "none", "in_progress", "needs_review", "approved", "rejected".
tostringyes—One of "none", "in_progress", "needs_review", "approved", "rejected".
notestringyes—0 to 500 characters. May be null.
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.
by.member_idstringyes—May be null.
by.namestringyes—May be null.
by.handlestringyes—May be null.
by.avatar_urlstringyes—A URL. May be null.
by.leftbooleanyes—Gone from the project since; what they wrote stays, with their name.
atstringyes—
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
201Created.
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