Diffbot · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Web Search API

3 actions 3 updates phrasing extends openapi/diffbot-web-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 3

$.info
$.paths['/'].get
$.paths['/'].post

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 Web Search API
  version: 1.0.0
extends: openapi/diffbot-web-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: 2
- target: $.paths['/'].get
  update:
    x-apievangelist-phrasing:
      intent: Search the web index with a query string
      effect: read
      questions:
      - How do I search Diffbot's web index from a simple GET request?
      - Can I cap how long web search results are with a query string parameter?
      instructions:
      - text: Search the web index for {text}.
        slots:
          text: query.text
      - text: Search for {text} and return {size} results.
        slots:
          text: query.text
          size: query.size
      method: generated
      generated: '2026-09-26'
- target: $.paths['/'].post
  update:
    x-apievangelist-phrasing:
      intent: Search the web index with a JSON body
      effect: read
      questions:
      - Can I send a web search query with operators like date filters in a request body?
      - Is there a POST search that limits response tokens so highlights get shortened?
      instructions:
      - text: Post a web search for {text}.
        slots:
          text: requestBody.text
      - text: Run a body-based search for {text} capped at {maxTokens} tokens.
        slots:
          text: requestBody.text
          maxTokens: requestBody.maxTokens
      method: generated
      generated: '2026-09-26'