> ## Documentation Index
> Fetch the complete documentation index at: https://docs.clickshealth.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Clicks Agents API

> Run your configured agents programmatically: create an agent run, then poll its status and read the transcript.

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.

<Columns cols={2}>
  <Card title="Quickstart" icon="rocket" href="/quickstart">
    Zero to transcript in about five minutes.
  </Card>

  <Card title="Authentication" icon="key" href="/authentication">
    How API keys work and how to send them.
  </Card>

  <Card title="Agent lifecycle and polling" icon="tower-cell" href="/agent-lifecycle">
    What loop\_status means and when a run is done.
  </Card>

  <Card title="Sending files" icon="file-lines" href="/files">
    Attach files and reference them from the input.
  </Card>

  <Card title="API reference" icon="book-open" href="/api/introduction">
    Base URL, endpoints, versioning, and the OpenAPI schema.
  </Card>

  <Card title="Errors and retries" icon="triangle-exclamation" href="/api/errors">
    Every status the API returns, with retry guidance.
  </Card>
</Columns>


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.