REST API

The InSkill public API gives a backend system service-level access to your account, without an interactive sign-in. Use it to integrate InSkill with your other systems: load resources, keep assets in step, read GPT sessions, or export a copilot.

To connect an AI client such as Claude, which acts as the person who signs in and works within their role, use the MCP Server instead.

Getting the API Key

The account API key is on the Account tab of the Admin portal. Click the eye icon to show it. Generate New Key replaces the key, and any application using the old key stops working until it is updated with the new one. See Account.

🚧

Caution

Treat the API key like a password. Do not share it, and regenerate it if it may have been exposed.

Authentication

Send the account API key in the apikey request header:

curl https://expert.inskill.ai/public/apiv3/products \
  -H "apikey: <api_key>"

The account API key gives a request access to the whole account. For example, listing GPT sessions returns every session in the account.

What the API Covers

The API Reference groups the endpoints by area: products, resources, tasks, steps, assets, data dictionary, users, roles, and GPT sessions. Each endpoint page lists its URL, parameters, and responses.

📘

Note

The API says product where the rest of the documentation says copilot. They are the same thing.

A few things to know before you start:

• Listing: list endpoints support filtering, pagination, sorting, and field expansion. Some fields are left out by default — for example, a step's body and instructions — and are added with ?expand=.
• Translations: tasks and steps return English by default. Add ?expand=translations for the other languages, keyed by language code.
• Resource files: documents, images, and videos are uploaded as files with multipart/form-data. A resource belongs to the account, a copilot (product_id), or an asset (asset_id), depending on which ID you provide.

Exporting a Copilot

Export as JSON returns a complete copilot in one file: its settings, tasks and steps, scripts, observations, translations, data dictionary entries, GPT tools and configurations, and resources. A type the copilot has none of comes back as an empty list. Use it to back up a copilot, to transfer it between environments, or to analyze its structure. See Export as JSON.