The bot token (to not be confused with the Auth token or the copilot/organization ID) — you can get this from the dashboard -> settings -> Token

Body

Headers

Response

Changelog

GitHub

OpenCopilot Docs

API Reference

Get Started

Up/down vote AI response

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

Authentication

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

     
This endpoint supports the [OpenAPI V3 Specification](https://swagger.io/specification/) (previously known as Swagger). We have introduced some new fields to the OpenAPI specification that are custom to Open. These fields are:

- `x-open-execute-after: string[]`
  This field is useful when you want to execute other operation(s) before the current operation/action. it takes an array of operation IDs. The AI will execute the operations in the order they are listed in the array.

  ### Example
  Suppose you have an action with the operation ID `deleteUserCourses`. Before performing this action, you want to force the AI to list all the courses the user has and then delete them.

  You can achieve this by adding `['listUserCourses']` to the `x-open-execute-after` field. The AI will first execute the `listUserCourses` operation and then proceed to execute the `deleteUserCourses` operation.


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

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


  Buy an AI phone number for the organization (can be used to receive and make phone calls that are connected to the AI agent). For now, this API only supports US phone numbers. Email mo@open.cx for other countries.
  

Create AI Phone Number

Update a phone number

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

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

AI Actions

Contacts

AI Phone Agents

Chat Sessions

AI Email

Webhooks

Up/down vote AI response

Body

Headers

Response

AI Actions

Contacts

AI Phone Agents

Chat Sessions

AI Email

Webhooks

​Body

​Headers

​Response

Body

Headers

Response