Sign in

v19

latestOpenAPI 3.1.0raw.githubusercontent.com2026-06-084091267.1 KB
FindAll

Create FindAll Run

Starts a FindAll run.

This endpoint immediately returns a FindAll run object with status set to 'queued'. You can get the run result snapshot using the GET /v1beta/findall/runs/{findall_id}/result endpoint. You can track the progress of the run by:

  • Polling the status using the GET /v1beta/findall/runs/{findall_id} endpoint,
  • Subscribing to real-time updates via the /v1beta/findall/runs/{findall_id}/events endpoint,
  • Or specifying a webhook with relevant event types during run creation to receive notifications.
post/v1beta/findall/runs

Headers

parallel-betastring nullable

Request body

objectivestring required

Natural language objective of the FindAll run.

entity_typestring required

Type of the entity for the FindAll run.

generator'base' | 'core' | 'pro' | 'preview' required

Generator for the FindAll run. One of base, core, pro, preview.

match_limitinteger required

Maximum number of matches to find for this FindAll run. Must be between 5 and 1000 (inclusive). May return fewer results.

metadataobject nullable

Metadata for the FindAll run.

Example request

{
  "match_conditions": [
    {
      "description": "Company must have SOC2 Type II certification (not Type I). Look for evidence in: trust centers, security/compliance pages, audit reports, or press releases specifically mentioning 'SOC2 Type II'. If no explicit SOC2 Type II mention is found, consider requirement not satisfied."
    }
  ]
}

Response

Successful Response

findall_idstring required

ID of the FindAll run.

generator'base' | 'core' | 'pro' | 'preview' required

Generator for the FindAll run.

metadataobject nullable

Metadata for the FindAll run.

created_atstring nullable

Timestamp of the creation of the run, in RFC 3339 format.

modified_atstring nullable

Timestamp of the latest modification to the FindAll run result, in RFC 3339 format.