Open.cx Docs home page
Search...
⌘K
Documentation
API Reference
Contacts
Introduction to contacts
POST
Create a contact
GET
List contacts
PATCH
Update a contact
DEL
Delete a contact
POST
Authenticate contact
Sessions
Sessions
POST
Create a chat session
GET
Get a chat session
GET
List chat sessions
PATCH
Update a chat session
POST
Send a message
GET
List chat session history
AI Phone Agents
POST
Create an AI phone agent
GET
List AI phone agents
PATCH
Update an AI phone agent
DEL
Delete an AI phone agent
POST
Make an AI phone call
AI Email
POST
Send emails
PUT
Add or update a custom domain for email sending
GET
List all custom domains
PATCH
Start verification process for a custom domain
DEL
Delete a custom domain
AI WhatsApp
POST
Send template
AI Actions
DEL
Delete all actions
PUT
Import from OpenAPI file
AI Outbound Sequencing
POST
Create a sequence
GET
Get a sequence
PATCH
Update a sequence
PUT
Start a sequence
PUT
Cancel a sequence
POST
Add contacts to a continuous sequence
AI Training
Custom Training
POST
Create a custom training
PUT
Update a custom training
DEL
Delete a custom training
GET
Generate training scenario from chat history
Customer Insights
Customer Insights
GET
Get customer insights
GET
Get a specific customer insight
POST
Mark an insight as resolved
POST
Assign insight to a group
Teams
Teams
GET
Get all teams
GET
Get specific team
POST
Create new team
PUT
Update team
DEL
Delete team
POST
Add user to team
DEL
Remove user from team
Redaction
Redaction
POST
Redact a specific message
POST
Redact all messages in a session
Crawl
Crawl
POST
Submit a URL for crawling
GET
Check crawl job status
GET
Get paginated crawl jobs
Webhooks
Event Types
Get Started
Open.cx Docs home page
Search...
⌘K
Get Started
Get Started
Search...
Navigation
Notes on API Reference
Notes on API Reference
Our public APIs are in closed beta.
Our public APIs are in closed beta. If you are interested in using our APIs, please
contact us
to request access.
When to use the API Reference
You might need to use the API Reference when you want to:
Integrate OpenCopilot with your existing CI/CD pipeline (e.g., Jenkins, CircleCI, GitHub Actions, etc.)
Automate the creation of copilots
Automate the deletion of copilots
Automate adding or removing actions to a copilot
And maybe the most common use case: replace our UI with your own custom UI
We are happy to help you with any questions you might have about our APIs. Please
contact us
and we will make sure to set you for success.
Was this page helpful?
Yes
No
On this page
When to use the API Reference
Assistant
Responses are generated using AI and may contain mistakes.