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.
File Uploads
Upload images, documents, and sandbox artifacts, and parse file content.
API Keys
Create and manage user-level API keys for Agents, workflows, and uploads.
Authentication & Login
Registration, click captcha, password login, TOTP 2FA, and password recovery.
SSO
Provider discovery, OAuth2/OIDC/SAML2/CAS login flows, and connection unlinking.
Two-Factor Authentication (TOTP)
Bind, enable, and disable TOTP 2FA and manage backup codes.
Agents
Manage the Agent lifecycle, publish control, and statistics queries.
Agent Chat
Send messages, attachments, and variables, and consume streaming responses.
Conversations
Query, update, delete, and manage message versions.
Memories
Manage the current user's long-term memory entities and relation graph.
Knowledge Base
Manage documents, chunks, and retrieval tests.
Prompt Generation
AI-powered streaming prompt generation and iterative optimization.
Workflow Execution
Run workflows, trigger Webhooks, cancel runs, and subscribe to node events.
Workflow Versions & Templates
Version snapshots, publishing, visual diff, rollback, and template marketplace.
Tools
Manage and execute the tools an Agent can call.
Skills
Import, update, delete, and test sandbox skill packages.
Teams
Manage team details, member roles, and ownership transfer.
Team Models
Configure which models a team may use, quota limits, and usage.
Models
Discover available models and look up the default model per type.
Notifications
Read the in-app inbox, and let admins publish or delete notifications.
Streaming Events
Parse SSE events from Agents and workflows.
Embed Integration
Embed Agent chat and workflow executions into third-party portals and iframes.
Users
Manage the current user's profile and password, plus admin user CRUD.
Admin API
Grouping, permission codes, and call boundaries for admin endpoints.
Settings
Manage site settings, notification channels, public settings, and background memory extraction.
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?