Vapi · Schema

CreateSonioxCredentialDTO

AIVoiceAgentsRealtimeCPaaS

Properties

Name Type Description
provider string
apiKey string This is not returned in the API.
apiUrl string Custom Soniox WebSocket endpoint (e.g. EU server wss://stt-rt.eu.soniox.com/transcribe-websocket). Defaults to the region-appropriate endpoint when omitted.
name string This is the name of credential. This is just for your reference.
View JSON Schema on GitHub

JSON Schema

vapi-createsonioxcredentialdto-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/CreateSonioxCredentialDTO",
  "title": "CreateSonioxCredentialDTO",
  "type": "object",
  "properties": {
    "provider": {
      "type": "string",
      "enum": [
        "soniox"
      ]
    },
    "apiKey": {
      "type": "string",
      "description": "This is not returned in the API."
    },
    "apiUrl": {
      "type": "string",
      "description": "Custom Soniox WebSocket endpoint (e.g. EU server wss://stt-rt.eu.soniox.com/transcribe-websocket). Defaults to the region-appropriate endpoint when omitted."
    },
    "name": {
      "type": "string",
      "description": "This is the name of credential. This is just for your reference.",
      "minLength": 1,
      "maxLength": 40
    }
  },
  "required": [
    "provider",
    "apiKey"
  ]
}