Vapi · Schema

UpdateAzureCredentialDTO

AIVoiceAgentsRealtimeCPaaS

Properties

Name Type Description
service string This is the service being used in Azure.
region string This is the region of the Azure resource.
apiKey string This is not returned in the API.
fallbackIndex number This is the order in which this storage provider is tried during upload retries. Lower numbers are tried first in increasing order.
name string This is the name of credential. This is just for your reference.
bucketPlan object This is the bucket plan that can be provided to store call artifacts in Azure Blob Storage.
View JSON Schema on GitHub

JSON Schema

vapi-updateazurecredentialdto-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/UpdateAzureCredentialDTO",
  "title": "UpdateAzureCredentialDTO",
  "type": "object",
  "properties": {
    "service": {
      "type": "string",
      "description": "This is the service being used in Azure.",
      "enum": [
        "speech",
        "blob_storage"
      ],
      "default": "speech"
    },
    "region": {
      "type": "string",
      "description": "This is the region of the Azure resource.",
      "enum": [
        "australiaeast",
        "canadaeast",
        "canadacentral",
        "centralus",
        "eastus2",
        "eastus",
        "france",
        "germanywestcentral",
        "india",
        "japaneast",
        "japanwest",
        "northcentralus",
        "norway",
        "polandcentral",
        "southcentralus",
        "spaincentral",
        "swedencentral",
        "switzerland",
        "uaenorth",
        "uk",
        "westeurope",
        "westus",
        "westus3"
      ]
    },
    "apiKey": {
      "type": "string",
      "description": "This is not returned in the API.",
      "maxLength": 10000
    },
    "fallbackIndex": {
      "type": "number",
      "minimum": 1,
      "description": "This is the order in which this storage provider is tried during upload retries. Lower numbers are tried first in increasing order."
    },
    "name": {
      "type": "string",
      "description": "This is the name of credential. This is just for your reference.",
      "minLength": 1,
      "maxLength": 40
    },
    "bucketPlan": {
      "description": "This is the bucket plan that can be provided to store call artifacts in Azure Blob Storage.",
      "allOf": [
        {
          "$ref": "#/components/schemas/AzureBlobStorageBucketPlan"
        }
      ]
    }
  }
}