API Reference
API Reference
Full reference for the Elizon Public API endpoints.
Every endpoint in the Elizon Public API, grouped by resource. All paths are relative to https://api.elizon.ai/api/v1 and require an X-API-Key header — see Authentication if you don't have a key yet.
Running an Agent, Team, or Workflow?
| Resource | Endpoint | Description |
|---|---|---|
| Organization | GET /organizations/limits | Your rate limits and file-upload posture. |
| Agents | GET /agents | List agents. |
| Agents | POST /agents | Create an agent. |
| Agents | GET /agents/:agentId | Get one agent. |
| Agents | PUT /agents/:agentId | Update an agent. |
| Agents | GET /agents/llm-providers | List connected LLM providers and models. |
| Knowledge Bases | GET /knowledge-bases | List the Knowledge Bases in a project. |
| Knowledge Bases | POST /knowledge-bases | Create a Knowledge Base. |
| Knowledge Bases | GET /knowledge-bases/:knowledgeBaseId | Get one Knowledge Base. |
| Knowledge Bases | DELETE /knowledge-bases/:knowledgeBaseId | Delete a Knowledge Base. |
| Knowledge Bases | POST /knowledge-bases/:knowledgeBaseId/documents | Upload documents. |
| Knowledge Bases | GET /knowledge-bases/:knowledgeBaseId/documents | List documents and their ingestion status. |
| Knowledge Bases | DELETE /knowledge-bases/:knowledgeBaseId/documents/:documentId | Delete a document. |
| Knowledge Bases | POST /knowledge-bases/:knowledgeBaseId/urls | Crawl URLs into a Knowledge Base. |
| Knowledge Bases | GET /knowledge-bases/:knowledgeBaseId/urls | List URL sources and their crawl status. |
| Knowledge Bases | POST /knowledge-bases/:knowledgeBaseId/search | Search a Knowledge Base. |
| Teams | GET /teams | List teams. |
| Teams | POST /teams | Create a team. |
| Teams | GET /teams/:teamId | Get one team. |
| Teams | PUT /teams/:teamId | Update a team. |
| Teams | POST /teams/:teamId/run-sync | Run a team and wait for its answer (≤30 s). |
| Teams | POST /teams/:teamId/run-stream | Run a team and stream its answer. |
| Teams | DELETE /teams/:teamId/runs/:runId | Cancel an in-progress team run. |
| Teams | POST /teams/:teamId/run-async | Queue a team run and poll for it. |
| Teams | GET /team-jobs/:jobId | Poll an async team run. |
| Teams | POST /team-jobs/:jobId/cancel | Cancel an async team run. |
| Workflows | POST /workflows/:workflowId/run | Run a published workflow, blocking (≤30 s). |
| Workflows | POST /workflows/:workflowId/run-async | Start a workflow run and poll for it. |
| Workflows | GET /workflow-jobs/:jobId | Poll a workflow run's status. |
| Workflows | POST /workflow-jobs/:jobId/cancel | Cancel an in-flight workflow run. |
New to the API? Start with the Quickstart instead — it walks through the same endpoints end to end. See Error Codes for the full list of error responses these endpoints can return.