POST
/
api
/
v2
/
agent
curl --request POST \
  --url https://api.vida.dev/api/v2/agent \
  --header 'Content-Type: application/json' \
  --data '{
  "type": "chatAgent",
  "title": "Call Screener",
  "description": "Description",
  "welcomeMessage": "This brought to you by Wolf Cola",
  "links": [
    "https://vida.io/faq"
  ],
  "actions": [
    "transfer"
  ],
  "timezone": "America/Chicago, America/New_York, Europe/London, etc",
  "agentVoice": "en-US Female",
  "agentLang": "en-US",
  "agentInstructions": "I want you to payout rewards for users that answer a few questions about this promotional video.",
  "agentModel": "gpt-4o-2024-08-06",
  "agentS2SEngine": null,
  "agentSttEngine": "deepgram",
  "postAnswerDtmf": "<string>",
  "waitOnAnswer": "<string>",
  "interruptionWordCount": 3,
  "interruptionMinimumSpeakingTime": 3,
  "speakingTimeout": 1200,
  "speechProcessingDelay": 500,
  "speechProcessingDelayInterruptionStep": 500,
  "speechProcessingDelayMaxMultiplier": 4,
  "callerResponseTimeout": 13,
  "callerResponseTimeoutHangupCounter": 3,
  "noContactInjection": false,
  "noConvoHistory": false,
  "noAutoRecordingNotification": false,
  "preAnswerRingTime": null
}'
{
  "success": true,
  "message": "Agent created.",
  "campaignId": "camp931829b5857f...."
}

Authorizations

token
string
query
required

Vida API Token

Body

application/json

Response

200 - application/json

Successful response

The response is of type object.