> ## Documentation Index > Fetch the complete documentation index at: https://docs.prisme.ai/llms.txt > Use this file to discover all available pages before exploring further. # Align the environment's models with the catalogue > Back-fills `catalog_id` by name once, then applies the catalogue to the linked models: recommended metrics, `end_of_life`, the forced tool_choice refusal, `exclude_params` / `rename_params` (filled only when empty, else reported as `divergent`), `limits.max_response_tokens`. On every model (field `region`), clears a stored carbon region that changes nothing to the footprint — equal to what the provider entry gives (or the default when it gives none), or unknown — so it follows the provider again; a region that differs is an override and is kept. `limits.response_tokens` is never synced. Dry-run by default. Requires write access to models. ## OpenAPI ````yaml /api-reference/llm-gateway/swagger.yml post /v1/models/catalog/sync openapi: 3.0.3 info: version: 1.0.0 title: LLM Gateway API description: | Public REST API for the Prisme.ai LLM Gateway - OpenAI-compatible chat completions, embeddings and image generation/editing, a standard rerank endpoint, a managed model catalogue with governance overrides per organization, and quota status for users and organizations. The gateway abstracts multi-provider LLM access (OpenAI, Azure OpenAI, Anthropic, Google Vertex, AWS Bedrock, OpenAI-compatible providers) behind an OpenAI-compatible request/response shape. It enforces per-tenant governance (allowed models, default models, quotas) and emits analytics events (`analytics.llm.completion`) usable for cost and carbon reporting. This spec documents only the public REST surface (endpoints exposed via Prisme.ai workspace webhooks). Internal helpers (private automations prefixed with `_`) and load-test mocks are not part of the public contract. contact: name: Prisme.ai url: https://prisme.ai servers: - url: https://{host}/v2/workspaces/slug:llm-gateway/webhooks description: Prisme.ai workspace webhooks variables: host: default: api.studio.prisme.ai description: API host (override for self-hosted or sandbox) security: - BearerAuth: [] - OrgApiKeyAuth: [] tags: - name: Completions description: OpenAI-compatible chat completions (with optional SSE streaming). - name: Embeddings description: OpenAI-compatible text embeddings. - name: Rerank description: >- Rerank documents by relevance to a query (standard rerank contract, LLM-as-reranker backend). - name: Images description: OpenAI-compatible image generation and image editing. - name: Models description: Model catalogue (CRUD + bulk replace + governance-aware listing). - name: Audio description: OpenAI-compatible speech-to-text (audio transcriptions). - name: Quotas description: >- Effective LLM quota limits and current usage, per user and per organization. - name: Defaults description: >- Resolved default models for completions / embeddings / image generation / transcription / file parsing. - name: Test description: Smoke-test reachability of a model through the gateway. paths: /v1/models/catalog/sync: post: tags: - Models summary: Align the environment's models with the catalogue description: > Back-fills `catalog_id` by name once, then applies the catalogue to the linked models: recommended metrics, `end_of_life`, the forced tool_choice refusal, `exclude_params` / `rename_params` (filled only when empty, else reported as `divergent`), `limits.max_response_tokens`. On every model (field `region`), clears a stored carbon region that changes nothing to the footprint — equal to what the provider entry gives (or the default when it gives none), or unknown — so it follows the provider again; a region that differs is an override and is kept. `limits.response_tokens` is never synced. Dry-run by default. Requires write access to models. operationId: syncModelCatalog requestBody: required: false content: application/json: schema: type: object properties: dry_run: type: boolean default: true model_ids: type: array items: type: string fields: type: array items: type: string responses: '200': description: What was (or would be) changed. content: application/json: schema: type: object additionalProperties: true properties: dry_run: type: boolean fields: type: array items: type: string summary: type: object additionalProperties: true backfilled: type: array items: type: object additionalProperties: true patched: type: array items: type: object additionalProperties: true unmatched: type: array items: type: object additionalProperties: true divergent: type: array items: type: object additionalProperties: true '401': description: Missing or invalid authentication. content: application/json: schema: $ref: '#/components/schemas/Error' '403': description: Write access to models required. content: application/json: schema: $ref: '#/components/schemas/Error' components: schemas: Error: type: object required: - error description: | Standard error envelope. `error` carries either a stable PascalCase identifier or a free-text label (legacy endpoints) - `code` is the canonical machine-readable identifier going forward. properties: error: type: string description: Stable PascalCase identifier or short error label. message: type: string description: Human-readable error message. code: type: string description: | Machine-readable error code. Observed values include `RATE_LIMITED`, `MODEL_NOT_ALLOWED`, `HEADER_POLICY_VIOLATION`, `MODEL_NOT_FOUND`, `MODEL_EXISTS`, `MISSING_MODEL_ID`, `MISSING_TYPE`, `INVALID_BODY`, `BULK_REPLACE_FAILED`, `INVALID_ITEMS`, `INVALID_DIMENSIONS`, `PAYLOAD_TOO_LARGE`, `METHOD_NOT_ALLOWED`, `PROVIDER_ERROR`, `PROVIDER_NO_RESPONSE`. details: description: Optional structured context (e.g. list of invalid items). additionalProperties: true status: type: integer description: HTTP status mirror, when present. retryAfter: type: integer description: Seconds to wait before retrying (rate-limit responses). provider: type: string description: Upstream provider name (provider-error responses). model: type: string description: Model id involved in the error (provider-error responses). provider_error_type: type: string description: Upstream provider's own error class name. securitySchemes: BearerAuth: type: http scheme: bearer bearerFormat: JWT description: | User-bound credential carrying an identity: either a session JWT or a user access token (`at:*`) generated from the user settings UI. Send as `Authorization: Bearer `. Org API keys (`iak_*`) are **not** accepted here - they carry no user identity. Use the `x-prismeai-api-key` header instead (see `OrgApiKeyAuth`). OrgApiKeyAuth: type: apiKey in: header name: x-prismeai-api-key description: | Organization API key (`iak_{orgSlug}_{uuid}`). Unlike `Authorization: Bearer`, this credential is **not** tied to a user identity - it is bound to the org and its effective access is defined by the scopes / permission rules attached to it (it can be restricted to a single project, or kept broader). Send as `x-prismeai-api-key: iak_...`. ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.