latestOpenAPI 3.1.0raw.githubusercontent.com2026-08-183907302.1 MB

658ffb748f95

AI Gateway Models

Update an AI Gateway Model

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

Updates the configuration of an existing AI Gateway model.

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

Request body

OR

Example request

{
  "display_name": "My GPT 5 model",
  "name": "my-entity-name",
  "enabled": true,
  "access": {
    "identity_providers": [
      "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"
      }
    }
  }
}

Response

Model updated successfully.

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"
    ]
  },
  "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"
      }
    }
  }
}