Docs

Start here

The machine contract for one model address

GET/v1/models/{id}/{document}on https://api.auray.ai/v1

ONE DOCUMENT PER ADDRESS, because a single spec cannot describe 625 addresses: OpenAPI has no path parameter that may contain slashes, so the /{model} template this spec used to carry stood for eve…

ONE DOCUMENT PER ADDRESS, because a single spec cannot describe 625 addresses: OpenAPI has no path parameter that may contain slashes, so the /{model} template this spec used to carry stood for every address and generated a usable client for none. document picks the form: openapi.json is a complete 3.1.0 document for that one address — four queue paths, the model's own input schema nested the way the body is read, the scope a key needs as info.x-auray-scope, the price rule in credits as info.x-auray-price (a catalogue model's bands under its rule, and metered, true where the price is a hold: the job is charged what it cost, never above the quote) — and llms.txt is the same contract written for a reader that pays by the token: fields, response keys, price, paths and one request to paste.

NO KEY IS NEEDED. A contract you need a key to read is a contract nobody can generate a client from. A key that is sent is still checked, so a revoked or throttled key is told so here as everywhere else. id is the address (auray-ai/krea-2-turbo/text-to-image) or, as one segment, the catalogue slug (hitem3d-hi3d-split). The index of every address is at https://api.auray.ai/llms.txt.

#Authentication

No key needed — this document is public.

#Request

#Path parameters

NameTypeRequiredDescription
idstringyesThe model address, slashes and all.
documentstringyesWhich form of the contract to return. One of "openapi.json", "llms.txt".

#Example request

curl https://api.auray.ai/v1/models/auray-ai/krea-2-turbo/text-to-image/openapi.json

#Responses

#200 OK

The contract for that address.

#404 Not Found

No such model address.

#Status codes

StatusMeaning
200The contract for that address.
404No such model address.

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