API

An API for talking to autonomous AI agents in real time. It supports three connection methods — SSE, MCP and A2A — and provides everything from conversation history, files and artifacts to skill, playbook and user management as REST APIs.

Three connection methods

The basic structure of the request you send to an agent and the response you get back is the same in every method. What differs is how you connect, and how the client learns the specification.

	Chat API / SSE	MCP	A2A
Protocol	REST + SSE	Streamable HTTP / JSON-RPC	JSON-RPC
Endpoint	/v1/chat/completions	/v1/mcp	/v1/a2a
Discovery	None (see the API specification)	Retrieved via tools/list	Retrieved via the Agent Card
Intended client	Your own app / HTTP client	MCP-capable AI agents such as Claude	A2A-capable AI agents

• Chat API / SSE — when you embed agent capabilities into your own application. You control the request and the response yourself
• MCP — when an MCP-capable AI agent connects. The agent retrieves tool definitions automatically
• A2A — when an A2A-capable agent connects. Skills are retrieved from the Agent Card

For the full comparison and implementation examples, see the Connection Guide.

What you can work with

Area	Contents	Reference
Conversations	Chat (SSE streaming), conversation management, file management, artifact retrieval, search	User API (Conversations, Library, Organizations)
Library	Library files, Agents, skills, playbooks	User API (Conversations, Library, Organizations)
Organization	Users, master data	User API (Conversations, Library, Organizations)
Projects	Settings of projects, steps, and placements; starting workflow runs; firing triggers; execution results, records (audit trail), and KPIs; review requests; connectors	User API (Projects) (application) / System Integration API (listing projects, starting and getting workflow runs, and firing triggers only)
Administration	Shared memory, user management, logs, master data management	System Integration API

Getting started

Create a client in Console, then follow Call the API to send your first request.

Guides

• Console Guide — create a client in Console
• Authentication Guide — the AC and CC flows in detail
• Connection Guide — comparing SSE, MCP and A2A
• SSE Streaming Guide — SSE lifecycle and event handling
• Project API Guide — finding executions that did not go well, investigating, and fixing them

References

• User API Reference (Conversations, Library, Organizations) — endpoints for conversations, the library and organizations
• User API Reference (Projects) — endpoints for projects
• System Integration API Reference — every endpoint called from a system integration
• Authentication API Reference — token retrieval and scopes
• MCP API Reference / A2A API Reference

For the Marketplace edition, see Marketplace > API.