The unique identifier of the organization

The end date for the report period (ISO 8601 format)

The start date for the report period (ISO 8601 format)

Path Parameters

Query Parameters

Response

Authentication

Changelog

GitHub

OpenCopilot Docs

API Reference

Get Started

Retrieve performance metrics for agents based on chat sessions

Get Agent Performance

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 about our pricing and how to get started with Open.

Pricing

Learn how to embed the widget in your app

Chat widget

Learn how to respond to user input with a UI.

Responding with UI

Learn how to authenticate the copilot's API calls to your backend

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

Hooks

Learn How to use the widget primitives to build your own ui to match your design system.

Headless Widget (Custom UI)

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

Introduction to AI Phone Calling

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

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

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

Zapier

Learn how to train your AI on your knowledge base with our 25+ integrations.

Train your AI on Knowledge

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

Introduction to contacts

Create a contact

Delete a contact

List contacts

Update a contact

List phone numbers

Delete a phone number

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

We have gone further than anyone in on the market to make sure that our AI is safe and reliable.

See what the AI is doing in real time and intervene if needed.

Inspect Mode

Debug Mode

See the AI response/plan before sending it to the contact.

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

Ensures that messages from agents always reach the customer, no matter what communication channel the customer used 

AI Actions

Contacts

AI Phone Agents

Chat Sessions

AI Email

Webhooks

Get Agent Performance

Authentication

Path Parameters

Query Parameters

Response

AI Actions

Contacts

AI Phone Agents

Chat Sessions

AI Email

Webhooks

​Authentication

​Path Parameters

​Query Parameters

​Response

Authentication

Path Parameters

Query Parameters

Response