Sign in
AI Gateway Models

Get an AI Gateway Model

Pre-release Endpoint This endpoint is currently in beta and is subject to change.

Returns the details of a specific AI Gateway model.

get/v1/ai-gateways/{gatewayId}/models/{modelIdOrName}

Response

A successful response returning the AI Gateway Model.

OR

Example response

{
  "id": "5f9fd312-a987-4628-b4c5-bb4f4fddd5f7",
  "created_at": "2022-11-04T20:10:06.927Z",
  "updated_at": "2022-11-04T20:10:06.927Z",
  "display_name": "My GPT 5 model",
  "name": "my-entity-name",
  "enabled": true,
  "access": {
    "identity_providers": [
      "okta-ai-se"
    ],
    "auth_strategies": [
      "okta-ai-se"
    ]
  },
  "formats": [
    {
      "type": "openai"
    }
  ],
  "targets": [
    {
      "name": "gpt-5-model",
      "weight": 100,
      "provider": "azure-ai-se"
    }
  ],
  "labels": {
    "category": "finance"
  },
  "managed_by": {
    "owner": "terraform"
  },
  "config": {
    "route": {
      "headers": {
        "version": [
          "v1",
          "v2"
        ]
      },
      "hosts": [
        "foo.example.com"
      ],
      "model": {
        "body_param": "model",
        "header_param": "x-model",
        "path_param": "model_name"
      }
    },
    "balancer": {
      "embeddings": {
        "provider": "azure-ai-se"
      }
    }
  }
}

Changes

Changed in 2 of the 30 revisions of this API.17

  • cef0f947e9c916See 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

    • ○

      response property oneOf[AIGatewayModelAPI]/access/identity_providers deprecated

      response-property-deprecated

    • ○

      response property oneOf[AIGatewayModelAPI]/access/identity_providers/items/ deprecated

      response-property-deprecated

    • ○

      response property oneOf[AIGatewayModelModel]/access/identity_providers deprecated

      response-property-deprecated

    • ○

      response property oneOf[AIGatewayModelModel]/access/identity_providers/items/ deprecated

      response-property-deprecated

    • ○

      removed vertex discriminator mapping keys from the /////////// response property for the response status

      response-property-discriminator-mapping-deleted

    • ○

      removed vertex discriminator mapping keys from the ////// response property for the response status

      response-property-discriminator-mapping-deleted

    • ○

      removed vertex discriminator mapping keys from the /////////// response property for the response status

      response-property-discriminator-mapping-deleted

    • ○

      removed vertex discriminator mapping keys from the ////// response property for the response status

      response-property-discriminator-mapping-deleted

    • ○

      removed the vertex enum value from the ////// response property for the response status

      response-property-enum-value-removed

    • ○

      removed the vertex enum value from the ////// response property for the response status

      response-property-enum-value-removed

    • ○

      removed from the ////// response property oneOf list for the response status

      response-property-one-of-removed

    • ○

      removed from the ////// response property oneOf list for the response status

      response-property-one-of-removed

    • ○

      removed from the /////////// response property oneOf list for the response status

      response-property-one-of-removed

    • ○

      removed from the /////////// response property oneOf list for the response status

      response-property-one-of-removed

    This revision also has 9 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • 658ffb748f951See the full diff
    • ○

      endpoint added

      endpoint-added

    This revision also has 3 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog