Leadspace · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Leadspace Results API

4 actions 4 updates phrasing extends openapi/leadspace-results-api-openapi.yml
Generated by API Evangelist Written by API Evangelist tooling for Leadspace's API. It is a proposal applied on top of the contract, not a document Leadspace publishes.
View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 4

$.info
$.paths['/v1/expansion/results/{bulkId}'].get
$.paths['/v3/enrichment/results/{bulkId}'].get
$.paths['/v1/intent/results/{jobId}'].get

OpenAPI Overlay

Raw ↑ 
# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Leadspace Results API
  version: 1.0.0
extends: openapi/leadspace-results-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: 3
- target: $.paths['/v1/expansion/results/{bulkId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the contacts found by a discovery job
      effect: read
      questions:
      - Where do I pick up the contacts discovered by my account expansion job?
      - Is my account discovery job done yet, and what people did it find?
      instructions:
      - text: Fetch the discovered contacts for expansion job {bulkId}.
        slots:
          bulkId: path.bulkId
      - text: Check whether account discovery bulk {bulkId} has finished.
        slots:
          bulkId: path.bulkId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v3/enrichment/results/{bulkId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the output of a bulk enrichment job
      effect: read
      questions:
      - How do I retrieve enriched records after submitting a bulk enrichment?
      - Can I poll to see whether my batch enrichment has completed?
      instructions:
      - text: Get the enriched records for bulk enrichment job {bulkId}.
        slots:
          bulkId: path.bulkId
      - text: Poll enrichment batch {bulkId} until its results are ready.
        slots:
          bulkId: path.bulkId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/intent/results/{jobId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the results of an intent scoring job
      effect: read
      questions:
      - Where do I see the surging intent topics once my intent refresh finishes?
      - What intent scores came back for the companies I submitted?
      instructions:
      - text: Fetch the intent scoring results for job {jobId}.
        slots:
          jobId: path.jobId
      - text: Show the surging topics and intent model scores from intent job {jobId}.
        slots:
          jobId: path.jobId
      method: generated
      generated: '2026-10-01'