FindAll

Add Enrichment to FindAll Run

Add an enrichment to a FindAll run.

post/v1beta/findall/runs/{findall_id}/enrich

Path parameters

findall_idstring required

Headers

parallel-betastring nullable

Request body

processorstring

Processor to use for the task.

Example request

{
  "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"
    }
  }
}

Response

Successful Response

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'

The generator of the FindAll run.

match_limitinteger nullable

Max number of candidates to evaluate

Example response

{
  "objective": "Find all AI companies that raised Series A funding in 2024",
  "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."
    }
  ],
  "enrichments": [
    {
      "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"
        }
      }
    }
  ]
}

Changes

Changed in 4 of the 21 revisions of this API.6119

    • header request parameter parallel-beta was deprecated

      request-parameter-deprecated

    • api tag FindAll added

      api-tag-added

    • api tag FindAll API (Beta) removed

      api-tag-removed

    This revision also has 4 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • 105d778ad64d6115See the full diff
    • added the new required request property /

      new-required-request-property

    • removed the enum value url of the request property ///

      request-property-enum-value-removed

    • the request property type changed from no type to object

      request-property-type-changed

    • the /// response's property type changed from no type to object for status

      response-property-type-changed

    • the response's property type changed from no type to object for status

      response-property-type-changed

    • the response's property type changed from no type to object for status

      response-property-type-changed

    • removed from the request property allOf list

      request-property-all-of-removed

    • added the new optional request property /

      new-optional-request-property

    • added the optional property //// to the response with the status

      response-optional-property-added

    • added the optional property / to the response with the status

      response-optional-property-added

    • added the optional property / to the response with the status

      response-optional-property-added

    • removed from the response property allOf list for the response status

      response-property-all-of-removed

    • removed from the response property allOf list for the response status

      response-property-all-of-removed

    • removed from the /// response property allOf list for the response status

      response-property-all-of-removed

    • removed the error enum value from the response property for the response status

      response-property-enum-value-removed

    • removed the error enum value from the response property for the response status

      response-property-enum-value-removed

    • removed the url enum value from the ////// response property for the response status

      response-property-enum-value-removed

    • added the required property //// to the response with the status

      response-required-property-added

    • added the required property / to the response with the status

      response-required-property-added

    • added the required property / to the response with the status

      response-required-property-added

    • added the required property / to the response with the status

      response-required-property-added

    • added the required property / to the response with the status

      response-required-property-added

    This revision also has 19 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

    • endpoint added

      endpoint-added