Skip to main content

API Tokens

All API requests require a Bearer token:

Get API Token

Via CLI

Output:

Via Dashboard

  1. Navigate to Settings API Tokens
  2. Click “Create Token”
  3. Select scopes
  4. Copy token (shown only once)

Token Scopes

Control access with fine-grained scopes:

Read Scopes

  • read:ensembles - List and view ensembles
  • read:agents - List and view agents
  • read:executions - View execution history
  • read:components - View components
  • read:state - Read ensemble state

Write Scopes

  • write:ensembles - Create/update ensembles
  • write:agents - Create/update agents
  • write:components - Create/update components
  • write:state - Update ensemble state

Execute Scopes

  • execute:ensembles - Execute ensembles
  • execute:agents - Execute agents

Admin Scopes

  • admin - Full access to all resources

Scope Examples

Read-Only Token

Use case: Monitoring, analytics

Execution Token

Use case: Application integration

Full Access Token

Use case: Development, CI/CD

Token Management

Create Token

Response:

List Tokens

Response:

Revoke Token

Environment Variables

Store tokens securely:

Local Development

Production (Wrangler)

Usage

Security Best Practices

1. Never Commit Tokens
2. Use Minimal Scopes
3. Rotate Tokens Regularly
4. Use Short-Lived Tokens
5. Monitor Token Usage

Error Handling

Missing Token

Request:
Response (401):

Invalid Token

Request:
Response (401):

Insufficient Scope

Request:
Response (403):

Expired Token

Response (401):

OAuth (Future)

OAuth 2.0 support coming soon:

Next Steps

Endpoints

API endpoints

Rate Limits

Rate limiting

Webhooks

Webhook auth

Security Guide

Security best practices