People Data Labs · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Peopledatalabs Autocomplete API

3 actions 3 updates phrasing extends openapi/peopledatalabs-autocomplete-api-openapi.yml

Generated by API Evangelist Written by API Evangelist tooling for People Data Labs's API. It is a proposal applied on top of the contract, not a document People Data Labs publishes.

View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 3

$.info

$.paths['/v5/autocomplete'].get

$.paths['/v5/autocomplete'].post

OpenAPI Overlay

# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Peopledatalabs Autocomplete API
  version: 1.0.0
extends: openapi/peopledatalabs-autocomplete-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: 2
- target: $.paths['/v5/autocomplete'].get
  update:
    x-apievangelist-phrasing:
      intent: Autocomplete a field value from partial text
      effect: read
      questions:
      - Can I get suggested company or job title values as someone types?
      - Which fields does People Data Labs autocomplete support?
      - How many autocomplete suggestions can I ask for at once?
      instructions:
      - text: Autocomplete {field} values starting with {text}.
        slots:
          field: query.field
          text: query.text
      - text: Suggest the top {size} {field} completions for {text} via a GET request.
        slots:
          size: query.size
          field: query.field
          text: query.text
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v5/autocomplete'].post
  update:
    x-apievangelist-phrasing:
      intent: Autocomplete a field value with a POST body
      effect: read
      questions:
      - Can I send the autocomplete field and seed text in a JSON body instead of the query string?
      - Is there a POST version of autocomplete that titlecases the suggestions?
      instructions:
      - text: POST an autocomplete request for {field} seeded with {text}.
        slots:
          field: requestBody.field
          text: requestBody.text
      - text: Send {size} titlecased {field} suggestions for {text} using the POST autocomplete body.
        slots:
          size: requestBody.size
          field: requestBody.field
          text: requestBody.text
      method: generated
      generated: '2026-10-01'