POST

https://api.vida.dev

/
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",
  "welcomeMedia": "https://link.to.your.video",
  "welcomeMessageRecording": "greeting.mp3",
  "links": [
    "https://vida.io/faq"
  ],
  "actions": [
    "transfer"
  ],
  "agentVoice": "en-US Female",
  "agentTtsEngine": "google",
  "agentLang": "en-US",
  "postRewardMessage": "Thanks for watching to receive 10% off your next order, use promo code GIVEME10OFF",
  "postRewardMedia": "https://link.to.your.video",
  "postRewardQualifiedLeadMessage": "Wow! This looks like a match made in heaven. Here is an additional 25% off if you sign up with us today!",
  "qualityLeadMinScore": 5,
  "agentInstructions": "I want you to payout rewards for users that answer a few questions about this promotional video."
}'
{
  "success": true,
  "message": "Agent created.",
  "campaignId": "camp931829b5857f...."
}

Authorizations

token
string
queryrequired

Vida API Token

Body

application/json
type
enum<string>
required

Type for this agent

Available options:
chatAgent
title
string
required

Title for Agent

description
string
required

Some description

welcomeMessage
string

Message users see when initially visiting a agent

welcomeMedia
string

Media (e.g. Video Links) users see when initially visiting a campaign attached object such as a room or chatAgent

welcomeMessageRecording
string

Audio file (mp3) that is played when someone dials into your campaign Phone Number. This file must be uploaded to your vida media

links
string[]

Array of any http links to reference for external knowledge for your agent

actions
string[]

Actions that your agent can take including instructions and settings

agentVoice
string

Agent voice model to use

agentTtsEngine
enum<string>
default: google

Text to speech engine for this agent

Available options:
google,
11labs
agentLang
enum<string>
default: en-US

Agent language to be used for voice and transcriptions

Available options:
en-US,
es-MX,
es-ES,
es-US
postRewardMessage
string

Message sent to the user after they have received a reward from a chatAgent or sponsored room

postRewardMedia
string

Media (e.g. Video Links) users see along with your post reward message

postRewardQualifiedLeadMessage
string

Message sent to the user after reward grant that has met the minimum quality lead score

qualityLeadMinScore
integer
default: 6

Minimum lead score to be considered a quality lead. Will move to priority inbox and trigger postRewardQualifiedLeadMessage if set

agentInstructions
string

Agent instructions for user interaction. This is for chatAgents only

Response

200 - application/json
success
boolean
message
string
campaignId
string
Revert an AgentFetch Staging Agent