Developer API
Programmatic access to everything in Orckai. Manage agents, trigger workflows, search knowledge bases, stream chat responses, and deploy MCP servers through a RESTful interface with 42 endpoints, 18 permission scopes, and full OpenAPI 3.0 documentation.
Every capability in the Orckai platform is exposed through a consistent REST interface. CRUD operations, execution triggers, search, and streaming are all available via API.
List, create, update, and delete AI agents. Execute agents with custom inputs and retrieve conversation history. Configure model selection, system prompts, tools, and runtime mode per agent.
Build multi-step workflows with up to 7 step types. Trigger executions via API, retrieve run history with step-level output, and manage schedules, webhooks, and file-drop triggers programmatically.
Upload documents in 50+ formats. Perform vector similarity search with configurable top-k and threshold. Manage embeddings, list indexed files, and delete individual documents from a knowledge base.
Send messages to any configured agent and receive streaming or synchronous responses. Resume conversations with full history context. Attach knowledge base context for RAG-powered responses with inline citations.
Generate Model Context Protocol servers from database connections or API specifications. Deploy as Docker containers, discover available tools, and invoke them through the API. Manage lifecycle and networking.
Manage prompt templates with variable interpolation. List, create, update, and delete templates. Associate templates with widgets for consistent, branded AI interactions across your applications.
The full API is documented in an OpenAPI 3.0 specification, so you can generate clients, validate requests, and explore endpoints interactively.
Every endpoint, request body, response schema, and error code is documented in a machine-readable OpenAPI 3.0 YAML file. Download it from the docs or fetch it from the /api/v1/openapi.json endpoint.
Browse the API interactively with auto-generated documentation. Try endpoints directly from the browser, inspect request and response shapes, and copy curl commands for quick local testing.
Use the OpenAPI spec with tools like openapi-generator to produce typed clients in Python, TypeScript, Go, Java, C#, and 40+ other languages. Keep your integration type-safe and auto-updated.
Orckai