Docs

Start here

Read a work's comments

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

A page of a work's comments, newest first — or with parent, one comment's replies, oldest first.

A page of a work's comments, newest first — or with parent, one comment's replies, oldest first. Comments go one level deep. Takes no key. A key that holds community:write reads as its account — its likes and follows filled in — and any other key reads what a stranger reads; either way a request with a key is answered for itself alone and kept in no shared cache. An answer without a key is the same for every reader, its request_id included — which names the request that filled the edge's copy — and carries no RateLimit-* headers, since they would describe that request's sender. Cached at the edge for thirty seconds with two minutes of stale service.

#Authentication

No key needed. A key that holds community:write is read as its account — its likes and follows filled in — and is answered private, no-store. Paced per address, and cached at the edge for thirty seconds.

#Request

#Path parameters

NameTypeRequiredDescription
idstringyes

#Query parameters

NameTypeRequiredDescription
parentstringnoA comment's id: read its replies.
cursorstringnoThe next_cursor the previous page answered, unchanged, with the same filters. None for the first page. 0 to 200 characters.
limitintegernoHow many on a page. 1 to 60.

#Example request

curl https://api.auray.ai/v1/community/publications/3f0c8a52-6a1d-4e8b-9c2d-7e5f4a3b2c1d/comments

#Responses

#200 OK

OK.

FieldTypeRequiredDefaultDescription
objectstringyes—One of "list".
dataobject[]yes—
data[].idstringyes—
data[].bodystringyes—
data[].authorobject or nullyes—
data[].created_atstringyes—
data[].repliesintegeryes—
data[].minebooleanyes—Written by the reader.
data[].can_deletebooleanyes—The reader may delete it: its author, or the author of the work it is on.
data[].parent_idstringno—The comment it replies to, on a comment just written. May be null.
next_cursorstringyes—The cursor of the next page; null on the last. May be null.
request_idstringno—Mirrored in the X-Request-Id header. On an answer without a key it names the request that filled the edge's copy, so readers served from that copy are handed the same one.

Headers:

HeaderDescription
Cache-Controlpublic, s-maxage=30, stale-while-revalidate=120 with no key; private, no-store with one.
VaryAuthorization.
RateLimit-LimitBurst capacity, per key, on an answer to a key. An answer without one is cached at the edge and carries none of the RateLimit-* headers; a refusal without one, which is never cached, carries its address's.
RateLimit-Remaining
RateLimit-ResetSeconds until refill.
X-Request-Id

#400 Bad Request

#404 Not Found

#429 Too Many Requests

#503 Service Unavailable

#Status codes

StatusMeaning
200OK.
400Bad Request
404Not Found
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