Skip to main content

Base URL

Replace your-worker.workers.dev with your deployed Cloudflare Worker URL.

Authentication

All requests require authentication via Bearer token:

Execute Ensemble

Execute an ensemble workflow.

Request

Parameters

Path:
  • name (string, required) - Ensemble name
Body:
  • inputs (object, required) - Input data
  • options (object, optional) - Execution options
    • timeout (number) - Timeout in ms
    • enableTracing (boolean) - Enable tracing
    • enableCaching (boolean) - Enable caching

Response

Status Codes:
  • 200 - Success
  • 400 - Invalid request
  • 401 - Unauthorized
  • 403 - Forbidden (ensemble not executable via API)
  • 404 - Ensemble not found
  • 408 - Timeout
  • 500 - Server error

Access Control

Ensembles can be configured to allow or deny Execute API access using the apiExecutable flag:
Behavior:
  • By default, all ensembles are executable via the Execute API
  • Set apiExecutable: false to block API execution
  • For stricter control, set api.execution.ensembles.requireExplicit: true in conductor.config.ts to require explicit opt-in
See Security & Authentication for full configuration options.

Example

Execute Agent

Execute a single agent directly.
Note: Direct agent execution must be enabled in your security configuration. See Security & Authentication.

Request

Response

Status Codes:
  • 200 - Success
  • 400 - Invalid request
  • 401 - Unauthorized
  • 403 - Forbidden (agent not executable via API or direct execution disabled)
  • 404 - Agent not found
  • 500 - Server error

Access Control

Agents can be configured to allow or deny Execute API access using the apiExecutable flag:
Behavior:
  • By default, all agents are executable via the Execute API (if direct agent execution is enabled)
  • Set apiExecutable: false to block API execution
  • For stricter control, set api.execution.agents.requireExplicit: true in conductor.config.ts to require explicit opt-in
See Security & Authentication for full configuration options.

List Ensembles

Get all available ensembles.

Request

Query Parameters:
  • tags (string[]) - Filter by tags
  • search (string) - Search by name/description

Response

Get Ensemble

Get ensemble metadata.

Request

Response

List Agents

Get all available agents.

Request

Response

Get Execution Status

Get execution status and details.

Request

Response

Cancel Execution

Cancel a running execution.

Request

Response

List Executions

Get execution history.

Request

Query Parameters:
  • ensemble (string) - Filter by ensemble
  • status (string) - Filter by status
  • startTime (number) - Filter by start time
  • limit (number) - Limit results (default: 100)

Response

Get State

Get ensemble state.

Request

Response

Update State

Update ensemble state.

Request

Response

Get Logs

Get execution logs.

Request

Query Parameters:
  • level (string) - Filter by log level
  • agent (string) - Filter by agent

Response

Health Check

Check API health.

Request

Response

Error Response Format

All errors follow this format:
Error Codes:
  • INVALID_INPUT - Invalid request data
  • UNAUTHORIZED - Missing/invalid auth token
  • FORBIDDEN - Resource not accessible (e.g., apiExecutable: false)
  • NOT_FOUND - Resource not found
  • TIMEOUT - Execution timeout
  • RATE_LIMIT_EXCEEDED - Rate limit hit
  • INTERNAL_ERROR - Server error

Rate Limiting

Rate limits apply per API token: Headers:
When rate limited (429):

Pagination

List endpoints support cursor-based pagination:
Response includes:

Next Steps

Authentication

API authentication

Webhooks

Webhook integration

Rate Limits

Rate limit details

TypeScript SDK

TypeScript API