Skip to main content
POST
/
v1beta
/
findall
/
runs
/
{findall_id}
/
enrich
Add Enrichment to FindAll Run
import requests

url = "https://api.parallel.ai/v1beta/findall/runs/{findall_id}/enrich"

payload = {
    "processor": "base",
    "enrichment_output_schema": {
        "json_schema": {
            "additionalProperties": False,
            "properties": { "gdp": {
                    "description": "GDP in USD for the year, formatted like '$3.1 trillion (2023)'",
                    "type": "string"
                } },
            "required": ["gdp"],
            "type": "object"
        },
        "type": "json"
    }
}
headers = {
    "x-api-key": "<api-key>",
    "Content-Type": "application/json"
}

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

print(response.json())
"<any>"

Authorizations

x-api-key
string
header
required

Path Parameters

findall_id
string
required

Body

application/json

Input model for FindAll enrich.

processor
string
required

Processor to use for the task.

Examples:

"base"

enrichment_output_schema
object
required

JSON schema for the enrichment output schema for the FindAll run. JSON schema for a task input or output.

metadata
object | null

User-provided metadata stored with the run. Keys and values must be strings with a maximum length of 16 and 512 characters respectively.

source_policy
object | null

Optional source policy governing preferred and disallowed domains in web search results. Source policy for web search results.

This policy governs which sources are allowed/disallowed in results.

mcp_servers
McpServer · object[] | null

Optional list of MCP servers to use for the run. To enable this feature in your requests, specify mcp-server-2025-07-17 as one of the values in parallel-beta header (for API calls) or betas param (for the SDKs).

enable_events
boolean | null

Controls tracking of task run execution progress. When set to true, progress events are recorded and can be accessed via the Task Run events endpoint. When false, no progress events are tracked. Note that progress tracking cannot be enabled after a run has been created. The flag is set to true by default for premium processors (pro and above). To enable this feature in your requests, specify events-sse-2025-07-24 as one of the values in parallel-beta header (for API calls) or betas param (for the SDKs).

webhook
object | null

Callback URL (webhook endpoint) that will receive an HTTP POST when the run completes. This feature is not available via the Python SDK. To enable this feature in your API requests, specify the parallel-beta header with webhook-2025-08-12 value. Webhooks for Task Runs.

Response

Successful Response

The response is of type any.