Diffbot · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Extract Custom API

5 actions 5 updates phrasing extends openapi/diffbot-custom-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['/{api}'].get

$.paths['/custom'].get

$.paths['/custom'].post

$.paths['/custom'].delete

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 Extract Custom API
  version: 1.0.0
extends: openapi/diffbot-custom-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['/{api}'].get
  update:
    x-apievangelist-phrasing:
      intent: Extract a page with one of my Custom APIs
      effect: read
      questions:
      - How do I run a page through the custom extraction rules I built?
      - Can I apply my own ruleset to extract fields a standard extractor misses?
      - What proxy options are available when extracting with a Custom API?
      instructions:
      - text: Extract {url} using my Custom API {api}.
        slots:
          url: query.url
          api: path.api
      - text: Run {url} through custom ruleset {api} and return {fields}.
        slots:
          url: query.url
          api: path.api
          fields: query.fields
      method: generated
      generated: '2026-09-26'
- target: $.paths['/custom'].get
  update:
    x-apievangelist-phrasing:
      intent: List my Custom APIs and their rules
      effect: read
      questions:
      - Which Custom APIs and rules are defined on my token?
      - Can I see all my custom extraction rulesets in one place?
      instructions:
      - text: List all Custom APIs and rules on my token.
      - text: Show me every custom extraction ruleset I've defined.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/custom'].post
  update:
    x-apievangelist-phrasing:
      intent: Create or update a Custom API ruleset
      effect: write
      questions:
      - How do I define custom extraction rules for pages matching a URL pattern?
      - Can I update the rules of a Custom API I already created?
      - Is it possible to strip certain page elements before extraction runs?
      instructions:
      - text: Create a custom ruleset for {api} applied to URLs matching {urlPattern}.
        slots:
          api: requestBody.api
          urlPattern: requestBody.urlPattern
      - text: Update the {api} rules for {urlPattern} and test them against {testUrl}.
        slots:
          api: requestBody.api
          urlPattern: requestBody.urlPattern
          testUrl: requestBody.testUrl
      - text: Add prefilters {prefilters} to my {api} ruleset.
        slots:
          prefilters: requestBody.prefilters
          api: requestBody.api
      method: generated
      generated: '2026-09-26'
- target: $.paths['/custom'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a Custom API ruleset
      effect: destructive
      questions:
      - Can I remove a custom extraction ruleset I no longer use?
      - What deletes the Custom API definitions for one URL pattern?
      instructions:
      - text: Delete the {api} Custom API for URL pattern {urlPattern}.
        slots:
          api: requestBody.api
          urlPattern: requestBody.urlPattern
      - text: Remove my custom rules matching {urlPattern}.
        slots:
          urlPattern: requestBody.urlPattern
      method: generated
      generated: '2026-09-26'