For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
GuidesAPI Reference
GuidesAPI Reference
  • Overview
    • API reference
  • Search
    • POSTSearch
    • GETSearch Run List
    • GETSearch Run Get
    • GETSearch Run Events
    • POSTSearch Run Cancel
  • Extract
    • GETExtract a URL
    • POSTExtract
  • Monitors
    • GETList monitors
    • POSTCreate monitor
    • GETRetrieve monitor
    • DELDelete monitor
    • PATCHUpdate monitor
    • GETList monitor events
    • POSTMonitor Pause
    • POSTMonitor Resume
    • POSTRun monitor
  • Tasks
    • POSTTask
    • POSTCreate task run
    • GETRetrieve task run
    • GETStream task run events
    • GETTask List
    • GETTask Get
    • GETTask Events
    • POSTTask Cancel
  • Chat
    • POSTChat completion
  • Find All
    • POSTFindAll
    • GETFindall Run List
    • POSTCreate FindAll run
    • GETRetrieve FindAll run
    • GETStream FindAll run events
    • POSTCancel FindAll run
    • POSTExtend FindAll run
    • POSTEnrich FindAll run
LogoLogo
Find All

Enrich FindAll run

||View as Markdown|
POST
https://core.usescout.sh/v1/findall/runs/:findall_id/enrich
POST
/v1/findall/runs/:findall_id/enrich
$curl -X POST https://core.usescout.sh/v1/findall/runs/findall_id/enrich \
> -H "Authorization: Bearer <token>" \
> -H "Content-Type: application/json" \
> -d '{
> "fields": [
> "employee_count",
> "founded_year"
> ]
>}'
1{
2 "findall_id": "fa-37e97d4654d14fa6ad2fb342",
3 "status": null,
4 "query": "S-1 stage AI infrastructure companies",
5 "entities": [
6 {
7 "name": "CoreWeave",
8 "website": "https://coreweave.com",
9 "headquarters": "Livingston, New Jersey",
10 "source": "https://en.wikipedia.org/wiki/CoreWeave"
11 },
12 {
13 "name": "Lambda",
14 "website": "https://lambdalabs.com",
15 "headquarters": "San Francisco, California",
16 "source": "https://lambdalabs.com/about"
17 }
18 ],
19 "count": 2,
20 "credits": 7,
21 "fields": [
22 "name",
23 "website",
24 "headquarters"
25 ],
26 "createdAt": "2025-01-20T14:10:02+00:00",
27 "completedAt": "2025-01-20T14:11:39+00:00"
28}

Enrich a completed run - research and add new data to every entity already found, as plain fields or against a JSON Schema. Returns the run re-queued; poll or stream it.

Was this page helpful?
Previous

Extend FindAll run

Built with

Authentication

AuthorizationBearer
Your API key, sent as a Bearer token.

Path parameters

findall_idstringRequired

Request

This endpoint expects an object.
fieldslist of strings or nullOptional
New data field names to add to every found entity.
output_schemamap from strings to any or nullOptional

JSON Schema each enriched entity must conform to. Takes precedence over fields. One of fields or output_schema is required.

Response

Successful Response
findall_idstring
Opaque run identifier.
statusany

String for back-compat (queued/running/completed/failed/cancelled) OR the rich Parallel-style status object when the run has completed.

querystring
The enumeration query.
entitieslist of maps from strings to any

Entities found so far (flat rows; back-compat).

countinteger
Number of entities found.
creditsinteger
Cost accumulated by the run.
fieldslist of strings or null
The requested entity fields, if any.
output_schemamap from strings to any or null
The JSON Schema for entity objects, if any.
candidateslist of maps from strings to any or null
Rich candidates once the run has completed.
metadatamap from strings to any or null

Run metadata: {title, input}.

findall_schemamap from strings to any or null

Schema spec: objective, conditions, generator.

errorstring or null
Failure reason when status is failed.
createdAtstring or null

ISO-8601 created.

completedAtstring or null

ISO-8601 finished.

Errors

422
Unprocessable Entity Error