OpenCopilot Docs home page
Search...
⌘K
Ask AI
GitHub
Get Started
Get Started
Search...
Navigation
Managing copilots via API
Notes on API Reference
Documentation
Changelog
GitHub
Getting started
Introduction
Authentication
Flows
Introduction to flows
Create your first flow
Copilot widget
How to embed the widget
Styling the widget
Responding with UI
Managing copilots via API
Notes on API Reference
GET
Get All Copilots
DEL
Delete a Copilot
Actions
DEL
Delete all actions
PUT
Import actions
Knowledge Base
POST
Ingest Knowledge (alpha)
Chat API
GET
Initiate chat
Resources
CI/CD Actions
On this page
When to use the API Reference
Managing copilots via API
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.
Responding with UI
Get All Copilots
Assistant
Responses are generated using AI and may contain mistakes.