Docs

Start here

Search the Community

GET/v1/community/searchon https://api.auray.ai/v1

Works in the public feeds whose title, description, model or shown prompt holds every word of q as a prefix, best match first — or, with scope=creators, public profiles whose handle starts with q o…

Works in the public feeds whose title, description, model or shown prompt holds every word of q as a prefix, best match first — or, with scope=creators, public profiles whose handle starts with q or whose name holds it, most followed first. 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. While our team has paused the feeds, search answers 503 feeds_paused as well.

#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

#Query parameters

NameTypeRequiredDescription
qstringyesOne to 100 characters, with a letter or a digit. 0 to 100 characters.
scopestringnoOne of "works", "creators".
kindstringnoOnly works of this kind. One of "image", "video", "audio", "model3d", "project".
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/search?q=lighthouse"

#Responses

#200 OK

OK. data holds cards for works, profile rows for creators.

FieldTypeRequiredDefaultDescription
objectstringyes—One of "list".
scopestringno—One of "works", "creators".
dataobject or object[]yes—
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

#429 Too Many Requests

#503 Service Unavailable

#Status codes

StatusMeaning
200OK. data holds cards for works, profile rows for creators.
400Bad Request
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