POST · leads:write (list_tasks uses leads:read)

Run a tool

Run one catalog tool on the current task list. Call search-tools first, then use its exact tool name and arguments.

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/{id}/tools/{tool}

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/$TASK_ID/tools/filter_leads" -H "X-API-Key: $LEADSAGENT_API_KEY" -H "Content-Type: application/json" --data '{
  "arguments": {
    "match": {
      "has_website": false
    },
    "limit": 100
  },
  "wait_seconds": 0
}'

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.

id (UUID): Required. Task that owns the current list.
tool (string): Required. Exact name from search-tools.
arguments (object): Optional. Use the input schema from search-tools.
wait_seconds (integer): Optional. Wait 0–45 seconds; this REST route defaults to 0.

The curl example uses filter_leads and its arguments. Use search-tools for the schema of another tool.
Run one tool at a time. Wait for the task to finish before running the next tool.
This operation has no idempotency key. Do not blindly repeat a tool after a timeout.
The list_tasks tool reads task summaries; cancel_task requires leads:write.

Response

HTTP 202. data is the task object. A background run continues after the request returns.

Example response

{
  "request_id": "6c4d0c26-8aa3-44b0-a50a-51b832b29465",
  "status": "success",
  "data": {
    "id": "73bd1ccb-1a44-4b41-84da-4ea7a5ad03f4",
    "kind": "agent",
    "status": "running",
    "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",
    "progress": {
      "stage": "filtering"
    }
  },
  "meta": {}
}

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

Read as Markdown