# AI Scout from your code (/docs/leads/ai-scout/api)

Authenticated with `?privateKey=YOUR_KEY` (see [Authentication](/docs/authentication)).

<Endpoints ops={["GET /v3/ai-scouts", "POST /v3/ai-scouts/plan", "POST /v3/ai-scouts", "GET /v3/ai-scouts/{scoutId}", "PATCH /v3/ai-scouts/{scoutId}", "POST /v3/ai-scouts/{scoutId}/pause", "POST /v3/ai-scouts/{scoutId}/resume", "POST /v3/ai-scouts/{scoutId}/run", "DELETE /v3/ai-scouts/{scoutId}", "PUT /v3/ai-scouts/daily-limit"]} />

<ApiPlayground
  method="get"
  path="/v3/ai-scouts"
  tool="list_ai_scouts"
  args={`{
  "websiteId": "64b7f0a1c2d3e4f5a6b7c8d9"
}`}
/>

## Use case: Plan first, then create [#use-case-plan-first-then-create]

`POST /v3/ai-scouts/plan` with a `description` returns the name and sources it would use, free. Send the same description (and the sources you kept) to `POST /v3/ai-scouts`.

## Use case: Keep spend in check [#use-case-keep-spend-in-check]

`PUT /v3/ai-scouts/daily-limit` caps the leads per day across all scouts of the website; `perDay` caps each scout.

## Use case: Pause on Friday, resume on Monday [#use-case-pause-on-friday-resume-on-monday]

`POST /v3/ai-scouts/{scoutId}/pause` and `/resume` from your scheduler.