Diffbot · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for DQL Search API

5 actions 5 updates phrasing extends openapi/diffbot-dql-search-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 5

$.info

$.paths['/kg/v3/dql'].get

$.paths['/kg/v3/dql'].post

$.paths['/kg/v3/dql/report'].get

$.paths['/kg/v3/dql/report/{id}'].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 DQL Search API
  version: 1.0.0
extends: openapi/diffbot-dql-search-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: 4
- target: $.paths['/kg/v3/dql'].get
  update:
    x-apievangelist-phrasing:
      intent: Search the Knowledge Graph with a DQL query
      effect: read
      questions:
      - How do I search the Knowledge Graph for organizations matching certain criteria?
      - Can I export Knowledge Graph search results as CSV or Excel?
      - What is the maximum number of results a DQL query can page through?
      instructions:
      - text: Search the Knowledge Graph for {query}.
        slots:
          query: query.query
      - text: Run DQL query {query} and return {size} results.
        slots:
          query: query.query
          size: query.size
      - text: Export Knowledge Graph results for {query} as {format}.
        slots:
          query: query.query
          format: query.format
      method: generated
      generated: '2026-09-26'
- target: $.paths['/kg/v3/dql'].post
  update:
    x-apievangelist-phrasing:
      intent: Search the Knowledge Graph with DQL in a POST body
      effect: read
      questions:
      - Can I send a long DQL query in a request body instead of the URL?
      - Is there a POST form of Knowledge Graph search for complex queries?
      instructions:
      - text: Post DQL query {query} to the Knowledge Graph.
        slots:
          query: requestBody.query
      - text: Send {query} as a POST body search and cluster related articles.
        slots:
          query: requestBody.query
      method: generated
      generated: '2026-09-26'
- target: $.paths['/kg/v3/dql/report'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a coverage report for a DQL query
      effect: read
      questions:
      - How complete is the data for the entities my DQL query returns?
      - Can I get a field coverage report for a Knowledge Graph query?
      instructions:
      - text: Download the coverage report for query {query}.
        slots:
          query: query.query
      - text: Show field coverage for the results of {query}.
        slots:
          query: query.query
      method: generated
      generated: '2026-09-26'
- target: $.paths['/kg/v3/dql/report/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Download a coverage report by its ID
      effect: read
      questions:
      - Can I re-download a Knowledge Graph coverage report I generated earlier?
      - Where do I fetch a coverage report using its report ID?
      instructions:
      - text: Download coverage report {id}.
        slots:
          id: path.id
      - text: Fetch the saved coverage report with ID {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'