Diffbot · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Diffbot Extract API

10 actions 10 updates phrasing extends openapi/diffbot-extract-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 10

$.info
$.paths['/v3/analyze'].get
$.paths['/v3/article'].get
$.paths['/v3/product'].get
$.paths['/v3/image'].get
$.paths['/v3/discussion'].get
$.paths['/v3/video'].get
$.paths['/v3/event'].get
$.paths['/v3/job'].get
$.paths['/v3/list'].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 Diffbot Extract API
  version: 1.0.0
extends: openapi/diffbot-extract-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: 9
- target: $.paths['/v3/analyze'].get
  update:
    x-apievangelist-phrasing:
      intent: Auto-detect a page type and extract its data
      effect: read
      questions:
      - What kind of page is this URL and what structured data can be pulled from it?
      - Can one call figure out a page's type and extract accordingly?
      instructions:
      - text: Analyze {url} and extract whatever structured data it has.
        slots:
          url: query.url
      - text: Detect the page type of {url}.
        slots:
          url: query.url
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v3/article'].get
  update:
    x-apievangelist-phrasing:
      intent: Extract article content from a URL
      effect: read
      questions:
      - Can I get the clean body text of a news story?
      - How do I strip ads and navigation from a blog post to get just the article?
      instructions:
      - text: Extract the article content from {url}.
        slots:
          url: query.url
      - text: Get the article title, author and text at {url}.
        slots:
          url: query.url
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v3/product'].get
  update:
    x-apievangelist-phrasing:
      intent: Extract product details from a URL
      effect: read
      questions:
      - Can I pull the price and specs from an online store's product page?
      - Which call gives structured product data from an e-commerce listing?
      instructions:
      - text: Extract product details from {url}.
        slots:
          url: query.url
      - text: Get the price and product specs at {url}.
        slots:
          url: query.url
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v3/image'].get
  update:
    x-apievangelist-phrasing:
      intent: Extract image metadata from a URL
      effect: read
      questions:
      - Can I find the main images on a web page with their metadata?
      - What returns image dimensions and captions from a page?
      instructions:
      - text: Extract image metadata from {url}.
        slots:
          url: query.url
      - text: List the primary images on {url}.
        slots:
          url: query.url
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v3/discussion'].get
  update:
    x-apievangelist-phrasing:
      intent: Extract reviews and comments from a URL
      effect: read
      questions:
      - Can I turn a page's comments section into structured data?
      - How would I scrape the reviews from a product page as posts?
      instructions:
      - text: Extract the reviews and comments on {url}.
        slots:
          url: query.url
      - text: Pull the discussion posts from {url}.
        slots:
          url: query.url
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v3/video'].get
  update:
    x-apievangelist-phrasing:
      intent: Extract video metadata from a URL
      effect: read
      questions:
      - Can I get a video's title, duration and embed code from its page?
      - What gives me the thumbnail and direct link for a video page?
      instructions:
      - text: Extract video metadata from {url}.
        slots:
          url: query.url
      - text: Get the video details for {url}.
        slots:
          url: query.url
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v3/event'].get
  update:
    x-apievangelist-phrasing:
      intent: Extract event details from a URL
      effect: read
      questions:
      - Can I pull the start time and venue from an event page?
      - Which call structures an event listing into date and location?
      instructions:
      - text: Extract event details from {url}.
        slots:
          url: query.url
      - text: Get when and where the event at {url} happens.
        slots:
          url: query.url
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v3/job'].get
  update:
    x-apievangelist-phrasing:
      intent: Extract job posting details from a URL
      effect: read
      questions:
      - Can I turn a job ad into structured fields like title and employer?
      - What extracts the requirements and location from a careers page posting?
      instructions:
      - text: Extract the job posting at {url}.
        slots:
          url: query.url
      - text: Get the title, employer and location of the job listed at {url}.
        slots:
          url: query.url
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v3/list'].get
  update:
    x-apievangelist-phrasing:
      intent: Extract list items from a URL
      effect: read
      questions:
      - Can I turn a search results or category page into a list of items?
      - Which call structures the entries on a news index page?
      instructions:
      - text: Extract the list items from {url}.
        slots:
          url: query.url
      - text: Get every entry listed on {url}.
        slots:
          url: query.url
      method: generated
      generated: '2026-09-26'