Start here
Which models are running
/v1/catalogueon https://api.auray.ai/v1Takes 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/catalogueimport { createClient } from "@auray/client";
const auray = createClient(); // this route needs no key
console.log(await auray.platform.catalogue());from auray_client import Client
auray = Client() # this route needs no key
print(auray.platform.catalogue())const res = await fetch("https://api.auray.ai/v1/catalogue", {
method: "GET",
});
console.log(await res.json());import requests
r = requests.get(
"https://api.auray.ai/v1/catalogue",
)
r.raise_for_status()
print(r.json())package main
import (
"fmt"
"io"
"net/http"
)
func main() {
req, err := http.NewRequest("GET", "https://api.auray.ai/v1/catalogue", nil)
if err != nil {
panic(err)
}
res, err := http.DefaultClient.Do(req)
if err != nil {
panic(err)
}
defer res.Body.Close()
out, _ := io.ReadAll(res.Body)
fmt.Println(res.Status, string(out))
}<?php
$ch = curl_init("https://api.auray.ai/v1/catalogue");
curl_setopt_array($ch, [
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_RETURNTRANSFER => true,
]);
$response = curl_exec($ch);
echo curl_getinfo($ch, CURLINFO_HTTP_CODE), " ", $response, PHP_EOL;require "net/http"
uri = URI("https://api.auray.ai/v1/catalogue")
req = Net::HTTP::Get.new(uri)
res = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) { |http| http.request(req) }
puts res.code, res.bodyimport java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;
public class Main {
public static void main(String[] args) throws Exception {
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("https://api.auray.ai/v1/catalogue"))
.GET()
.build();
HttpResponse<String> response = HttpClient.newHttpClient()
.send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.statusCode() + " " + response.body());
}
}using var client = new HttpClient();
using var request = new HttpRequestMessage(HttpMethod.Get, "https://api.auray.ai/v1/catalogue");
using var response = await client.SendAsync(request);
Console.WriteLine($"{(int)response.StatusCode} {await response.Content.ReadAsStringAsync()}");#Responses
#200 OK
OK. The counts, and when they were answered.
| Field | Type | Required | Default | Description |
|---|---|---|---|---|
object | string | yes | — | One of "catalogue". |
source | string | yes | — | fallback when the catalogue could not be read; connected is then null and the other counts still stand. One of "live", "fallback". |
total | integer | yes | — | Every published address. The same total as GET /models. |
described | integer | yes | — | Addresses with a published request shape. The same described as GET /models. |
connected | integer | yes | — | Addresses that would dispatch now. The same connected as GET /models; null on fallback. May be null. |
chat | integer | yes | — | Chat models, counted separately from the addresses. |
addresses | object | yes | — | 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_models | object | yes | — | 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_of | string | yes | — | When this answer was made. |
request_id | string | yes | — |
Headers:
| Header | Description |
|---|---|
Cache-Control | public, s-maxage=60, stale-while-revalidate=300. |
X-Request-Id |
#Status codes
| Status | Meaning |
|---|---|
200 | OK. The counts, and when they were answered. |
Every refusal names its code, and every code is explained at Errors.