Agents

Create agent

Create a new AI agent with configuration and instructions

post/api/v1/agents

Request

  • Base URL: http://localhost:8080
  • URL: http://localhost:8080/api/v1/agents
  • Auth: bearerAuth (a scheme the document does not define)

Request body

campaignIdstring uuid
channel'call' | 'whatsapp' | 'sms' | 'email'
provider'vapi' | 'in_house'
namestring required
descriptionstring
externalIdstring
greetingstring
instructionsstring
capabilitiesstring[]
templateIdstring
direction'inbound' | 'outbound' | 'both'
phoneNumberIdstring uuid

Response

Created

successtrue required
messagestring

Example response

{
  "data": {
    "name": "Sales Agent Q1"
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.