---
# @generated by sylphx-gen 0.1.0 from contracts@e145cc7cf1bc9605f2b27439e5e17ed76a1a2fd7e7021906a013f7565e4a0cd5. Do not edit.
title: "AI models"
description: "The `ai_models` collection of Sylphx AI: An AI Model is one admitted entry of the Sylphx AI catalog: a model id a caller may name on the inference surface, with its sell prices, limits, and data policy."
type: reference
product: ai
summary: "An AI Model is one admitted entry of the Sylphx AI catalog: a model id a caller may name on the inference surface, with its sell prices,…"
updated: 2026-09-28
order: 900
---

An AI Model is one admitted entry of the Sylphx AI catalog: a model id a caller may name on the inference surface, with its sell prices, limits, and data policy. Only admitted models list (AI-CATALOG-ADMISSION); no capability, contract, connector, or upstream price appears on an entry (AI-CATALOG-NO-LEAK). The id is the canonical model id with `/` and `.` written as `-`, for example `anthropic-claude-opus-5`; `model` carries the canonical id itself.

**Service** Sylphx AI · **Resource type** `ai.sylphx.com/AiModel` · **Name pattern** `ai_models/{ai_model}` · **Shape** `record`

## Fields

| Field | Type | What it is |
| --- | --- | --- |
| `name` | `string` | `ai_models/{ai_model}`. |
| `uid` | `string` | `aim_<cell><ulid>`; never reused. Output only. |
| `meta` | `ResourceMeta` | Resource metadata. |
| `model` | `string` | The canonical model id, `brand/model`, for example `anthropic/claude-opus-5`. Output only. |
| `brand` | `string` | The brand, for example `anthropic`. Output only. |
| `aliases` | `string[]` | Bare spellings that resolve to this model when unique, for example `claude-opus-5`. Output only. |
| `modality` | `ModelModality` | What the model produces. Output only. One of `chat`, `embedding`, `image`, `speech`, `transcription`, `video`, `decision`. |
| `input_modalities` | `InputModality[]` | Accepted input modalities, for example text and image. Output only. One of `text`, `image`, `audio`, `file`, `video`. |
| `api_surfaces` | `ApiSurface[]` | Inference encodings the model answers on. Output only. One of `responses`, `messages`, `chat_completions`, `embeddings`, `images`, `speech`, `transcription`. |
| `context_window_tokens` | `int64` | Context window in tokens. Output only. |
| `max_output_tokens` | `int64` | Most output tokens per response. Output only. |
| `release_time` | `timestamp` | The upstream release date. Output only. |
| `preview` | `bool` | Whether the model is a preview. Output only. |
| `prices` | `ModelPrice[]` | Sell prices per meter and class; the only prices on an entry. Output only. |
| `price_identity` | `string` | The price identity usage events carry, for example `spv3-...`. Output only. |
| `data_policy` | `DataPolicy` | How request and response data are retained and used. Output only. |
| `caching` | `ModelCaching` | How long a prompt-cache prefix stays warm on this model, and the longest retention a request may ask for; unset when no serving lane declares it. Output only. |

## Methods

Every method of the collection, in the registry's order, with the scope it
needs. The full request, response and examples are one link away.

| Method | Call | What it does |
| --- | --- | --- |
| `GET` | [`get`](/docs/api/ai_models#get) | Gets an AI model. |
| `GET` | [`list`](/docs/api/ai_models#list) | Lists the admitted catalog; filter by `brand`, `modality`, or `model`. |

## get

Gets an AI model.

`GET https://api.sylphx.com/v1/ai_models/ai-model` · scope `ai:read` · effect `read` · callable with a publishable key · [Request, response and examples](/docs/api/ai_models/get)

## list

Lists the admitted catalog; filter by `brand`, `modality`, or `model`.

`GET https://api.sylphx.com/v1/ai_models` · scope `ai:read` · effect `read` · callable with a publishable key · paginated · [Request, response and examples](/docs/api/ai_models/list)
