Copilot's public API is organized around REST. Our API has predicated resource-oriented URLs, accepts JSON request bodies and returns JSON-encoded responses, and uses standard HTTP response codes and verbs.

API Endpoint

The API endpoint is available below:

API Keys

You can generate your API key on the Settings > API page.


Copilot supports API key-based authentication. To authenticate your requests, you must pass your key as an X-API-KEY header.

curl \
  -X POST \
  -H "Content-Type: application/json" \
  -H "X-API-KEY: <Replace this with your API Key>" \
  --data '<Replace this with a json request body as needed>' \<Replace this with a resource>