Skip to main content
The AgentRuntime BFF API is the public integration surface for all programmatic access. Base URL:
EnvironmentURL
Productionhttps://api.agentruntime.io
Developmenthttps://api-dev.agentruntime.io
Authenticate with a session cookie (browser) or personal access token (scripts and services). For copy-paste curl and JSON samples, see API examples.

​
Request context

Tenant- and project-scoped requests include context headers:
HeaderDescription
X-Tenant-IdWorkspace (tenant) identifier
X-Project-IdProject scope for workflow and integration operations
The Console sets these automatically. API clients must send them on scoped endpoints.

​
Major endpoint groups

​
Workflows and runs

AreaBase pathNotes
Workflows/v1/workflowsCRUD, versions, validate, connection overrides
Run commands/v1/workflows/{id}/commandstart, pause, resume, stop
Runs feed/v1/runsTenant-wide run list
Events/v1/workflows/{id}/runs/{runID}/eventsStep log
Stream/v1/workflows/{id}/streamWebSocket live events
Human tasks/v1/tasks/pending, /v1/workflows/.../tasks/...HITL inbox
Requires project_viewer (read) or project_contributor (write/run).

​
Integrations

AreaBase path
Connections/v1/connections
MCP servers & instances/v1/mcp/*
Inbound webhooks/v1/inbound-webhooks

​
AI and chat

AreaBase path
Autopilot/v1/autopilot/*
Chat proxy/v1/chat/*
Memory/v1/memory/*
LLM catalog/v1/llm-*

​
Platform

AreaBase path
Auth/v1/auth/*
Billing/v1/billing/*
Analytics/v1/analytics/*
PATs/v1/pats
Onboarding/v1/onboarding/*

​
Example: start a workflow run

curl -X POST "https://api.agentruntime.io/v1/workflows/{workflow_id}/command" \
  -H "Authorization: Bearer YOUR_PAT" \
  -H "X-Tenant-Id: your-tenant" \
  -H "X-Project-Id: your-project" \
  -H "Content-Type: application/json" \
  -d '{"command": "start", "params": {"customer_id": "123"}}'

​
Platform MCP

For IDE integrations, use Platform MCP at https://mcp.agentruntime.io/mcp with a PAT. It exposes Console operations as MCP tools rather than raw REST.

​
Internal services

Control-service, agentruntime workflow engine, and chat-service are internal. Customer integrations should always go through the BFF — not direct internal URLs.

​
Rate limits and errors

The API returns standard HTTP status codes. 401 and 403 indicate auth or role failures. 422 often signals validation errors from dry-run or graph checks. Retry idempotent reads on 5xx with exponential backoff. See the full API reference and Platform MCP for endpoint tables and IDE integration. Contact support@agentruntime.io for enterprise rate limits and SLA details.