API
Integrate Agents, workflows, conversations, and knowledge bases with API Keys
The Clouisle API base path is /api/v1. Requests use JSON, and responses use a unified code, data, msg structure. Authenticated requests pass a Bearer JWT or an API Key starting with clou_ in the Authorization request header.
Get Started
Create an API Key, set the base URL, and send your first request.
Agent Chat
Send messages, attachments, and variables, and consume streaming responses.
Workflow Execution
Run workflows, trigger Webhooks, cancel runs, and subscribe to node events.
Conversations
Query, update, delete, and manage message versions.
Knowledge Base
Manage documents, chunks, and retrieval tests.
Streaming Events
Parse SSE events from Agents and workflows.
Error Handling
Recover by HTTP status and business error codes.
/api/v1/admin/* is a protected endpoint used by the admin panel, not a stable third-party public API. Prefer the resource endpoints listed in this section for integrations, and keep a compatibility strategy for version changes.
How is this guide?