Vapi · Schema

CreateS3CredentialDTO

AIVoiceAgentsRealtimeCPaaS

Properties

Name	Type	Description
provider	string	Credential provider. Only allowed value is s3
awsAccessKeyId	string	AWS access key ID.
awsSecretAccessKey	string	AWS access key secret. This is not returned in the API.
region	string	AWS region in which the S3 bucket is located.
s3BucketName	string	AWS S3 bucket name.
s3PathPrefix	string	The path prefix for the uploaded recording. Ex. "recordings/"
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.

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/CreateS3CredentialDTO",
  "title": "CreateS3CredentialDTO",
  "type": "object",
  "properties": {
    "provider": {
      "type": "string",
      "enum": [
        "s3"
      ],
      "description": "Credential provider. Only allowed value is s3"
    },
    "awsAccessKeyId": {
      "type": "string",
      "description": "AWS access key ID."
    },
    "awsSecretAccessKey": {
      "type": "string",
      "description": "AWS access key secret. This is not returned in the API."
    },
    "region": {
      "type": "string",
      "description": "AWS region in which the S3 bucket is located."
    },
    "s3BucketName": {
      "type": "string",
      "description": "AWS S3 bucket name."
    },
    "s3PathPrefix": {
      "type": "string",
      "description": "The path prefix for the uploaded recording. Ex. \"recordings/\""
    },
    "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
    }
  },
  "required": [
    "provider",
    "awsAccessKeyId",
    "awsSecretAccessKey",
    "region",
    "s3BucketName",
    "s3PathPrefix"
  ]
}