Diffbot · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Enhance API

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

What the actions change

x-apievangelist-phrasing

Targets 4

$.info
$.paths['/kg/v3/enhance'].get
$.paths['/kg/v3/enhance'].post
$.paths['/kg/v3/enhance/combine'].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 Enhance API
  version: 1.0.0
extends: openapi/diffbot-enhance-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-09-26'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 3
- target: $.paths['/kg/v3/enhance'].get
  update:
    x-apievangelist-phrasing:
      intent: Enrich a person or company from partial data
      effect: read
      questions:
      - How do I enrich a company record when I only have its name or website?
      - Can I look up a person's full profile from just an email address?
      - What similarity threshold decides whether an enrichment counts as a match?
      instructions:
      - text: Enrich the {type} named {name}.
        slots:
          type: query.type
          name: query.name
      - text: Enhance the {type} with website {url}.
        slots:
          type: query.type
          url: query.url
      - text: Find the person matching email {email}.
        slots:
          email: query.email
      method: generated
      generated: '2026-09-26'
- target: $.paths['/kg/v3/enhance'].post
  update:
    x-apievangelist-phrasing:
      intent: Enrich a person or company via a POST body
      effect: read
      questions:
      - Can I send enrichment inputs in a JSON body instead of query parameters?
      - Is there a POST form of person and organization enrichment?
      instructions:
      - text: Post an enrichment request for {type} {name}.
        slots:
          type: requestBody.type
          name: requestBody.name
      - text: Via POST body, enhance the {type} with phone {phone}.
        slots:
          type: requestBody.type
          phone: requestBody.phone
      method: generated
      generated: '2026-09-26'
- target: $.paths['/kg/v3/enhance/combine'].get
  update:
    x-apievangelist-phrasing:
      intent: Enrich a person and return their employer too
      effect: read
      questions:
      - Can one lookup return both the person and data about their current employer?
      - Which enrichment call pairs a contact with their company's firmographics?
      instructions:
      - text: Enrich {name} and include their current employer's record.
        slots:
          name: query.name
      - text: Return person plus employer data for the contact at {email}.
        slots:
          email: query.email
      method: generated
      generated: '2026-09-26'