> ## 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.

# List the models available at one provider entry

> Calls the provider's own model listing for ONE entry of the saved
gateway configuration (OpenAI and OpenAI-compatible `/models`, Azure
OpenAI deployments, Anthropic `/v1/models`, Vertex Model Garden
publisher models, Bedrock foundation models and inference profiles).
Credentials stay server-side. Each model keeps the provider's own
fields as-is, plus a standardized `id` (the value to declare in the
entry), `declared` and `registered`. Requires write access to models.




## OpenAPI

````yaml /api-reference/llm-gateway/swagger.yml get /v1/providers/{type}/{index}/models
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/providers/{type}/{index}/models:
    get:
      tags:
        - Models
      summary: List the models available at one provider entry
      description: |
        Calls the provider's own model listing for ONE entry of the saved
        gateway configuration (OpenAI and OpenAI-compatible `/models`, Azure
        OpenAI deployments, Anthropic `/v1/models`, Vertex Model Garden
        publisher models, Bedrock foundation models and inference profiles).
        Credentials stay server-side. Each model keeps the provider's own
        fields as-is, plus a standardized `id` (the value to declare in the
        entry), `declared` and `registered`. Requires write access to models.
      operationId: listProviderModels
      parameters:
        - name: type
          in: path
          required: true
          schema:
            type: string
            enum:
              - openai
              - azure_openai
              - openailike
              - anthropic
              - vertex
              - bedrock
          description: Provider type, a key of the gateway `providers` configuration.
        - name: index
          in: path
          required: true
          schema:
            type: integer
            minimum: 0
          description: >-
            Position of the entry in `providers.<type>`
            (`providers.azure_openai.resources` for Azure); 0 for the
            single-object providers.
      responses:
        '200':
          description: Models available at the provider entry.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProviderModels'
        '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'
        '404':
          description: No such entry in the saved configuration (`PROVIDER_NOT_FOUND`).
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '502':
          description: >-
            The provider refused or failed the listing (credentials,
            permissions, unsupported endpoint).
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
components:
  schemas:
    ProviderModels:
      type: object
      properties:
        provider:
          type: string
        index:
          type: integer
        entry:
          type: object
          description: Non-secret identity of the entry, to check it is the expected one.
          properties:
            endpoint:
              type: string
              nullable: true
            resource:
              type: string
              nullable: true
            region:
              type: string
              nullable: true
            host:
              type: string
              nullable: true
            carbon_region:
              type: string
              nullable: true
        total:
          type: integer
        models:
          type: array
          items:
            type: object
            additionalProperties: true
            required:
              - id
            properties:
              id:
                type: string
                description: >-
                  Value to declare in the entry's model list (Azure deployment
                  name, Bedrock model or inference profile id, Vertex resource
                  path…).
              declared:
                type: boolean
                description: >-
                  Already listed in the entry, directly or through a
                  `model_aliases` alias.
              declared_as:
                type: string
                nullable: true
                description: >-
                  The public id the entry declares for this model (the id
                  itself, or its alias).
              registered:
                type: boolean
                description: Already registered in the models collection.
    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 <token>`.
        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.