Model Catalog API
Overview
Model Catalog entries describe the individual LLM models available to the AI Gateway. Each entry carries provider linkage, context/output limits, per-million-token (and per-image / per-audio-minute / per-character) pricing, capability tags, modality and deprecation metadata. The catalog powers model selection, cost accounting and UI listing.
Endpoints follow the standard AI Gateway APIops conventions:
- Name-based references. The catalog entry is addressed by its
name(LiteLLM-style{providerCode}/{modelId}, e.g.openai/gpt-5). Runtime IDs are never required in the path. - Upsert —
POST /{modelName}/creates the entry, or updates it in place if the name already exists. - No secret fields — the catalog holds pricing/capability metadata only. It is not a
ConnectionConfigsubtype, so responses carry no_classdiscriminator and there is nothing to mask. All fields are returned in plaintext. - Built-in models are seed-managed — entries with
builtIn=trueship with Apinizer. They cannot be deleted, and create/update only applies the price fields (all other fields are preserved from the seed). Custom models (builtIn=false) are fully editable within the owning project.
Endpoints
- List Model Catalog Entries - List all model catalog entries in a project
- Get Model Catalog Entry - Get a single model catalog entry by name
- Create Model Catalog Entry - Create or upsert a model catalog entry
- Update Model Catalog Entry - Update an existing model catalog entry
- Delete Model Catalog Entry - Delete a custom model catalog entry
Base path: /apiops/projects/{projectName}/llm-models
| Method | Path | Description |
|---|---|---|
| GET | /apiops/projects/{projectName}/llm-models/ | List model catalog entries |
| GET | /apiops/projects/{projectName}/llm-models/{modelName}/ | Get a model catalog entry |
| POST | /apiops/projects/{projectName}/llm-models/{modelName}/ | Create / upsert a model catalog entry |
| PUT | /apiops/projects/{projectName}/llm-models/{modelName}/ | Update a model catalog entry |
| DELETE | /apiops/projects/{projectName}/llm-models/{modelName}/ | Delete a model catalog entry |
Authentication
All endpoints require authentication using a Personal API Access Token
(Authorization: Bearer {token}). JHipster JWTs do not work on APIops.
Permissions
- Reads (
GET) requireAI_DEVELOPMENTwith the VIEW action in the project. - Writes (
POST/PUT/DELETE) requireAI_DEVELOPMENTwith the MANAGE action in the project.
Related Documentation
- AI Gateway API - Overview of every AI Gateway APIops resource
- Authentication Guide - How to obtain and use API tokens
- Error Handling - Error response formats