Skip to main content
POST
/
v1beta
/
findall
/
runs
Python
from parallel import Parallel

client = Parallel(api_key="API Key")

run_input = {
    "objective": ingest.objective,
    "entity_type": ingest.entity_type,
    "match_conditions": ingest.match_conditions,
    "generator": "base",
    "match_limit": 10,
    "metadata": {
        "run_id": "123",
    },
}

run = client.beta.findall.create(run_input)

print(f"FindAll run {run.findall_id} created, response:")
print(run.model_dump_json(indent=2))
{
  "findall_id": "findall_56ccc4d188fb41a0803a935cf485c774",
  "status": {
    "status": "queued",
    "is_active": true,
    "metrics": {
      "generated_candidates_count": 0,
      "matched_candidates_count": 0
    }
  },
  "generator": "base",
  "metadata": {},
  "created_at": "2025-09-10T21:02:08.626446Z",
  "modified_at": "2025-09-10T21:02:08.627376Z"
}

Authorizations

x-api-key
string
header
required

Headers

parallel-beta
string | null

Body

application/json

Input model for FindAll run.

objective
string
required

Natural language objective of the FindAll run.

entity_type
string
required

Type of the entity for the FindAll run.

match_conditions
MatchCondition · object[]
required

List of match conditions for the FindAll run.

generator
enum<string>
required

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

Available options:
base,
core,
pro,
preview
match_limit
integer
required

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

exclude_list
ExcludeCandidate · object[] | null

List of entity names/IDs to exclude from results.

metadata
Metadata · object

Metadata for the FindAll run.

webhook
Webhook · object

Webhook for the FindAll run.

Response

Successful Response

FindAll run object with status and metadata.

findall_id
string
required

ID of the FindAll run.

status
FindAllRunStatus · object
required

Status object for the FindAll run.

generator
enum<string>
required

Generator for the FindAll run.

Available options:
base,
core,
pro,
preview
metadata
Metadata · object

Metadata for the FindAll run.

created_at
string | null

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

modified_at
string | null

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