Docs

Start here

Which models are running

GET/v1/catalogueon https://api.auray.ai/v1

Takes no key and charges nothing, for the reason /plans does: the marketing page and the API's own llms.txt index read this before anybody has an account.

Takes no key and charges nothing, for the reason /plans does: the marketing page and the API's own llms.txt index read this before anybody has an account. Three counts over every published address — total, described and connected — classified by the same rule GET /models uses, so its connected equals the listing's to the unit; chat is the number of chat models, reported beside it rather than added in. addresses is every published address with its status under that same rule — connected, described (not open yet: a submit answers 501 model_not_connected), undescribed (404 model_not_described), paused (503) or retired (410) — so a page or an agent can tell what runs from what does not without a key. connected means the address runs now. It is not a claim that the model has been tested. When the catalogue cannot be read this answers 200 with source: "fallback", connected: null and addresses: null rather than an error. Cached at the edge for sixty seconds with five minutes of stale service.

#Authentication

No key needed — this document is public.

#Example request

curl https://api.auray.ai/v1/catalogue

#Responses

#200 OK

OK. The counts, and when they were answered.

FieldTypeRequiredDefaultDescription
objectstringyes—One of "catalogue".
sourcestringyes—fallback when the catalogue could not be read; connected is then null and the other counts still stand. One of "live", "fallback".
totalintegeryes—Every published address. The same total as GET /models.
describedintegeryes—Addresses with a published request shape. The same described as GET /models.
connectedintegeryes—Addresses that would dispatch now. The same connected as GET /models; null on fallback. May be null.
chatintegeryes—Chat models, counted separately from the addresses.
addressesobjectyes—Every published address, keyed as it is typed, with whether it runs: the status GET /models gives it. Null on fallback, never guessed. May be null.
chat_modelsobjectyes—Every listed chat model, keyed by the model a request names, with whether it answers now; chat counts the connected ones. Read on its own, so present on fallback too.
as_ofstringyes—When this answer was made.
request_idstringyes—

Headers:

HeaderDescription
Cache-Controlpublic, s-maxage=60, stale-while-revalidate=300.
X-Request-Id

#Status codes

StatusMeaning
200OK. The counts, and when they were answered.

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