Skip to main content
POST
/
v1beta
/
findall
/
runs
Create Findall Run
import requests

url = "https://api.parallel.ai/v1beta/findall/runs"

payload = {
    "objective": "<string>",
    "entity_type": "<string>",
    "match_conditions": [
        {
            "name": "<string>",
            "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."
        }
    ],
    "generator": "base",
    "match_limit": 123
}
headers = {
    "x-api-key": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.json())
{
  "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
InternalMatchCondition · object[]
required

List of match conditions for the FindAll run.

generator
enum<string>
required

Generator for the FindAll run.

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

Maximum number of matches to find for this FindAll run.

exclude_list
string[] | null

List of entity names/IDs to exclude from results.

metadata
object | null

Metadata for the FindAll run.

webhook
object | null

Webhook for the FindAll run. Webhooks for Task Runs.

Response

Successful Response

FindAll run object with status and metadata.

findall_id
string
required

ID of the FindAll run.

status
object
required

Status object for the FindAll run. Status object for FindAll run.

generator
enum<string>
required

Generator for the FindAll run.

Available options:
base,
core,
pro,
preview
metadata
object | null

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.