Docs

Start here

Check a handle

GET/v1/community/handles/{handle}on https://api.auray.ai/v1

Whether a handle can be claimed, as it would be stored, and if not why: handle_invalid, handle_reserved, handle_taken or handle_held.

Whether a handle can be claimed, as it would be stored, and if not why: handle_invalid, handle_reserved, handle_taken or handle_held. Takes no key; with a key that holds community:write a handle the account holds, or replaced and still holds, reads as available to it. 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 five seconds. A request with a key is answered for itself alone and kept in no shared cache.

#Authentication

No key needed. A key that holds community:write reads the account's own and held handles as available to it.

#Request

#Path parameters

NameTypeRequiredDescription
handlestringyesA profile's handle; one @ before it is read past.

#Example request

curl https://api.auray.ai/v1/community/handles/ada

#Responses

#200 OK

OK.

FieldTypeRequiredDefaultDescription
objectstringyes—One of "handle".
handlestringyes—
availablebooleanyes—
reasonstringyes—One of "handle_invalid", "handle_reserved", "handle_taken", "handle_held", null. 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=5 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

#404 Not Found

#429 Too Many Requests

#503 Service Unavailable

#Status codes

StatusMeaning
200OK.
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