Vapi · Schema

CreateXAiCredentialDTO

AIVoiceAgentsRealtimeCPaaS

Properties

Name Type Description
provider string This is the api key for Grok in XAi's console. Get it from here: https://console.x.ai
apiKey string This is not returned in the API.
name string This is the name of credential. This is just for your reference.
View JSON Schema on GitHub

JSON Schema

vapi-createxaicredentialdto-schema.json Raw ↑ 
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/CreateXAiCredentialDTO",
  "title": "CreateXAiCredentialDTO",
  "type": "object",
  "properties": {
    "provider": {
      "type": "string",
      "description": "This is the api key for Grok in XAi's console. Get it from here: https://console.x.ai",
      "enum": [
        "xai"
      ]
    },
    "apiKey": {
      "type": "string",
      "maxLength": 10000,
      "description": "This is not returned in the API."
    },
    "name": {
      "type": "string",
      "description": "This is the name of credential. This is just for your reference.",
      "minLength": 1,
      "maxLength": 40
    }
  },
  "required": [
    "provider",
    "apiKey"
  ]
}