Docs

Start here

Comment on a work

POST/v1/community/publications/{id}/commentson https://api.auray.ai/v1

Comment on a shown work as your public profile, or reply to one of its comments with parent_id.

Comment on a shown work as your public profile, or reply to one of its comments with parent_id. The automatic check reads it first; ten a minute at most. Takes a key holding community:write — Account offers it unticked — or the desktop's own session key. Spends nothing. While our team has paused comments it answers 503 comments_paused before the body is read, and nothing is posted.

#Authentication

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

#Request

#Path parameters

NameTypeRequiredDescription
idstringyes

#Body

application/json, required.

FieldTypeRequiredDefaultDescription
bodystringyes—1 to 1000 characters; it may break lines. 0 to 1000 characters.
parent_idstringno—May be null.

#Example request

curl -X POST https://api.auray.ai/v1/community/publications/3f0c8a52-6a1d-4e8b-9c2d-7e5f4a3b2c1d/comments \
  -H "Authorization: Bearer $AURAY_API_KEY" \
  -H "content-type: application/json" \
  -d '{
  "body": "The light on the water is beautiful."
}'

#Responses

#201 Created

Created.

FieldTypeRequiredDefaultDescription
objectstringyes—One of "comment".
publication_idstringyes—
idstringyes—
bodystringyes—
authorobject or nullyes—
created_atstringyes—
repliesintegeryes—
minebooleanyes—Written by the reader.
can_deletebooleanyes—The reader may delete it: its author, or the author of the work it is on.
parent_idstringno—The comment it replies to, on a comment just written. 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

#422 Unprocessable Content

#428 Precondition Required

#429 Too Many Requests

#503 Service Unavailable

#Status codes

StatusMeaning
201Created.
400Bad Request
401Unauthorized
403Forbidden
404Not Found
422Unprocessable Content
428Precondition Required
429Too Many Requests
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