AI Scout
Describe who to find; a scout reads Google, YouTube and review sites every day and adds the people who fit as leads.
Create and manage AI Scouts from your own code: plan one for free, create it, run it now, pause it, and cap what all scouts may spend in a day. Authenticated with ?privateKey=YOUR_KEY (see Authentication).
| GET | /v3/ai-scouts | List AI Scouts |
| POST | /v3/ai-scouts/plan | Plan an AI Scout |
| POST | /v3/ai-scouts | Create an AI Scout |
| GET | /v3/ai-scouts/{scoutId} | Get an AI Scout |
| PATCH | /v3/ai-scouts/{scoutId} | Update an AI Scout |
| POST | /v3/ai-scouts/{scoutId}/pause | Pause an AI Scout |
| POST | /v3/ai-scouts/{scoutId}/resume | Resume an AI Scout |
| POST | /v3/ai-scouts/{scoutId}/run | Run an AI Scout now |
| DELETE | /v3/ai-scouts/{scoutId} | Delete an AI Scout |
| PUT | /v3/ai-scouts/daily-limit | Set the AI Scout daily limit |
/v3/ai-scoutscurl -X GET "https://rest-dash.revealid.xyz/v3/ai-scouts?privateKey=YOUR_KEY&websiteId=64b7f0a1c2d3e4f5a6b7c8d9"What each field accepts
| Field | Type | Limits and format | Accepted values |
|---|---|---|---|
| websiteId* | string | — | any |
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 with perDay (10, 25, 50 or 100) and minFit (10 to 95, default 70). The first run starts right away, 1 credit per person.
Use case: Keep spend in check
PUT /v3/ai-scouts/daily-limit with { "websiteId": …, "dailyLimit": 100 } caps the leads per day across all scouts of the website (1 to 500); perDay caps each scout. The response tells you how many were used and are left today.
Use case: Pause on Friday, resume on Monday
POST /v3/ai-scouts/{scoutId}/pause and /resume from your scheduler.