When to use the API Reference

Changelog

GitHub

OpenCopilot Docs

API Reference

Get Started

Notes on API Reference

Open is an AI-powered customer support and customer communication ecosystem. It can run your entire customer support on autopilot and save more than $100K a year. Open can also help you understand your customers better and suggest the next 10 features to implement, just by analyzing your customer data.

Introduction

Learn how to embed the widget in your app

Chat widget

Learn how to make your AI show beautiful custom interfaces

UI Responses

Authentication

Learn how to use the widget hooks to build your own UI to match your design system.

Hooks

Build custom UIs with our React hooks and components

React Hooks & Components

Open provides a complete and powerful AI phone calling solution that can be used to automate your customer support and customer communications.

Make intelligent outbound calls at scale with our AI phone agents

AI Outbound Calls

Learn how the AI can hand off the conversation to a human agent when needed.

Human Handoff

Human Agent

Our AI can take actions to solve the customer's problems. It can call your backend to update records, create new records, and much more.

Taking Actions

Define the topics that you do not want the AI to handle.

Autopilot Topics

Delete all actions. This operation is safe only when you can re-import all the actions from an OpenAPI spec. Any actions created manually from the dashboard will be deleted.

Delete all actions

     
Upload your OpenAPI (previously known as Swagger) specification.
Versions 2, 3, and 3.1 are supported. Both YAML and JSON formats are supported.


Import from OpenAPI file

Connect your existing knowledge sources to power your AI

Knowledge Base Integrations

Train your AI on Shopify data for amazing customer support

Shopify Integration

Use AI agents as your front-line support in Zendesk

Zendesk Integration

Train your AI on email support conversations

Gmail Integration

Notion Integration

Train your AI on your Confluence workspace

Confluence Integration

Website Integration

Train your AI on historical support conversations

Zendesk Tickets Integration

Intercom Integration

Train your AI on your Google Drive documents

Google Drive Integration

Dropbox Integration

Native integration with Zendesk to allow your copilot to hand chats over to your Zendesk support agents.

Zendesk

Give your AI Support Agent the power to solve the most recurring L2 and L3 tickets in your store.

Shopify

Create Jira tickets automatically from customer feedback and conversations

Jira Integration

Open is integrated with Zapier! You can automate multiple Open actions and triggers using zapier.com and using OpenCX app.

Zapier

Some of the APIs in the contact APIs section allow you to create, list, and delete contacts.

Introduction to contacts

Create a contact

List contacts

Update a contact

Delete a contact


  Create an AI phone agent. This phone number can be used to receive and make phone calls. For now, this API only supports US phone numbers. Email mo@open.cx for other countries.
  

Create an AI phone agent

List AI phone agents

Update an AI phone agent

Delete an AI phone agent

Create a chat session

Get a chat session

List chat sessions

Update a chat session

Send a message

List chat session history


Send emails to multiple contacts, possibly with a time delay.

To send emails using the API, you must first verify the domain you want to
send emails from. You can add and verify custom domains in the settings.


Send emails

Create a sequence

Get a sequence

Update a sequence

Start a sequence

Cancel a sequence


Add contacts to a continuous sequence (`is_continuous` property of the sequence must be `true`).
Contacts will *not* be added to the sequence if the sequence's `filter` does not apply to the contact.

Any contacts added will automatically be added to contacts if they don't already exist.


Add contacts to a continuous sequence

How we keep your AI interactions safe, reliable, and under control

AI Safety & Control

Watch and control AI conversations as they happen

Real-Time AI Monitoring

See exactly why the AI responded the way it did

Understanding AI Decisions

Automatically protect sensitive information in conversations

PII Redaction

Define topics you don't want AI to handle

Unapproved Topics

Let your team review AI responses before they're sent

Assist Mode

Learn how to use the copilot's CI/CD actions to automate your workflow

CI/CD Actions

How to increase your AI automation

Never miss a customer response - no matter which channel they use

Getting started

AI Web Support

AI Phone Support

AI Actions

Integrations

AI Safety

Resources

Notes on API Reference

When to use the API Reference

Getting started

AI Web Support

AI Phone Support

AI Actions

Integrations

AI Safety

Resources

​When to use the API Reference

When to use the API Reference