Vapi · Schema

CartesiaCredential

AIVoiceAgentsRealtimeCPaaS

Properties

Name	Type	Description
provider	string
apiKey	string	This is not returned in the API.
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.
apiUrl	string	This can be used to point to an onprem Cartesia instance. Defaults to api.cartesia.ai.

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/CartesiaCredential",
  "title": "CartesiaCredential",
  "type": "object",
  "properties": {
    "provider": {
      "type": "string",
      "enum": [
        "cartesia"
      ]
    },
    "apiKey": {
      "type": "string",
      "description": "This is not returned in the API."
    },
    "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
    },
    "apiUrl": {
      "type": "string",
      "description": "This can be used to point to an onprem Cartesia instance. Defaults to api.cartesia.ai."
    }
  },
  "required": [
    "provider",
    "apiKey",
    "id",
    "orgId",
    "createdAt",
    "updatedAt"
  ]
}