Diffbot · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Extract Analyze API

2 actions 2 updates phrasing extends openapi/diffbot-analyze-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 2

$.info
$.paths['/analyze'].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 Extract Analyze API
  version: 1.0.0
extends: openapi/diffbot-analyze-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: 1
- target: $.paths['/analyze'].get
  update:
    x-apievangelist-phrasing:
      intent: Classify a page and extract its data by type
      effect: read
      questions:
      - How do I extract data from a web page when I don't know if it's an article, product or something else?
      - Can page classification fall back to a specific extractor when the page type comes back as other?
      - Is it possible to only classify a page's type without fully extracting it?
      instructions:
      - text: Classify {url} and extract structured data based on its page type.
        slots:
          url: query.url
      - text: Analyze {url} and fall back to the {fallback} extractor if the type can't be determined.
        slots:
          url: query.url
          fallback: query.fallback
      - text: Auto-detect the page type of {url} but skip extracting comments and reviews.
        slots:
          url: query.url
      method: generated
      generated: '2026-09-26'