API Evangelist conversational phrasing for Parallel Find All API

# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Parallel Find All API
  version: 1.0.0
extends: openapi/parallel-findall-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-10-01'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 10
- target: $.paths['/v1beta/findall/entity-search'].post
  update:
    x-apievangelist-phrasing:
      intent: Quickly search for ranked entities
      effect: read
      questions:
      - Is there a fast, low-latency way to get a ranked list of companies matching a plain-language description?
      - How many entities can a quick entity search return at most?
      - What's the trade-off of the fast entity search versus a full FindAll run?
      instructions:
      - text: Do a fast entity search for {entity_type} matching {objective}.
        slots:
          entity_type: requestBody.entity_type
          objective: requestBody.objective
      - text: Quickly rank up to {match_limit} {entity_type} that fit {objective}.
        slots:
          match_limit: requestBody.match_limit
          entity_type: requestBody.entity_type
          objective: requestBody.objective
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1beta/findall/ingest'].post
  update:
    x-apievangelist-phrasing:
      intent: Turn an objective into a FindAll run spec
      effect: read
      questions:
      - Can I turn a plain-English goal into a suggested FindAll specification before starting a run?
      - What does the generated FindAll spec give me to customize, like entity type and match conditions?
      instructions:
      - text: 'Draft a FindAll run spec from this objective: {objective}.'
        slots:
          objective: requestBody.objective
      - text: Convert {objective} into structured FindAll match conditions I can edit before running.
        slots:
          objective: requestBody.objective
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1beta/findall/runs'].post
  update:
    x-apievangelist-phrasing:
      intent: Start a FindAll run to discover entities
      effect: write
      questions:
      - How do I kick off a FindAll run to find every company that meets my criteria?
      - Which generators can a FindAll run use, such as base, core or pro?
      - Can I exclude entities I already know about from a new FindAll run?
      - Is there a way to get a webhook when a FindAll run makes progress?
      instructions:
      - text: Start a FindAll run for {entity_type} matching {objective} with conditions {match_conditions}, using the {generator} generator and up to {match_limit} matches.
        slots:
          entity_type: requestBody.entity_type
          objective: requestBody.objective
          match_conditions: requestBody.match_conditions
          generator: requestBody.generator
          match_limit: requestBody.match_limit
      - text: Launch a FindAll run for {objective} on {entity_type}, conditions {match_conditions}, generator {generator}, limit {match_limit}, excluding {exclude_list}.
        slots:
          objective: requestBody.objective
          entity_type: requestBody.entity_type
          match_conditions: requestBody.match_conditions
          generator: requestBody.generator
          match_limit: requestBody.match_limit
          exclude_list: requestBody.exclude_list
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1beta/findall/runs/{findall_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Check the status of a FindAll run
      effect: read
      questions:
      - Is my FindAll run still queued, running, or finished?
      - Can I poll a FindAll run to see how far along it is?
      instructions:
      - text: Check the status of FindAll run {findall_id}.
        slots:
          findall_id: path.findall_id
      - text: Tell me whether FindAll run {findall_id} has completed yet.
        slots:
          findall_id: path.findall_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1beta/findall/runs/{findall_id}/cancel'].post
  update:
    x-apievangelist-phrasing:
      intent: Cancel a FindAll run
      effect: destructive
      questions:
      - How do I stop a FindAll run that I no longer need?
      - Can I cancel a FindAll run before it finds all its matches?
      instructions:
      - text: Cancel FindAll run {findall_id}.
        slots:
          findall_id: path.findall_id
      - text: Stop FindAll run {findall_id} from searching any further.
        slots:
          findall_id: path.findall_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1beta/findall/runs/{findall_id}/enrich'].post
  update:
    x-apievangelist-phrasing:
      intent: Add enrichment fields to a FindAll run
      effect: write
      questions:
      - Can I add extra researched columns, like headcount or funding, to the entities a FindAll run found?
      - Which processor and MCP servers can be used when enriching FindAll matches?
      instructions:
      - text: Enrich the matches in FindAll run {findall_id} with fields defined by {output_schema}.
        slots:
          findall_id: path.findall_id
          output_schema: requestBody.output_schema
      - text: Add an enrichment to FindAll run {findall_id} using the {processor} processor and schema {output_schema}.
        slots:
          findall_id: path.findall_id
          processor: requestBody.processor
          output_schema: requestBody.output_schema
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1beta/findall/runs/{findall_id}/events'].get
  update:
    x-apievangelist-phrasing:
      intent: Stream live events from a FindAll run
      effect: read
      questions:
      - Can I subscribe to real-time updates as a FindAll run discovers matches?
      - How do I resume a FindAll event stream after my connection drops?
      instructions:
      - text: Stream events from FindAll run {findall_id}.
        slots:
          findall_id: path.findall_id
      - text: Resume the FindAll {findall_id} event stream after event {last_event_id}.
        slots:
          findall_id: path.findall_id
          last_event_id: query.last_event_id
      - text: Watch FindAll run {findall_id} events for {timeout} seconds.
        slots:
          findall_id: path.findall_id
          timeout: query.timeout
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1beta/findall/runs/{findall_id}/extend'].post
  update:
    x-apievangelist-phrasing:
      intent: Raise the match limit of a FindAll run
      effect: write
      questions:
      - My FindAll run hit its match limit; can I ask it to find more entities?
      - Does extending a FindAll run add to the existing match limit or replace it?
      instructions:
      - text: Extend FindAll run {findall_id} by {additional_match_limit} more matches.
        slots:
          findall_id: path.findall_id
          additional_match_limit: requestBody.additional_match_limit
      - text: Have FindAll run {findall_id} keep going and find another {additional_match_limit} entities.
        slots:
          findall_id: path.findall_id
          additional_match_limit: requestBody.additional_match_limit
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1beta/findall/runs/{findall_id}/result'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the matched entities from a FindAll run
      effect: read
      questions:
      - Where do I get the list of entities a FindAll run has matched so far?
      - Can I see a snapshot of FindAll results while the run is still going?
      instructions:
      - text: Get the current results of FindAll run {findall_id}.
        slots:
          findall_id: path.findall_id
      - text: Show me the entities matched so far by FindAll run {findall_id}.
        slots:
          findall_id: path.findall_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1beta/findall/runs/{findall_id}/schema'].get
  update:
    x-apievangelist-phrasing:
      intent: View the schema of a FindAll run
      effect: read
      questions:
      - What entity type and match conditions is a given FindAll run using?
      - Can I look up the schema a FindAll run was set up with?
      instructions:
      - text: Show the schema for FindAll run {findall_id}.
        slots:
          findall_id: path.findall_id
      - text: Get the match condition and enrichment schema used by FindAll run {findall_id}.
        slots:
          findall_id: path.findall_id
      method: generated
      generated: '2026-10-01'