Docs

Start here

Report something

POST/v1/community/reportson https://api.auray.ai/v1

Report a published work, a public profile or a comment — with a key that holds community:write, as your account, ten an hour; or with no key, anonymously, paced per address and network and paying a…

Report a published work, a public profile or a comment — with a key that holds community:write, as your account, ten an hour; or with no key, anonymously, paced per address and network and paying a proof-of-work challenge from POST /v1/community/reports/challenge (send its challenge and your nonce; one challenge is one report). The same report again while it is open is merged into it. A severe report (csam, nonconsensual_likeness) is read first; it hides a work or a comment while our team reviews it once severe reports from enough accounts of some standing have been filed, never on one account's word, and an anonymous report never counts toward that. A report names no account of yours or of the target's.

#Authentication

No key needed: a report with none is anonymous, paced per address and network, and pays a proof-of-work challenge from POST /v1/community/reports/challenge — send its challenge and your nonce in the body. A key that holds community:write reports as its account and solves none.

#Request

#Body

application/json, required.

FieldTypeRequiredDefaultDescription
kindstringyes—One of "publication", "creator", "comment".
idstringyes—A work's or a comment's id, or a profile's handle.
categorystringyes—One of "csam", "nonconsensual_likeness", "violent_extremism", "voice_cloning", "harassment", "copyright", "disinformation", "other".
detailsstringno—0 to 2000 characters. May be null.
challengestringno—With no key: a challenge from POST /v1/community/reports/challenge, unchanged. Ignored with a key.
noncestringno—With no key: a nonce such that sha256("<salt>.<nonce>") begins with the challenge's bits zero bits. Ignored with a key. 0 to 64 characters.

#Example request

curl -X POST https://api.auray.ai/v1/community/reports \
  -H "content-type: application/json" \
  -d '{
  "kind": "publication",
  "id": "3f0c8a52-6a1d-4e8b-9c2d-7e5f4a3b2c1d",
  "category": "copyright",
  "details": "This is my photograph, published without my permission."
}'

#Responses

#201 Created

Received.

FieldTypeRequiredDefaultDescription
objectstringyes—One of "report".
kindstringyes—One of "publication", "creator", "comment".
categorystringyes—One of "csam", "nonconsensual_likeness", "violent_extremism", "voice_cloning", "harassment", "copyright", "disinformation", "other".
receivedbooleanyes—
mergedbooleanyes—Merged into the open report about the same thing.
hiddenbooleanyes—The work or comment is hidden while it is reviewed: the severe reports about it now meet the bar that hides it. False for a report below it, which is read first all the same.
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

#503 Service Unavailable

#Status codes

StatusMeaning
201Received.
400Bad Request
401Unauthorized
403Forbidden
404Not Found
409Conflict
413Payload Too Large
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