> ## 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. # Get a model by ID ## OpenAPI ````yaml /api-reference/llm-gateway/swagger.yml get /v1/models/{modelId} 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 and embeddings, plus a managed model catalogue with governance overrides per organization. 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: Models description: Model catalogue (CRUD + bulk replace + governance-aware listing). - name: Defaults description: >- Resolved default models for completions / embeddings / image generation / file parsing. - name: Test description: Smoke-test reachability of a model through the gateway. paths: /v1/models/{modelId}: parameters: - in: path name: modelId required: true schema: type: string description: | Identifier of the model document. Model IDs may contain forward slashes (e.g. `bedrock/anthropic.claude-3-haiku`, `eu.anthropic.claude-sonnet-4-20250514-v1:0`); the workspace router declares this parameter as a catch-all so consumers SHOULD send the slashes unencoded in the path. get: tags: - Models summary: Get a model by ID operationId: getModel responses: '200': description: Model document. content: application/json: schema: $ref: '#/components/schemas/Model' '401': description: Missing or invalid authentication. content: application/json: schema: $ref: '#/components/schemas/Error' '404': description: 'Model not found (`code: MODEL_NOT_FOUND`).' content: application/json: schema: $ref: '#/components/schemas/Error' '405': description: Method not allowed. content: application/json: schema: $ref: '#/components/schemas/Error' components: schemas: Model: type: object description: | Model catalogue document. The catalogue is the source of truth for provider routing, capabilities, pricing, and per-org availability. required: - model_id - type properties: model_id: type: string maxLength: 128 description: Stable identifier (matches the value sent in `request.model`). type: type: string maxLength: 64 enum: - completion - embeddings - image_generation description: Model family. display: type: object description: Display metadata (label, brand, hidden flag). properties: name: type: string brand: type: string hidden: type: boolean capabilities: type: object description: Flags advertising what the model supports. properties: vision: type: boolean audio: type: boolean text: type: boolean image: type: boolean limits: type: object description: Provider-side limits (e.g. context window, max tokens). additionalProperties: true failover: type: string maxLength: 128 description: Optional `model_id` to route to when the primary fails. region: type: string maxLength: 64 description: Hosting region (free-text). dimensions: description: Default embedding dimensionality (embeddings models only). supported_dimensions: type: array description: Allowed values for the request `dimensions` parameter. items: type: number metrics: description: Free-form metrics block (latency, throughput hints, …). provider_config: type: object description: Provider-specific configuration (batch size, parallelism, …). additionalProperties: true pricing: type: object description: Cost configuration used to compute `usage.cost`. properties: input_per_1m_tokens: type: number format: double output_per_1m_tokens: type: number format: double tags: type: array description: Free-form tags used by the search/filter UI. items: type: string org_slugs: type: array description: | When set and non-empty, restricts the model to the listed organizations. Empty / missing means the model is available to all orgs (subject to governance overlays). items: type: string enabled: type: boolean description: When `false`, the model is hidden from routing. 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`, `MODEL_NOT_FOUND`, `MODEL_EXISTS`, `MISSING_MODEL_ID`, `MISSING_TYPE`, `INVALID_BODY`, `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_...`. ````