openapi: 3.1.0 info: title: Parallel Chat API (Beta) Chat API (Beta) FindAll API description: Parallel API contact: name: Parallel Support url: https://parallel.ai email: support@parallel.ai version: 0.1.2 servers: - url: https://api.parallel.ai description: Parallel API security: - ApiKeyAuth: [] tags: - name: FindAll description: The FindAll API discovers and evaluates entities that match complex criteria from natural language objectives. Submit a high-level goal and the service automatically generates structured match conditions, discovers relevant candidates, and evaluates each against the criteria. Returns comprehensive results with detailed reasoning, citations, and confidence scores for each match decision. Streaming events and webhooks are supported. paths: /v1beta/findall/entity-search: post: tags: - FindAll summary: Fast Entity Search description: 'Return ranked entities matching a natural language objective. This endpoint performs a best-effort search optimized for low latency. To keep responses fast, it returns a fixed set of attributes and supports queries of limited complexity. For comprehensive match evaluation and enrichment, use the [FindAll API](https://docs.parallel.ai/findall-api/findall-quickstart).' operationId: findall_entity_search_v1beta_findall_entity_search_post requestBody: content: application/json: schema: $ref: '#/components/schemas/FindAllEntitySearchRequest' required: true responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/FindAllEntitySearchResponse' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' x-code-samples: - lang: Python source: "from parallel import Parallel\n\nclient = Parallel()\n\nresponse = client.beta.findall.entity_search(\n entity_type=\"companies\",\n objective=\"AI startups that raised Series A in 2024\",\n match_limit=100,\n)\n\nfor entity in response.entities:\n print(f\"{entity.name}: {entity.url}\")" - lang: TypeScript source: "import Parallel from \"parallel-web\";\n\nconst client = new Parallel();\n\nconst response = await client.beta.findall.entity_search({\n entity_type: \"companies\",\n objective: \"AI startups that raised Series A in 2024\",\n match_limit: 100,\n});\n\nfor (const entity of response.entities) {\n console.log(`${entity.name}: ${entity.url}`);\n}" /v1beta/findall/ingest: post: tags: - FindAll summary: Ingest FindAll Run description: 'Transforms a natural language search objective into a structured FindAll spec. The generated specification serves as a suggested starting point and can be further customized by the user.' operationId: ingest_findall_run_v1beta_findall_ingest_post parameters: - name: parallel-beta in: header required: false schema: anyOf: - type: string - type: 'null' deprecated: true title: Parallel-Beta x-stainless-override-schema: x-stainless-param: betas x-stainless-extend-default: true type: array description: Optional header to specify the beta version(s) to enable. items: $ref: '#/components/schemas/ParallelBeta' deprecated: true requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/IngestInput' responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/FindAllSchema' example: objective: Find all AI companies that raised Series A funding in 2024 entity_type: companies match_conditions: - name: developing_ai_products_check description: Company must be developing artificial intelligence (AI) products - name: raised_series_a_2024_check description: Company must have raised Series A funding in 2024 generator: core '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' x-code-samples: - lang: Python source: "from parallel import Parallel\n\nclient = Parallel()\n\nobjective = \"Find all portfolio companies of Khosla Ventures founded after 2020 and CEO names\"\n\ningest = client.beta.findall.ingest(\n objective=objective,\n)\n\nprint(ingest.model_dump_json(indent=2))" - lang: TypeScript source: "import Parallel from \"parallel-web\";\n\nconst client = new Parallel();\n\nconst objective = 'Find all portfolio companies of Khosla Ventures founded after 2020 and CEO names';\n\nconst ingest = await client.beta.findall.ingest({\n objective: objective,\n});\n\nconsole.log(JSON.stringify(ingest, null, 2));" /v1beta/findall/runs: post: tags: - FindAll summary: Create FindAll Run description: '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.' operationId: findall_runs_v1_v1beta_findall_runs_post parameters: - name: parallel-beta in: header required: false schema: anyOf: - type: string - type: 'null' deprecated: true title: Parallel-Beta x-stainless-override-schema: x-stainless-param: betas x-stainless-extend-default: true type: array description: Optional header to specify the beta version(s) to enable. items: $ref: '#/components/schemas/ParallelBeta' deprecated: true requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/FindAllRunInput' responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/FindAllRun' example: 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' '402': description: 'Payment required: insufficient credit in account' content: application/json: example: type: error error: ref_id: fcb2b4f3-c75e-4186-87bc-caa1a8381331 message: 'Payment required: insufficient credit in account' schema: $ref: '#/components/schemas/ErrorResponse' '422': description: 'Unprocessable content: request validation error' content: application/json: example: type: error error: ref_id: fcb2b4f3-c75e-4186-87bc-caa1a8381331 message: 'Unprocessable content: request validation error' schema: $ref: '#/components/schemas/ErrorResponse' '429': description: 'Too many requests: quota temporarily exceeded' content: application/json: example: type: error error: ref_id: fcb2b4f3-c75e-4186-87bc-caa1a8381331 message: 'Too many requests: quota temporarily exceeded' schema: $ref: '#/components/schemas/ErrorResponse' x-code-samples: - lang: Python source: "from parallel import Parallel\n\nclient = Parallel()\n\n# Use the output from the ingest step, or provide your own values\ningest = client.beta.findall.ingest(\n objective=\"Find all AI companies that raised Series A funding in 2024\",\n)\n\nrun = client.beta.findall.create(\n objective=ingest.objective,\n entity_type=ingest.entity_type,\n match_conditions=[mc.model_dump() for mc in ingest.match_conditions],\n generator=\"base\",\n match_limit=10,\n)\n\nprint(f\"FindAll run {run.findall_id} created, response:\")\nprint(run.model_dump_json(indent=2))" - lang: TypeScript source: "import Parallel from \"parallel-web\";\n\nconst client = new Parallel();\n\n// Use the output from the ingest step, or provide your own values\nconst ingest = await client.beta.findall.ingest({\n objective: \"Find all AI companies that raised Series A funding in 2024\",\n});\n\nconst run = await client.beta.findall.create({\n objective: ingest.objective,\n entity_type: ingest.entity_type,\n match_conditions: ingest.match_conditions,\n generator: \"base\",\n match_limit: 10,\n});\n\nconsole.log(`FindAll run ${run.findall_id} created, response:`);\nconsole.log(JSON.stringify(run, null, 2));" /v1beta/findall/runs/{findall_id}: get: tags: - FindAll summary: Retrieve FindAll Run Status description: Retrieve a FindAll run. operationId: findall_runs_v1_get_v1beta_findall_runs__findall_id__get parameters: - name: findall_id in: path required: true schema: type: string title: Findall Id - name: parallel-beta in: header required: false schema: anyOf: - type: string - type: 'null' deprecated: true title: Parallel-Beta x-stainless-override-schema: x-stainless-param: betas x-stainless-extend-default: true type: array description: Optional header to specify the beta version(s) to enable. items: $ref: '#/components/schemas/ParallelBeta' deprecated: true responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/FindAllRun' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' x-code-samples: - lang: Python source: "from parallel import Parallel\n\nclient = Parallel()\n\nrun = client.beta.findall.retrieve(\n findall_id=\"findall_56ccc4d188fb41a0803a935cf485c774\",\n)\n\nprint(f\"FindAll run {run.findall_id} status: {run.status.status}\")" - lang: TypeScript source: 'import Parallel from "parallel-web"; const client = new Parallel(); const run = await client.beta.findall.retrieve("findall_56ccc4d188fb41a0803a935cf485c774"); console.log(`FindAll run ${run.findall_id} status: ${run.status.status}`);' /v1beta/findall/runs/{findall_id}/cancel: post: tags: - FindAll summary: Cancel FindAll Run description: Cancel a FindAll run. operationId: cancel_findall_run_v1beta_findall_runs__findall_id__cancel_post parameters: - name: findall_id in: path required: true schema: type: string title: Findall Id - name: parallel-beta in: header required: false schema: anyOf: - type: string - type: 'null' deprecated: true title: Parallel-Beta x-stainless-override-schema: x-stainless-param: betas x-stainless-extend-default: true type: array description: Optional header to specify the beta version(s) to enable. items: $ref: '#/components/schemas/ParallelBeta' deprecated: true responses: '204': description: FindAll run cancelled successfully. '404': description: FindAll run not found content: application/json: example: type: error error: ref_id: fcb2b4f3-c75e-4186-87bc-caa1a8381331 message: FindAll run not found schema: $ref: '#/components/schemas/ErrorResponse' '409': description: Cannot cancel a terminated FindAll run content: application/json: example: type: error error: ref_id: fcb2b4f3-c75e-4186-87bc-caa1a8381331 message: Cannot cancel a terminated FindAll run schema: $ref: '#/components/schemas/ErrorResponse' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' x-code-samples: - lang: Python source: "from parallel import Parallel\n\nclient = Parallel()\n\nclient.beta.findall.cancel(\n findall_id=\"findall_56ccc4d188fb41a0803a935cf485c774\",\n)\n\nprint(\"FindAll run cancelled.\")" - lang: TypeScript source: 'import Parallel from "parallel-web"; const client = new Parallel(); await client.beta.findall.cancel("findall_56ccc4d188fb41a0803a935cf485c774"); console.log("FindAll run cancelled.");' /v1beta/findall/runs/{findall_id}/enrich: post: tags: - FindAll summary: Add Enrichment to FindAll Run description: Add an enrichment to a FindAll run. operationId: enrich_findall_run_v1beta_findall_runs__findall_id__enrich_post parameters: - name: findall_id in: path required: true schema: type: string title: Findall Id - name: parallel-beta in: header required: false schema: anyOf: - type: string - type: 'null' deprecated: true title: Parallel-Beta x-stainless-override-schema: x-stainless-param: betas x-stainless-extend-default: true type: array description: Optional header to specify the beta version(s) to enable. items: $ref: '#/components/schemas/ParallelBeta' deprecated: true requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/FindAllEnrichInput' responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/FindAllSchema' example: objective: Find all AI companies that raised Series A funding in 2024 entity_type: companies match_conditions: - name: developing_ai_products_check description: Company must be developing artificial intelligence (AI) products enrichments: - processor: core output_schema: json_schema: type: object properties: ceo_name: type: string description: Name of the current CEO of the company. If the CEO is not publicly known, provide the name of the highest-ranking executive or founder. If no information is available, return null. type: json generator: core match_limit: 50 '404': description: FindAll run not found content: application/json: example: type: error error: ref_id: fcb2b4f3-c75e-4186-87bc-caa1a8381331 message: FindAll run not found schema: $ref: '#/components/schemas/ErrorResponse' '422': description: Validation error content: application/json: example: type: error error: ref_id: fcb2b4f3-c75e-4186-87bc-caa1a8381331 message: Validation error schema: $ref: '#/components/schemas/ErrorResponse' x-code-samples: - lang: Python source: "from parallel import Parallel\n\nclient = Parallel()\n\n# Tip: If using Pydantic models, you can generate the schema automatically:\n# class CompanyEnrichment(BaseModel):\n# ceo_name: str = Field(description=\"Name of the CEO\")\n# founding_year: str = Field(description=\"Year the company was founded\")\n# output_schema = {\"type\": \"json\", \"json_schema\": CompanyEnrichment.model_json_schema()}\n\nschema = client.beta.findall.enrich(\n findall_id=\"findall_40e0ab8c10754be0b7a16477abb38a2f\",\n processor=\"core\",\n output_schema={\n \"type\": \"json\",\n \"json_schema\": {\n \"type\": \"object\",\n \"properties\": {\n \"ceo_name\": {\n \"type\": \"string\",\n \"description\": \"Name of the CEO\"\n },\n \"founding_year\": {\n \"type\": \"string\",\n \"description\": \"Year the company was founded\"\n }\n },\n \"required\": [\"ceo_name\", \"founding_year\"],\n \"additionalProperties\": False\n }\n }\n)\n\nprint(f\"Enrichment added, schema: {schema.model_dump_json(indent=2)}\")" - lang: TypeScript source: "import Parallel from \"parallel-web\";\n\nconst client = new Parallel();\n\nconst schema = await client.beta.findall.enrich(\n \"findall_40e0ab8c10754be0b7a16477abb38a2f\",\n {\n processor: \"core\",\n output_schema: {\n type: \"json\",\n json_schema: {\n type: \"object\",\n properties: {\n ceo_name: {\n type: \"string\",\n description: \"Name of the CEO\"\n },\n founding_year: {\n type: \"string\",\n description: \"Year the company was founded\"\n }\n },\n required: [\"ceo_name\", \"founding_year\"],\n additionalProperties: false\n }\n }\n }\n);\n\nconsole.log(`Enrichment added, schema: ${JSON.stringify(schema, null, 2)}`);" /v1beta/findall/runs/{findall_id}/events: get: tags: - FindAll summary: Stream FindAll Events description: "Stream events from a FindAll run.\n\nArgs:\n request: The Shapi request\n findall_id: The FindAll run ID\n last_event_id: Optional event ID to resume from.\n timeout: Optional timeout in seconds. If None, keep connection alive\n as long as the run is going. If set, stop after specified duration." operationId: get_findall_events_v1beta_findall_runs__findall_id__events_get parameters: - name: findall_id in: path required: true schema: type: string title: Findall Id - name: last_event_id in: query required: false schema: anyOf: - type: string - type: 'null' title: Last Event Id - name: timeout in: query required: false schema: anyOf: - type: number - type: 'null' title: Timeout - name: parallel-beta in: header required: false schema: anyOf: - type: string - type: 'null' deprecated: true title: Parallel-Beta x-stainless-override-schema: x-stainless-param: betas x-stainless-extend-default: true type: array description: Optional header to specify the beta version(s) to enable. items: $ref: '#/components/schemas/ParallelBeta' deprecated: true responses: '200': description: Successful Response content: text/event-stream: schema: oneOf: - $ref: '#/components/schemas/FindAllSchemaUpdatedEvent' - $ref: '#/components/schemas/FindAllRunStatusEvent' - $ref: '#/components/schemas/FindAllCandidateMatchStatusEvent' - $ref: '#/components/schemas/ErrorEvent' discriminator: propertyName: type mapping: findall.schema.updated: '#/components/schemas/FindAllSchemaUpdatedEvent' findall.status: '#/components/schemas/FindAllRunStatusEvent' findall.candidate.generated: '#/components/schemas/FindAllCandidateMatchStatusEvent' findall.candidate.matched: '#/components/schemas/FindAllCandidateMatchStatusEvent' findall.candidate.unmatched: '#/components/schemas/FindAllCandidateMatchStatusEvent' findall.candidate.discarded: '#/components/schemas/FindAllCandidateMatchStatusEvent' findall.candidate.enriched: '#/components/schemas/FindAllCandidateMatchStatusEvent' error: '#/components/schemas/ErrorEvent' title: Response 200 Get Findall Events V1Beta Findall Runs Findall Id Events Get example: type: findall.candidate.generated timestamp: '2025-09-10T21:02:08.626446Z' event_id: 56cee734dbc84172bfc491327f2a0183 data: candidate_id: candidate_52e1e30b-4e0a-49d8-82eb-79e64e0ed015 name: Pika url: pika.art description: Pika is an AI video generation platform that creates and edits videos from text prompts or images. match_status: generated '404': description: FindAll run not found content: application/json: example: type: error error: ref_id: fcb2b4f3-c75e-4186-87bc-caa1a8381331 message: FindAll run not found schema: $ref: '#/components/schemas/ErrorResponse' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' x-code-samples: - lang: Python source: "from parallel import Parallel\n\nclient = Parallel()\n\n# Event types: findall.candidate.generated, findall.candidate.matched,\n# findall.candidate.unmatched, findall.candidate.discarded,\n# findall.candidate.enriched\nevents = client.beta.findall.events(\n findall_id=\"findall_56ccc4d188fb41a0803a935cf485c774\",\n)\n\nfor event in events:\n print(f\"Event [{event.type}]: {event.model_dump_json()}\")" - lang: TypeScript source: "import Parallel from \"parallel-web\";\n\nconst client = new Parallel();\n\n// Event types: findall.candidate.generated, findall.candidate.matched,\n// findall.candidate.unmatched, findall.candidate.discarded,\n// findall.candidate.enriched\nconst events = await client.beta.findall.events(\"findall_56ccc4d188fb41a0803a935cf485c774\");\n\nfor await (const event of events) {\n console.log(`Event [${event.type}]: ${JSON.stringify(event)}`);\n}" /v1beta/findall/runs/{findall_id}/extend: post: tags: - FindAll summary: Extend FindAll Run description: Extend a FindAll run by adding additional matches to the current match limit. operationId: extend_findall_run_v1beta_findall_runs__findall_id__extend_post parameters: - name: findall_id in: path required: true schema: type: string title: Findall Id - name: parallel-beta in: header required: false schema: anyOf: - type: string - type: 'null' deprecated: true title: Parallel-Beta x-stainless-override-schema: x-stainless-param: betas x-stainless-extend-default: true type: array description: Optional header to specify the beta version(s) to enable. items: $ref: '#/components/schemas/ParallelBeta' deprecated: true requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/FindAllExtendInput' responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/FindAllSchema' example: objective: Find all AI companies that raised Series A funding in 2024 entity_type: companies match_conditions: - name: developing_ai_products_check description: Company must be developing artificial intelligence (AI) products enrichments: - processor: core output_schema: json_schema: type: object properties: ceo_name: type: string description: Name of the current CEO of the company. If the CEO is not publicly known, provide the name of the highest-ranking executive or founder. If no information is available, return null. type: json generator: core match_limit: 50 '404': description: FindAll run not found content: application/json: example: type: error error: ref_id: fcb2b4f3-c75e-4186-87bc-caa1a8381331 message: FindAll run not found schema: $ref: '#/components/schemas/ErrorResponse' '422': description: Additional match limit must be greater than 0 content: application/json: example: type: error error: ref_id: fcb2b4f3-c75e-4186-87bc-caa1a8381331 message: Additional match limit must be greater than 0 schema: $ref: '#/components/schemas/ErrorResponse' x-code-samples: - lang: Python source: "from parallel import Parallel\n\nclient = Parallel()\n\nschema = client.beta.findall.extend(\n findall_id=\"findall_56ccc4d188fb41a0803a935cf485c774\",\n additional_match_limit=10,\n)\n\nprint(f\"FindAll run extended: {schema.model_dump_json(indent=2)}\")" - lang: TypeScript source: "import Parallel from \"parallel-web\";\n\nconst client = new Parallel();\n\nconst schema = await client.beta.findall.extend(\n \"findall_56ccc4d188fb41a0803a935cf485c774\",\n {\n additional_match_limit: 10,\n }\n);\n\nconsole.log(`FindAll run extended: ${JSON.stringify(schema, null, 2)}`);" /v1beta/findall/runs/{findall_id}/result: get: tags: - FindAll summary: FindAll Run Result description: Retrieve the FindAll run result at the time of the request. operationId: get_findall_result_v1beta_findall_runs__findall_id__result_get parameters: - name: findall_id in: path required: true schema: type: string title: Findall Id - name: parallel-beta in: header required: false schema: anyOf: - type: string - type: 'null' deprecated: true title: Parallel-Beta x-stainless-override-schema: x-stainless-param: betas x-stainless-extend-default: true type: array description: Optional header to specify the beta version(s) to enable. items: $ref: '#/components/schemas/ParallelBeta' deprecated: true responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/FindAllRunResult' example: run: findall_id: findall_56ccc4d188fb41a0803a935cf485c774 status: status: running is_active: true metrics: generated_candidates_count: 1 matched_candidates_count: 1 generator: base metadata: {} created_at: '2025-09-10T21:02:08.626446Z' modified_at: '2025-09-10T21:02:08.627376Z' candidates: - candidate_id: candidate_7594eb7c-4f4a-487f-9d0c-9d1e63ec240c name: Cognition AI url: cognition.ai match_status: matched output: developing_ai_products_check: 'yes' raised_series_a_2024_check: 'yes' basis: - field: developing_ai_products_check citations: - title: Cognition - Devin and Cognition AI url: https://cognition.ai/ excerpts: - We're the makers of Devin, a collaborative AI teammate that helps ambitious engineering teams achieve more. - An applied AI lab building the future of software engineering - Cognition reasoning: The search results repeatedly state that Cognition AI is an 'applied AI lab building the future of software engineering' and that they developed 'Devin AI', described as the 'world's first AI software engineer'. This directly confirms they are developing AI products. confidence: high - field: raised_series_a_2024_check citations: - title: Cognition Labs Raises $21 Million Series A to Support AI Coding Products url: https://voicebot.ai/2024/04/25/cognition-labs-raises-21-million-series-a-to-support-ai-coding-products/ excerpts: - Cognition Labs Raises $21 Million Series A to Support AI Coding Products reasoning: The article from voicebot.ai, dated April 25, 2024, states that Founders Fund led a "$21 million Series A investment" for Cognition Labs. This confirms that Series A funding was raised in 2024. confidence: low '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' x-code-samples: - lang: Python source: "from parallel import Parallel\n\nclient = Parallel()\n\nrun_result = client.beta.findall.result(\n findall_id=\"findall_56ccc4d188fb41a0803a935cf485c774\",\n)\n\nprint(f\"FindAll run {run_result.run.findall_id} result: {run_result.model_dump_json(indent=2)}\")" - lang: TypeScript source: 'import Parallel from "parallel-web"; const client = new Parallel(); const runResult = await client.beta.findall.result("findall_56ccc4d188fb41a0803a935cf485c774"); console.log(`FindAll run ${runResult.run.findall_id} result: ${JSON.stringify(runResult, null, 2)}`);' /v1beta/findall/runs/{findall_id}/schema: get: tags: - FindAll summary: Get FindAll Run Schema operationId: get_findall_schema_v1beta_findall_runs__findall_id__schema_get parameters: - name: findall_id in: path required: true schema: type: string title: Findall Id - name: parallel-beta in: header required: false schema: anyOf: - type: string - type: 'null' deprecated: true title: Parallel-Beta x-stainless-override-schema: x-stainless-param: betas x-stainless-extend-default: true type: array description: Optional header to specify the beta version(s) to enable. items: $ref: '#/components/schemas/ParallelBeta' deprecated: true responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/FindAllSchema' example: objective: Find all AI companies that raised Series A funding in 2024 entity_type: companies match_conditions: - name: developing_ai_products_check description: Company must be developing artificial intelligence (AI) products enrichments: - processor: core output_schema: json_schema: type: object properties: ceo_name: type: string description: Name of the current CEO of the company. If the CEO is not publicly known, provide the name of the highest-ranking executive or founder. If no information is available, return null. type: json generator: core match_limit: 50 '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' x-code-samples: - lang: Python source: "from parallel import Parallel\n\nclient = Parallel()\n\nschema = client.beta.findall.schema(\n findall_id=\"findall_56ccc4d188fb41a0803a935cf485c774\",\n)\n\nprint(f\"Schema: {schema.model_dump_json(indent=2)}\")" - lang: TypeScript source: 'import Parallel from "parallel-web"; const client = new Parallel(); const schema = await client.beta.findall.schema("findall_56ccc4d188fb41a0803a935cf485c774"); console.log(`Schema: ${JSON.stringify(schema, null, 2)}`);' components: schemas: FindAllEntitySearchResponse: properties: entity_set_id: type: string title: Entity Set Id description: 'Entity set request ID. Example: `entity_set_cad0a6d2dec046bd95ae900527d880e7`' entities: items: $ref: '#/components/schemas/EntityItem' type: array title: Entities description: Ranked list of entities. type: object required: - entity_set_id - entities title: FindAllEntitySearchResponse FindAllSchema: properties: objective: type: string title: Objective description: Natural language objective of the FindAll run. examples: - Find all AI companies that raised Series A funding in 2024 entity_type: type: string title: Entity Type description: Type of the entity for the FindAll run. match_conditions: items: $ref: '#/components/schemas/MatchCondition' type: array title: Match Conditions description: List of match conditions for the FindAll run. enrichments: anyOf: - items: $ref: '#/components/schemas/FindAllEnrichInput' type: array - type: 'null' title: Enrichments description: List of enrichment inputs for the FindAll run. generator: type: string enum: - base - core - pro - preview title: Generator description: The generator of the FindAll run. default: core match_limit: anyOf: - type: integer - type: 'null' title: Match Limit description: Max number of candidates to evaluate type: object required: - objective - entity_type - match_conditions title: FindAllSchema description: Response model for FindAll ingest. FindAllEnrichInput: properties: processor: type: string title: Processor description: Processor to use for the task. default: core output_schema: $ref: '#/components/schemas/JsonSchema' description: JSON schema for the enrichment output schema for the FindAll run. mcp_servers: anyOf: - items: $ref: '#/components/schemas/McpServer' type: array - type: 'null' title: Mcp Servers description: List of MCP servers to use for the task. type: object required: - output_schema title: FindAllEnrichInput description: Input model for FindAll enrich. FindAllEntitySearchRequest: properties: entity_type: type: string enum: - people - companies title: Entity Type description: Type of entity to search for. objective: type: string title: Objective description: Natural language description of target entities. match_limit: type: integer maximum: 1000 minimum: 5 title: Match Limit description: Maximum number of entities to return. Must be between 5 and 1000 (inclusive). May return fewer results. Defaults to 100. default: 100 type: object required: - entity_type - objective title: FindAllEntitySearchRequest FindAllRunResult: properties: run: $ref: '#/components/schemas/FindAllRun' description: FindAll run object. candidates: items: $ref: '#/components/schemas/FindAllCandidate' type: array title: Candidates description: All evaluated candidates at the time of the snapshot. last_event_id: anyOf: - type: string - type: 'null' title: Last Event Id description: ID of the last event of the run at the time of the request. This can be used to resume streaming from the last event. type: object required: - run - candidates title: FindAllRunResult description: 'Complete FindAll search results. Represents a snapshot of a FindAll run, including run metadata and a list of candidate entities with their match status and details at the time the snapshot was taken.' FindAllRun: properties: findall_id: type: string title: FindAll ID description: ID of the FindAll run. status: $ref: '#/components/schemas/FindAllRunStatus' description: Status object for the FindAll run. generator: type: string enum: - base - core - pro - preview title: Generator description: Generator for the FindAll run. metadata: anyOf: - additionalProperties: anyOf: - type: string - type: integer - type: number - type: boolean type: object - type: 'null' title: Metadata description: Metadata for the FindAll run. created_at: anyOf: - type: string - type: 'null' title: Created At description: Timestamp of the creation of the run, in RFC 3339 format. modified_at: anyOf: - type: string - type: 'null' title: Modified At description: Timestamp of the latest modification to the FindAll run result, in RFC 3339 format. type: object required: - findall_id - status - generator title: FindAllRun description: FindAll run object with status and metadata. HTTPValidationError: properties: detail: items: $ref: '#/components/schemas/ValidationError' type: array title: Detail type: object title: HTTPValidationError ParallelBeta: anyOf: - enum: - mcp-server-2025-07-17 - events-sse-2025-07-24 - webhook-2025-08-12 - findall-2025-09-15 - search-extract-2025-10-10 - field-basis-2025-11-25 type: string - type: string description: Model for the parallel-beta header. title: ParallelBeta FindAllCandidateMetrics: properties: generated_candidates_count: type: integer title: Generated Candidates Count description: Number of candidates that were selected. default: 0 matched_candidates_count: type: integer title: Matched Candidates Count description: Number of candidates that evaluated to matched. default: 0 type: object title: FindAllCandidateMetrics description: Metrics object for FindAll run. FindAllCandidateMatchStatusEvent: properties: type: type: string enum: - findall.candidate.generated - findall.candidate.matched - findall.candidate.unmatched - findall.candidate.discarded - findall.candidate.enriched title: Type description: Event type; one of findall.candidate.generated, findall.candidate.matched, findall.candidate.unmatched, findall.candidate.discarded, findall.candidate.enriched. timestamp: type: string format: date-time title: Timestamp description: Timestamp of the event. event_id: type: string title: Event Id description: Unique event identifier for the event. data: $ref: '#/components/schemas/FindAllCandidate' description: The candidate whose match status has been updated. type: object required: - type - timestamp - event_id - data title: FindAllCandidateMatchStatusEvent description: Event containing a candidate whose match status has changed. McpServer: properties: type: type: string const: url title: Type description: Type of MCP server being configured. Always `url`. default: url url: type: string title: Url description: URL of the MCP server. headers: anyOf: - additionalProperties: type: string format: password writeOnly: true type: object - type: 'null' title: Headers description: Headers for the MCP server. name: type: string title: Name description: Name of the MCP server. allowed_tools: anyOf: - items: type: string type: array - type: 'null' title: Allowed Tools description: List of allowed tools for the MCP server. type: object required: - url - name title: McpServer description: MCP server configuration. ExcludeCandidate: properties: name: type: string title: Name description: Name of the entity to exclude from results. url: type: string title: Url description: URL of the entity to exclude from results. type: object required: - name - url title: ExcludeCandidate description: Exclude candidate input model for FindAll run. FindAllExtendInput: properties: additional_match_limit: type: integer title: Additional Match Limit description: Additional number of matches to find for this FindAll run. This value will be added to the current match limit to determine the new total match limit. Must be greater than 0. type: object required: - additional_match_limit title: FindAllExtendInput description: Input model for FindAll extend. FieldBasis: description: Citations and reasoning supporting one field of a task output. properties: field: description: Name of the output field. title: Field type: string citations: default: [] description: List of citations supporting the output field. items: $ref: '#/components/schemas/Citation' title: Citations type: array reasoning: description: Reasoning for the output field. title: Reasoning type: string confidence: anyOf: - type: string - type: 'null' default: null description: Confidence level for the output field. Only certain processors provide confidence levels. examples: - low - medium - high title: Confidence required: - field - reasoning title: FieldBasis type: object Error: properties: ref_id: type: string title: Reference ID description: Reference ID for the error. message: type: string title: Message description: Human-readable message. detail: anyOf: - additionalProperties: true type: object - type: 'null' title: Detail description: Optional detail supporting the error. type: object required: - ref_id - message title: Error description: An error message. FindAllCandidate: properties: candidate_id: type: string title: Candidate ID description: ID of the candidate. name: type: string title: Name description: Name of the candidate. url: type: string title: Url description: URL that provides context or details of the entity for disambiguation. description: anyOf: - type: string - type: 'null' title: Description description: Brief description of the entity that can help answer whether entity satisfies the query. match_status: type: string enum: - generated - matched - unmatched - discarded title: Match Status description: Status of the candidate. One of generated, matched, unmatched, discarded. output: anyOf: - additionalProperties: true type: object - type: 'null' title: Output description: Results of the match condition evaluations for this candidate. This object contains the structured output that determines whether the candidate matches the overall FindAll objective. basis: anyOf: - items: $ref: '#/components/schemas/FieldBasis' type: array - type: 'null' title: Basis description: List of FieldBasis objects supporting the output. type: object required: - candidate_id - name - url - match_status title: FindAllCandidate description: 'Candidate for a find all run that may end up as a match. Contains all the candidate''s metadata and the output of the match conditions. A candidate is a match if all match conditions are satisfied.' FindAllRunStatusEvent: properties: type: type: string enum: - findall.status const: findall.status title: Type description: Event type; always 'findall.status'. timestamp: type: string format: date-time title: Timestamp description: Timestamp of the event. event_id: type: string title: Event Id description: Unique event identifier for the event. data: $ref: '#/components/schemas/FindAllRun' description: Updated FindAll run information. type: object required: - type - timestamp - event_id - data title: FindAllRunStatusEvent description: Event containing status update for FindAll run. MatchCondition: properties: name: type: string title: Name description: Name of the match condition. description: type: string title: Description description: Detailed description of the match condition. Include as much specific information as possible to help improve the quality and accuracy of Find All run results. examples: - '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.' type: object required: - name - description title: MatchCondition description: Match condition model for FindAll ingest. IngestInput: properties: objective: type: string title: Objective description: Natural language objective to create a FindAll run spec. examples: - Find all AI companies that raised Series A funding in 2024 type: object required: - objective title: IngestInput description: Input model for FindAll ingest. Citation: description: A citation for a task output. properties: title: anyOf: - type: string - type: 'null' default: null description: Title of the citation. title: Title url: description: URL of the citation. title: Url type: string excerpts: anyOf: - items: type: string type: array - type: 'null' default: null description: Excerpts from the citation supporting the output. Only certain processors provide excerpts. title: Excerpts required: - url title: Citation type: object ValidationError: properties: loc: items: anyOf: - type: string - type: integer type: array title: Location msg: type: string title: Message type: type: string title: Error Type type: object required: - loc - msg - type title: ValidationError ErrorResponse: properties: type: type: string const: error title: Type description: Always 'error'. error: $ref: '#/components/schemas/Error' description: Error. type: object required: - type - error title: ErrorResponse description: Response object used for non-200 status codes. FindAllRunStatus: properties: status: type: string enum: - queued - action_required - running - completed - failed - cancelling - cancelled title: Status description: Status of the FindAll run. is_active: type: boolean title: Is Active description: Whether the FindAll run is active metrics: $ref: '#/components/schemas/FindAllCandidateMetrics' description: Candidate metrics for the FindAll run. termination_reason: anyOf: - type: string enum: - low_match_rate - match_limit_met - candidates_exhausted - user_cancelled - error_occurred - timeout - insufficient_funds - type: 'null' title: Termination Reason description: Reason for termination when FindAll run is in terminal status. type: object required: - status - is_active - metrics title: FindAllRunStatus description: Status object for FindAll run. FindAllRunInput: properties: objective: type: string title: Objective description: Natural language objective of the FindAll run. entity_type: type: string title: Entity Type description: Type of the entity for the FindAll run. match_conditions: items: $ref: '#/components/schemas/MatchCondition' type: array title: Match Conditions description: List of match conditions for the FindAll run. generator: type: string enum: - base - core - pro - preview title: Generator description: Generator for the FindAll run. One of base, core, pro, preview. match_limit: type: integer title: Match Limit description: Maximum number of matches to find for this FindAll run. Must be between 5 and 1000 (inclusive). May return fewer results. exclude_list: anyOf: - items: $ref: '#/components/schemas/ExcludeCandidate' type: array maxItems: 10000 - type: 'null' title: Exclude List description: List of entity names/IDs to exclude from results. At most 10,000 entries are allowed. metadata: anyOf: - additionalProperties: anyOf: - type: string - type: integer - type: number - type: boolean type: object - type: 'null' title: Metadata description: Metadata for the FindAll run. webhook: anyOf: - $ref: '#/components/schemas/Webhook' - type: 'null' description: Webhook for the FindAll run. type: object required: - objective - entity_type - match_conditions - generator - match_limit title: FindAllRunInput description: Input model for FindAll run. Webhook: properties: url: type: string title: Url description: URL for the webhook. event_types: items: type: string enum: - task_run.status type: array title: Event Types description: Event types to send the webhook notifications for. default: [] type: object required: - url title: Webhook description: Webhooks for Task Runs. ErrorEvent: properties: type: type: string const: error title: Type description: Event type; always 'error'. error: $ref: '#/components/schemas/Error' description: Error. type: object required: - type - error title: ErrorEvent description: Event indicating an error. EntityItem: properties: name: type: string title: Name description: Entity name. url: type: string title: Url description: Canonical URL for the entity. description: type: string title: Description description: Descriptive text about the entity. type: object required: - name - url - description title: EntityItem JsonSchema: properties: json_schema: additionalProperties: true type: object title: Json Schema description: A JSON Schema object. Only a subset of JSON Schema is supported. examples: - additionalProperties: false properties: gdp: description: GDP in USD for the year, formatted like '$3.1 trillion (2023)' type: string required: - gdp type: object type: type: string const: json title: Type description: The type of schema being defined. Always `json`. default: json type: object required: - json_schema title: JsonSchema description: JSON schema for a task input or output. FindAllSchemaUpdatedEvent: properties: type: type: string enum: - findall.schema.updated const: findall.schema.updated title: Type description: Event type; always 'findall.schema.updated'. timestamp: type: string format: date-time title: Timestamp description: Timestamp of the event. event_id: type: string title: Event Id description: Unique event identifier for the event. data: $ref: '#/components/schemas/FindAllSchema' description: Updated FindAll schema. type: object required: - type - timestamp - event_id - data title: FindAllSchemaUpdatedEvent description: Event containing full snapshot of FindAll run state. securitySchemes: ApiKeyAuth: type: apiKey in: header name: x-api-key