Docs

Start here

Ask for a proof-of-work challenge

POST/v1/support/challengeon https://api.auray.ai/v1

Filing a request costs the sender something, and this is where that cost is set.

Filing a request costs the sender something, and this is where that cost is set. Find a nonce such that sha256("<salt>.<nonce>") begins with bits zero bits, then send the challenge string back unchanged alongside your nonce. One challenge is one submission — a support request or a sign-in link. An anonymous Community report asks POST /v1/community/reports/challenge for its own, which answers while support is closed; the two are the same puzzle, and either is spent once. A POST rather than a GET because a cached challenge is one salt handed to everybody, which is the same as no challenge at all.

#Authentication

No key needed — this document is public.

#Example request

curl -X POST https://api.auray.ai/v1/support/challenge

#Responses

#200 OK

OK

FieldTypeRequiredDefaultDescription
challengestringno—Signed. Send it back byte for byte; any change is refused by one comparison.
saltstringno—A convenience copy of the field inside challenge; the server reads the signed one.
bitsintegerno—Leading zero bits required. Raised during an incident, so read it rather than assuming.
expires_inintegerno—Seconds.
algorithmstringno—One of "sha256-leading-zero-bits".

Headers:

HeaderDescription
RateLimit-LimitBurst capacity for the bucket that answered.
RateLimit-Remaining
RateLimit-ResetSeconds until refill.
X-Request-Id

#429 Too Many Requests

support_rate_limited — too many challenges from this address.

The error body: error, message, docs (the entry that explains it) and request_id.

#503 Service Unavailable

support_disabled or support_not_configured.

The error body: error, message, docs (the entry that explains it) and request_id.

#Status codes

StatusMeaning
200OK
429support_rate_limited — too many challenges from this address.
503support_disabled or support_not_configured.

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