API Documentation
Authorization
Agents
Phone Numbers
SIP
Messaging
Webhooks
Knowledge
Accounts
- POSTCreate a new reseller
- GETList resellers
- POSTCreate a new organization
- DELDelete an organization
- GETList organizations
- GETList agent accounts
- POSTCreate a new account
- DELDelete an account
- GETList admin users
- DELDelete admin user
- POSTInvite admin user
- GETFetch Account by externalAccountId
- POSTUpdate Organization Settings
Billing
Agents
Outbound SMS from Agent
Use this endpoint to initiate an outbound SMS text message from your Vida agent to a destination number or user. Your agent will handle the conversation. Note: You must have an active SMS Brand and Campaign on your account for this endpoint to work.
POST
/
api
/
v2
/
agent
/
outboundSms
Copy
Ask AI
curl --request POST \
--url https://api.vida.dev/api/v2/agent/outboundSms \
--header 'Content-Type: application/json' \
--data '{
"context": "Name: Lyle Pratt. Interest: Completed a call back form on our website for more information about our products.",
"target": "+1234567890 or john_doe",
"content": "Hello this is Alice reaching out from Acme Inc with an appointment reminder. You have a scheduled appointment for tomorrow at 10AM."
}'
Copy
Ask AI
{
"success": true,
"message": "Outbound sms initiated."
}
Authorizations
Vida API Token
Body
application/json
Response
200 - application/json
Success
The response is of type object
.
Copy
Ask AI
curl --request POST \
--url https://api.vida.dev/api/v2/agent/outboundSms \
--header 'Content-Type: application/json' \
--data '{
"context": "Name: Lyle Pratt. Interest: Completed a call back form on our website for more information about our products.",
"target": "+1234567890 or john_doe",
"content": "Hello this is Alice reaching out from Acme Inc with an appointment reminder. You have a scheduled appointment for tomorrow at 10AM."
}'
Copy
Ask AI
{
"success": true,
"message": "Outbound sms initiated."
}
Assistant
Responses are generated using AI and may contain mistakes.