Docs

Start here

Comment on an item

POST/v1/studio/projects/{project}/commentson https://api.auray.ai/v1

Comment on an item: a pin on a picture, a stretch or a frame of a clip, a stretch of a song, a drawing laid over a picture or a frame, or a reply to the comment a thread started with.

Comment on an item: a pin on a picture, a stretch or a frame of a clip, a stretch of a song, a drawing laid over a picture or a frame, or a reply to the comment a thread started with. The item's maker is told of a comment, everyone in a thread of a reply. 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

#Body

application/json, required.

FieldTypeRequiredDefaultDescription
item_idstringyes—
bodystringyes—1 to 2000 characters.
anchorobjectno—Where a comment points: nowhere in particular, a point of a picture (pin, x and y from 0 to 1), a stretch of a clip or a song (range, whole milliseconds), or a point of a clip's frame at a moment (frame).
anchor.kindstringyes—One of "none", "pin", "range", "frame".
anchor.xnumberno—0 to 1.
anchor.ynumberno—0 to 1.
anchor.start_msintegerno—0 to ….
anchor.end_msintegerno—0 to ….
anchor.at_msintegerno—0 to ….
drawingobject[]no—May be null.
drawing[].pointsnumber[][]yes—
drawing[].colorstringyes—
drawing[].widthnumberyes—… to 0.05.
parent_idstringno—May be null.

#Example request

curl -X POST https://api.auray.ai/v1/studio/projects/3f0c8a52-6a1d-4e8b-9c2d-7e5f4a3b2c1d/comments \
  -H "Authorization: Bearer $AURAY_API_KEY" \
  -H "content-type: application/json" \
  -d '{
  "item_id": "0a1b2c3d-4e5f-4a6b-8c7d-9e0f1a2b3c4d",
  "body": "Hold this shot a beat longer.",
  "anchor": {
    "kind": "range",
    "start_ms": 2400,
    "end_ms": 3900
  }
}'

#Responses

#201 Created

Created.

FieldTypeRequiredDefaultDescription
objectstringyes—One of "comment".
idstringyes—
item_idstringyes—
parent_idstringyes—May be null.
bodystringyes—0 to 2000 characters.
anchorobjectyes—Where a comment points: nowhere in particular, a point of a picture (pin, x and y from 0 to 1), a stretch of a clip or a song (range, whole milliseconds), or a point of a clip's frame at a moment (frame).
anchor.kindstringyes—One of "none", "pin", "range", "frame".
anchor.xnumberno—0 to 1.
anchor.ynumberno—0 to 1.
anchor.start_msintegerno—0 to ….
anchor.end_msintegerno—0 to ….
anchor.at_msintegerno—0 to ….
drawingnull or object[]yes—
authorobjectyes—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.
author.member_idstringyes—May be null.
author.namestringyes—May be null.
author.handlestringyes—May be null.
author.avatar_urlstringyes—A URL. May be null.
author.leftbooleanyes—Gone from the project since; what they wrote stays, with their name.
minebooleanyes—
reactionsobject[]yes—
reactions[].idstringyes—One of "thumbs_up", "heart", "laugh", "wow", "party", "eyes", "fire", "check".
reactions[].countintegeryes—1 to ….
reactions[].minebooleanyes—
repliesintegeryes—0 to ….
resolved_atstringyes—May be null.
resolved_bynull or objectyes—
edited_atstringyes—May be null.
deletedbooleanyes—Deleted with replies under it: kept as a line saying so, its words gone.
created_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

#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
404Not Found
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