CumulusDocs
Open Studio

Customer HTTP API

Customer HTTP API reference

Use these endpoints from your application to manage agents and publications, place calls and retrieve results. Find an endpoint by task, name or path, then open its request and response reference. For agent builders, customer-server handlers and call helpers, use the customer SDK reference.

API base URLhttps://api.cumuluslabs.io

Your API key selects the workspace and permissions. If Cumulus provides a separate development API URL, use that origin instead. Pass the origin as baseUrl to the client or CUMULUS_API_URL to the CLI.

Send Authorization: Bearer <API key>. Write requests use JSON; endpoints marked for idempotency also require Idempotency-Key. Keep keys server-side; browser clients use an authenticated same-origin proxy.

The SDK uses these same endpoints. The customer SDK tutorial shows the complete definition, publication and calling workflow; this reference provides the HTTP details for each operation.

Browse by feature

105 of 105 endpoints · Select one for fields, responses and integration guidance.

Build agents

Create agents, edit their flows and publish versions.

Read the guide →
21 endpoints

Run and review

Start tasks and conversations, stream events and retrieve results.

Read the guide →
16 endpoints

Test and evaluate

Simulate callers, inspect verdicts and compare agent versions.

Read the guide →
19 endpoints

Connect telephony

Connect your carrier, assign numbers and control call limits.

Read the guide →
10 endpoints

Add knowledge

Upload source documents and manage their searchable generation.

Read the guide →
7 endpoints

Manage usage

Read rates and spend, set budgets and configure alerts.

Read the guide →
11 endpoints

Manage your workspace

Manage keys, credentials, members, environments and retention.

Read the guide →
21 endpoints

Interactive API reference

Browse the same endpoints and schemas below, or copy a request in your preferred language.