Skip to main content

Documentation Index

Fetch the complete documentation index at: https://polos.dev/docs/llms.txt

Use this file to discover all available pages before exploring further.

The Polos Orchestrator API provides programmatic access to manage agents, workflows, executions, events, and more.

​
Base URL

http://localhost:8080/api/v1
For production deployments, replace with your orchestrator URL.

​
Authentication

All API requests require:
  • Bearer token: Your API key for authentication
  • Project ID header: The project to operate on
Authorization: Bearer your-api-key
X-Project-ID: your-project-id
Example request: 
curl -X GET "http://localhost:8080/api/v1/workflows" \
  -H "Authorization: Bearer your-api-key" \
  -H "X-Project-ID: your-project-id"

​
Core Resources

Workflows

Submit, query, and manage workflow executions

Agents

Register and query agent definitions

Executions

Submit workflows and manage running executions

Events

Publish and subscribe to events

Schedules

Create and manage workflow schedules

Traces

Query execution traces and spans

​
Common Operations

​
Submit a workflow

curl -X POST "http://localhost:8080/api/v1/workflows/my_workflow/run" \
  -H "Authorization: Bearer your-api-key" \
  -H "X-Project-ID: your-project-id" \
  -H "Content-Type: application/json" \
  -d '{"input": {"key": "value"}}'

​
Resume a suspended execution

curl -X POST "http://localhost:8080/api/v1/executions/{execution_id}/resume" \
  -H "Authorization: Bearer your-api-key" \
  -H "X-Project-ID: your-project-id" \
  -H "Content-Type: application/json" \
  -d '{"data": {"approved": true}}'

​
Publish an event

curl -X POST "http://localhost:8080/api/v1/events/publish" \
  -H "Authorization: Bearer your-api-key" \
  -H "X-Project-ID: your-project-id" \
  -H "Content-Type: application/json" \
  -d '{"topic": "orders/created", "data": {"order_id": "123"}}'