People Data Labs · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for api.peopledatalabs.com IP Enrichment API

2 actions 2 updates phrasing extends openapi/peopledatalabs-ip-enrichment-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 2

$.info

$.paths['/v5/ip/enrich'].get

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 api.peopledatalabs.com IP Enrichment API
  version: 1.0.0
extends: openapi/peopledatalabs-ip-enrichment-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: 1
- target: $.paths['/v5/ip/enrich'].get
  update:
    x-apievangelist-phrasing:
      intent: Identify the company behind an IP address
      effect: read
      questions:
      - Which company is a website visitor's IP address associated with?
      - Can IP enrichment also return location and metadata for the address?
      - Will I get any data back if the IP doesn't match a company?
      instructions:
      - text: Enrich IP address {ip}.
        slots:
          ip: query.ip
      - text: Look up the company for {ip} and include its location and metadata.
        slots:
          ip: query.ip
      - text: Enrich {ip} and return person fields tied to it, even if no company matches.
        slots:
          ip: query.ip
      method: generated
      generated: '2026-10-01'