API Reference

CoreAI API

HTTP/JSON API for the CoreAI platform. This reference documents the27 endpoints reachable with an API key(5 groups) — the programmatic surface for application integrations. Generated from the backend OpenAPI schema (v2.2.3).

Base URL

https://<host>/api

Authentication

All endpoints below are authenticated with an API key, passed in the X-API-Key header:

curl https://<host>/api/... \
  -H "X-API-Key: <your-key>"

A key inherits its owner's permissions and can be scoped to specific agents, workflows, chat models, or knowledge bases. Some endpoints additionally require a permission (shown per endpoint, e.g. KNOWLEDGE_BASE_WRITE). Create and manage keys in the Admin UI.

Endpoint groups

/api/chat

/api/chat-models

/api/knowledge-base

/api/messages

/api/workflows