Vapi · Schema

AzureCredential

AIVoiceAgentsRealtimeCPaaS

Properties

Name	Type	Description
provider	string
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.
id	string	This is the unique identifier for the credential.
orgId	string	This is the unique identifier for the org that this credential belongs to.
createdAt	string	This is the ISO 8601 date-time string of when the credential was created.
updatedAt	string	This is the ISO 8601 date-time string of when the assistant was last updated.
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

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/AzureCredential",
  "title": "AzureCredential",
  "type": "object",
  "properties": {
    "provider": {
      "type": "string",
      "enum": [
        "azure"
      ]
    },
    "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."
    },
    "id": {
      "type": "string",
      "description": "This is the unique identifier for the credential."
    },
    "orgId": {
      "type": "string",
      "description": "This is the unique identifier for the org that this credential belongs to."
    },
    "createdAt": {
      "format": "date-time",
      "type": "string",
      "description": "This is the ISO 8601 date-time string of when the credential was created."
    },
    "updatedAt": {
      "format": "date-time",
      "type": "string",
      "description": "This is the ISO 8601 date-time string of when the assistant was last updated."
    },
    "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"
        }
      ]
    }
  },
  "required": [
    "provider",
    "service",
    "id",
    "orgId",
    "createdAt",
    "updatedAt"
  ]
}