/

/Agent Management API

APIs
Generators
Stacks
Projects

Docs
History
Schema
Sources

v45

latestOpenAPI 3.0.0raw.githubusercontent.com2026-08-0114775543.6 KB

User

Get user details

get/user

Response

Successful response

statusboolean

Example response

{
  "status": true
}

All 147 operations

get Get user details
get Get organization details
get Get agent templates
post Create agent from template
get Get all agents
post Create a new agent
post Create agent with AI
post Duplicate agent to another organization
get Get agent by ID
patch Update agent metadata
get Get AI creation questionnaire config
get Get widget configuration
patch Update widget configuration
post Get avatar upload URL
get Get agent workflow
patch Update workflow configuration
get Get agent call logs
delete Archive or unarchive an agent
post Register a realtime agent call
get Get all conversation logs
post Search conversation logs by call IDs
get Get conversation log by ID
get Get a time-limited recording download URL
get List retry attempts for a call
post Cancel an in-flight call
post Cancel a queued call (path-param form)
post Start an outbound call
get Subscribe to live call events (SSE)
get Retrieve all campaigns
post Create a campaign
get Get a campaign
delete Delete a campaign
post Start or resume a campaign
post Pause a campaign
get Get all knowledge bases
post Create a knowledge base
get Get a knowledge base
post Update a knowledge base (name + description)
delete Delete a knowledge base
get Get all knowledge base items
delete Delete a knowledge base item
post Upload a PDF file to a knowledge base
post Get a presigned S3 URL for direct file upload
post Complete a presigned-URL upload and start processing
post Extract URLs from a sitemap.xml
post Scrape a list of URLs into a knowledge base
get List scraped URLs in a knowledge base + their status
delete Delete a scraped URL from a knowledge base
get Get acquired phone numbers
get List all phone numbers (platform + SIP)
get Search rentable phone numbers in inventory
get Preview prorated rental cost for renting a phone number today
post Rent a phone number from the telephony inventory
post Release a rented phone number
get Get Stripe Customer Portal URL
get Check whether the organization has unpaid invoices
post Import a SIP phone number
get Get compliance status
get Get compliance requirements
post Submit a compliance application
patch Resubmit a rejected compliance application
post Refresh compliance application status
get Get webhooks
post Create a webhook
post pre-conversation
post post-conversation
post analytics-completed
delete Delete a webhook
patch Update a webhook
get Get webhook subscriptions for an agent
post Replace webhook subscriptions for an agent
delete Delete webhook subscriptions for an agent
get Get all audiences
post Create audience with CSV upload
get Get audience by ID
delete Delete audience
get Get audience members
post Add audience members
delete Delete audience members
get Search audience members
get List active drafts
post Create a draft
get Get draft detail
delete Discard a draft
patch Rename a draft
get Get draft diff
post Publish a draft
post Test call with draft config
patch Edit draft config (prompt, tools, post-call metrics, voice, etc.)
get List published versions
get Diff two versions
get Get version detail
patch Update version metadata (label, description, pin only)
patch Activate a version
post Test call with version config
get List branches
post Create a branch
get Get branch
patch Rename a branch
post Archive a branch
post Make a branch live
get Get open draft
put Write to draft
delete Discard open draft
post Publish draft
post Cancel in-flight publish
get List revisions on a branch
get Get revision
get Get revision publish trail
post Restore a revision
post Start a test call against a branch
get Diff two revisions or drafts
post Score a prompt
get List call records
get Call counts by day
get Get conversation details
get Credit usage timeseries
get Full dashboard data
get Dashboard summary KPIs
get Call volume timeseries
get Pickup rate by phone number
get Phone number trends
get Hourly performance
get Call outcomes timeseries
get Call duration statistics
get Weekly call trends
get Agent performance
get Concurrent call counts
get Call start distribution
get Daily call summary
get Attempt cohort analysis
get List call actions
post Create a call action
get Get a call action
put Update a call action
delete Delete a call action
post Create or update WebEngage integration
get Get WebEngage integration details
get Get concurrency limits
put Update concurrency reservations
get List disposition metric templates
get List DNC entries for the organization
get Get credit balance
get List credit ledger
get Get usage breakdown
get List invoices
get Get invoice PDF URL