Vapi · Schema

CreateAzureOpenAICredentialDTO

AIVoiceAgentsRealtimeCPaaS

Properties

Name Type Description
provider string
region string
models array
openAIKey string This is not returned in the API.
ocpApimSubscriptionKey string This is not returned in the API.
openAIEndpoint string
name string This is the name of credential. This is just for your reference.
View JSON Schema on GitHub

JSON Schema

vapi-createazureopenaicredentialdto-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/CreateAzureOpenAICredentialDTO",
  "title": "CreateAzureOpenAICredentialDTO",
  "type": "object",
  "properties": {
    "provider": {
      "type": "string",
      "enum": [
        "azure-openai"
      ]
    },
    "region": {
      "type": "string",
      "enum": [
        "australiaeast",
        "canadaeast",
        "canadacentral",
        "centralus",
        "eastus2",
        "eastus",
        "france",
        "germanywestcentral",
        "india",
        "japaneast",
        "japanwest",
        "northcentralus",
        "norway",
        "polandcentral",
        "southcentralus",
        "spaincentral",
        "swedencentral",
        "switzerland",
        "uaenorth",
        "uk",
        "westeurope",
        "westus",
        "westus3"
      ]
    },
    "models": {
      "type": "array",
      "enum": [
        "gpt-5.4",
        "gpt-5.4-mini",
        "gpt-5.4-nano",
        "gpt-5.2",
        "gpt-5.2-chat",
        "gpt-5.1",
        "gpt-5.1-chat",
        "gpt-5",
        "gpt-5-mini",
        "gpt-5-nano",
        "gpt-4.1-2025-04-14",
        "gpt-4.1-mini-2025-04-14",
        "gpt-4.1-nano-2025-04-14",
        "gpt-4o-2024-11-20",
        "gpt-4o-2024-08-06",
        "gpt-4o-2024-05-13",
        "gpt-4o-mini-2024-07-18",
        "gpt-4-turbo-2024-04-09",
        "gpt-4-0125-preview",
        "gpt-4-1106-preview",
        "gpt-4-0613",
        "gpt-35-turbo-0125",
        "gpt-35-turbo-1106"
      ],
      "example": [
        "gpt-4-0125-preview",
        "gpt-4-0613"
      ],
      "items": {
        "type": "string",
        "enum": [
          "gpt-5.4",
          "gpt-5.4-mini",
          "gpt-5.4-nano",
          "gpt-5.2",
          "gpt-5.2-chat",
          "gpt-5.1",
          "gpt-5.1-chat",
          "gpt-5",
          "gpt-5-mini",
          "gpt-5-nano",
          "gpt-4.1-2025-04-14",
          "gpt-4.1-mini-2025-04-14",
          "gpt-4.1-nano-2025-04-14",
          "gpt-4o-2024-11-20",
          "gpt-4o-2024-08-06",
          "gpt-4o-2024-05-13",
          "gpt-4o-mini-2024-07-18",
          "gpt-4-turbo-2024-04-09",
          "gpt-4-0125-preview",
          "gpt-4-1106-preview",
          "gpt-4-0613",
          "gpt-35-turbo-0125",
          "gpt-35-turbo-1106"
        ]
      }
    },
    "openAIKey": {
      "type": "string",
      "maxLength": 10000,
      "description": "This is not returned in the API."
    },
    "ocpApimSubscriptionKey": {
      "type": "string",
      "description": "This is not returned in the API."
    },
    "openAIEndpoint": {
      "type": "string",
      "maxLength": 10000
    },
    "name": {
      "type": "string",
      "description": "This is the name of credential. This is just for your reference.",
      "minLength": 1,
      "maxLength": 40
    }
  },
  "required": [
    "provider",
    "region",
    "models",
    "openAIKey",
    "openAIEndpoint"
  ]
}