POST · leads:write

Start a task

Give the agent a job in plain language. Set a hard lead-credit cap. Reuse the idempotency key only for the same request.

Set up with your AI assistant

Paste the prompt into your coding assistant. It includes setup steps and a read-only connection check.

Request

Endpoint

POST https://leadsagent.io/api/v1/tasks

Set LEADSAGENT_API_KEY in your local environment. Send it in the X-API-Key header.

Bash · API base URL

export LEADSAGENT_API_BASE="https://leadsagent.io/api/v1"
# For a local backend:
# export LEADSAGENT_API_BASE="http://127.0.0.1:8001/api/v1"

Bash · curl

curl --fail-with-body --silent --show-error --request POST "$LEADSAGENT_API_BASE/tasks" -H "X-API-Key: $LEADSAGENT_API_KEY" -H "Content-Type: application/json" --data '{
  "prompt": "Find 20 dentists in Austin with emails",
  "max_leads": 20,
  "idempotency_key": "austin-dentists-001",
  "allow_questions": true
}'

Replace TASK_ID with data.id from a task response. In PowerShell, use curl.exe and $env:LEADSAGENT_API_KEY. Save JSON in a file and pass --data-binary @request.json.

prompt (string): Required. 3–4,000 characters.
max_leads (integer): 1–5,000 credits; default 100. This is the hard task cap, including follow-ups.
idempotency_key (string): Optional. 8–128 characters. Reuse only for the same prompt and budget.
allow_questions (boolean): Optional. Default true; false asks the agent to make reasonable assumptions.

A repeated key returns the original task. A changed request should use a new key.
The task runs in the background; HTTP 202 means accepted, not completed.

Response

HTTP 202. data is a task object. Save data.id and poll status_url.

Example response

{
  "request_id": "6c4d0c26-8aa3-44b0-a50a-51b832b29465",
  "status": "success",
  "data": {
    "id": "73bd1ccb-1a44-4b41-84da-4ea7a5ad03f4",
    "kind": "agent",
    "status": "queued",
    "prompt": "Find 20 dentists in Austin with emails",
    "source": "API key · research-example",
    "max_leads": 20,
    "created_at": "2026-10-21T12:00:00+00:00",
    "updated_at": "2026-10-21T12:00:00+00:00",
    "steps": [],
    "lead_count": 0,
    "results_ready": false,
    "status_url": "/api/v1/tasks/73bd1ccb-1a44-4b41-84da-4ea7a5ad03f4"
  },
  "meta": {}
}

Errors and retries explains status codes and retry rules. A successful request does not mean a background task has finished.

Read as Markdown