Body

Response

Changelog

GitHub

OpenCopilot Docs

Get Started

Validate a given swagger file and provide recommendations (first create a copilot then validate it here).

Validate swagger file

Open is an AI-powered customer support and customer understanding platform. It can run your entire customer support on autopilot and save up to $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

Styling the 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 extend the Copilot widget UI by using useful utilities exported from `@openchatai/widget`.

Helper exports

Phone Support

Email Support

Open 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

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

Human Handoff

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

Autopilot Topics

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

Zendesk

Notes on API Reference

Get a list of all copilots in the database.

Get All Copilots

Delete a Copilot

Delete all actions

Import actions from a Swagger file to a copilot by ID

Import actions

Ingest knowledge from files into the copilot.

Ingest knowledge from files

Ingest knowledge from URLs into the copilot.

Ingest knowledge from URLs

Delete Knowledge Base

Retrieve knowledge from a specific data source for a given bot.

Get Knowledge from Data Source

Retrieve paginated chat conversations, including handoff status and sentiment summary.

Get Chat Conversations

Retrieve all messages for a specific conversation.

Get Messages

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

Introduction to contacts

Create a new contact for a specific Organization ID.

Create contact

Delete a contact for a specific Organization ID.

Delete a contact

List all contacts for a specific Organization ID.

List contacts

Update a contact for a specific Organization ID.

Update a contact

Send emails to your contacts, possibly after a specified time delay.

Sending emails

Unsubscribe Contacts

Directly Unsubscribe a Contact

Create a link that your contact can click to unsubscribe. This link will redirect your contact to Open.

Get an Unsubscribe Link

This endpoint will initiate a chat with your copilot, it will the copilot name, metdata, and other info.

Initiate chat

What is RLHF?

Up/down vote AI response

Retrieve the total number of chat sessions based on specified criteria

Get Total Chats

Retrieve chat engagement metrics for a specified period and organization

Get Chat Engagement

Retrieve the count of missed chats based on specified criteria

Get Missed Chats

Retrieve the average satisfaction score for chat sessions

Get Chat Satisfaction

Retrieve the chat availability statistics for a specified time period

Get Chat Availability

Retrieve the average duration of chat sessions based on specified criteria

Get Chat Duration

Retrieve performance metrics for agents based on chat sessions

Get Agent Performance

Retrieve average response times for agents in chat sessions

Get Agent Response Times

Retrieve a prediction for staffing needs based on historical chat data

Get Staffing Prediction

Retrieve activity data for agents, including their active and open sessions within a specified time range.

Getting started

Web Support

Phone Support

Email Support

Actions

Native Integrations

Managing copilots via API

Actions

Knowledge Base

History

Contacts

Sending Emails

Chat API

Votes & RLHF

Reports

Resources

Validate swagger file

Body

Response

Getting started

Web Support

Phone Support

Email Support

Actions

Native Integrations

Managing copilots via API

Actions

Knowledge Base

History

Contacts

Sending Emails

Chat API

Votes & RLHF

Reports

Resources

​Body

​Response

Body

Response