Skip to main content
The flow has three steps:
  1. Create an API key on your agent’s API access tab in the Clicks app.
  2. Call POST /v1/agents to start a run.
  3. Poll GET /v1/agents/{agent_id} until the run finishes, then read the transcript.
This API doesn’t provide webhooks. To detect completion, poll the run’s status.

Quickstart

Zero to transcript in about five minutes.

Authentication

How API keys work and how to send them.

Agent lifecycle and polling

What loop_status means and when a run is done.

Sending files

Attach files and reference them from the input.

API reference

Base URL, endpoints, versioning, and the OpenAPI schema.

Errors and retries

Every status the API returns, with retry guidance.