Sign in
Models

List models filtered by user provider preferences, privacy settings, and guardrails

List models filtered by user provider preferences, privacy settings, and guardrails. Returns text-output models by default; pass output_modalities (a comma-separated list of text, image, embeddings, audio, video, rerank, speech, transcription, or all) to include other modalities. If requesting through a regional hostname, the results will be filtered to models that satisfy in-region routing for that region.

get/models/user

Query parameters

offsetinteger nullable

Number of records to skip for pagination. When both offset and limit are omitted, the full list is returned

Number of records to skip for pagination. When both offset and limit are omitted, the full list is returned

limitinteger

Maximum number of records to return (max 1000). When both offset and limit are omitted, the full list is returned

Example:500

Maximum number of records to return (max 1000). When both offset and limit are omitted, the full list is returned

output_modalitiesstring

Filter models by output modality. Accepts a comma-separated list of modalities (text, image, embeddings, audio, video, rerank, decisions, speech, transcription) or "all" to include all models. Defaults to "text".

Example:text

Filter models by output modality. Accepts a comma-separated list of modalities (text, image, embeddings, audio, video, rerank, decisions, speech, transcription) or "all" to include all models. Defaults to "text".

Response

Returns a list of models filtered by user provider preferences

dataModel[] required— unresolved $ref

List of available models

total_countinteger required

Total number of models matching the query

Example response

{
  "data": [
    {
      "architecture": {
        "input_modalities": [
          "text"
        ],
        "instruct_type": "chatml",
        "modality": "text->text",
        "output_modalities": [
          "text"
        ],
        "tokenizer": "GPT"
      },
      "canonical_slug": "openai/gpt-4",
      "context_length": 8192,
      "created": 1692901234,
      "default_parameters": null,
      "description": "GPT-4 is a large multimodal model that can solve difficult problems with greater accuracy.",
      "expiration_date": null,
      "id": "openai/gpt-4",
      "knowledge_cutoff": null,
      "links": {
        "details": "/api/v1/models/openai/gpt-4/endpoints"
      },
      "name": "GPT-4",
      "per_request_limits": null,
      "pricing": {
        "completion": "0.00006",
        "image": "0",
        "prompt": "0.00003",
        "request": "0"
      },
      "supported_parameters": [
        "temperature",
        "top_p",
        "max_tokens",
        "frequency_penalty",
        "presence_penalty"
      ],
      "supported_voices": null,
      "top_provider": {
        "context_length": 8192,
        "is_moderated": true,
        "max_completion_tokens": 4096
      }
    }
  ],
  "links": {
    "next": "/api/v1/models?offset=500&limit=500"
  },
  "total_count": 150
}

Changes

Changed in 13 of the 303 revisions of this API.13426

  • 2de027b6dfcd1See the full diff
    • ●

      added the new decisions enum value to the //// response property for the response status

      response-property-enum-value-added

  • f2a6470d6ada1See the full diff
    • ○

      added the new optional query request parameter output_modalities

      new-optional-request-parameter

  • ad4e1cd6fc961See the full diff
    • ○

      added the optional property ///// to the response with the status

      response-optional-property-added

  • c506a198e46b1See the full diff
    • ○

      added the optional property // to the response with the status

      response-optional-property-added

  • 7da991e5a3631See the full diff
    • ○

      added the non-success response with the status

      response-non-success-status-added

  • becc202733451See the full diff
    • ●

      added the new prediction enum value to the /// response property for the response status

      response-property-enum-value-added

  • e25e67040f6d2See the full diff
    • ○

      added the optional property ///// to the response with the status

      response-optional-property-added

    • ○

      added the optional property ///// to the response with the status

      response-optional-property-added

  • b0e196d046d61See the full diff
    • ○

      added the optional property /// to the response with the status

      response-optional-property-added

  • 9814733ca74d4See the full diff
    • ○

      added the new optional query request parameter limit

      new-optional-request-parameter

    • ○

      added the new optional query request parameter offset

      new-optional-request-parameter

    • ○

      added the required property to the response with the status

      response-required-property-added

    • ○

      added the required property to the response with the status

      response-required-property-added

  • b5288729c4661See the full diff
    • ○

      added the optional property /// to the response with the status

      response-optional-property-added