API Reference

Use the Botcadence API to read projects and customers, manage knowledge sources, trigger campaign calls, inspect conversations, and retrieve analytics.

Projects

Method	Endpoint	Docs
`GET`	`/organizations/{organization_id}/projects`	List projects
`GET`	`/organizations/{organization_id}/projects/{project_id}`	Get project

Sources

Method	Endpoint	Docs
`POST`	`.../sources/files`	Upload files
`POST`	`.../sources/urls`	Upload URLs
`POST`	`.../sources/domains`	Upload domains
`GET`	`.../sources`	List sources
`GET`	`.../sources/{source_id}`	Get source
`DELETE`	`.../sources/{source_id}`	Delete source

Customer profiles

Method	Endpoint	Docs
`GET`	`.../customer-profiles`	List profiles
`GET`	`.../customer-profiles/{id}`	Get profile
`GET`	`.../customer-profiles/{id}/chat-conversations`	Chat conversations

Campaigns

Method	Endpoint	Docs
`GET`	`.../campaigns`	List campaigns
`GET`	`.../campaigns/{id}`	Get campaign
`POST`	`.../campaigns/{id}/retry-call`	Retry call
`POST`	`.../campaigns/{id}/trigger-call`	Trigger call

Conversations

Method	Endpoint	Docs
`GET`	`.../conversations`	List
`GET`	`.../conversations/{id}`	Get
`GET`	`.../conversations/{id}/messages`	Messages
`GET`	`.../conversations/{id}/recording-url`	Recording URL
`GET`	`.../inbounds/{id}/report`	Inbound report

Analytics

Method	Endpoint	Docs
`GET`	`/organizations/{organization_id}/analytics`	Org analytics
`GET`	`.../analytics`	Project analytics
`GET`	`/organizations/{organization_id}/conversation-analytics`	Org conversation analytics
`GET`	`.../conversation-analytics`	Project conversation analytics

Base URL

Environment	Base URL
Production	`https://backend.botcadence.com`
Staging	`https://staging-backend.botcadence.com`

Authentication

X-API-Key: bot_live_YOUR_KEY

See Authentication.

Next steps

Authentication

Create and use project API keys.

List projects

List projects in an organization.

Upload files

Add knowledge-base files to a project.

Customer profiles

List unified customer profiles.

Trigger outbound call

Place a call with your API key.

Getting Started

Organization

Projects

Chat Agent

Voice Agent

API Reference

Projects

Sources

Customer profiles

Campaigns

Conversations

Analytics

Base URL

Authentication

Next steps

Authentication

List projects

Upload files

Customer profiles

Trigger outbound call

​Projects

​Sources

​Customer profiles

​Campaigns

​Conversations

​Analytics

​Base URL

​Authentication

​Next steps

Authentication

List projects

Upload files

Customer profiles

Trigger outbound call

Projects

Sources

Customer profiles

Campaigns

Conversations

Analytics

Base URL

Authentication

Next steps