# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Extract Bulk API
  version: 1.0.0
extends: openapi/diffbot-bulk-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: 3
- target: $.paths['/bulk'].get
  update:
    x-apievangelist-phrasing:
      intent: Pause, restart, delete or check a bulk extract job
      effect: write
      questions:
      - How do I pause a bulk extraction job that is still running?
      - What happens to already processed data when I restart a bulk job?
      - Can I check the progress of a bulk extract job by its name?
      instructions:
      - text: Pause the bulk extract job {name}.
        slots:
          name: query.name
      - text: Show the status of bulk extract job {name}.
        slots:
          name: query.name
      - text: Delete bulk extract job {name} and all its data.
        slots:
          name: query.name
      method: generated
      generated: '2026-09-26'
- target: $.paths['/bulk'].post
  update:
    x-apievangelist-phrasing:
      intent: Start a bulk extract job over a list of URLs
      effect: write
      questions:
      - Can I extract thousands of URLs asynchronously instead of one call at a time?
      - Is there a way to get emailed or pinged by webhook when a bulk extraction finishes?
      - Which extraction API gets applied to each URL in a batch job?
      instructions:
      - text: Create bulk job {name} to extract {urls} through {apiUrl}.
        slots:
          name: requestBody.name
          urls: requestBody.urls
          apiUrl: requestBody.apiUrl
      - text: Start bulk job {name} on {urls} using {apiUrl} and email {notifyEmail} when it's done.
        slots:
          name: requestBody.name
          urls: requestBody.urls
          apiUrl: requestBody.apiUrl
          notifyEmail: requestBody.notifyEmail
      - text: Set up bulk job {name} over {urls} with {apiUrl}, repeating every {repeat} days.
        slots:
          name: requestBody.name
          urls: requestBody.urls
          apiUrl: requestBody.apiUrl
          repeat: requestBody.repeat
      method: generated
      generated: '2026-09-26'
- target: $.paths['/bulk/data'].get
  update:
    x-apievangelist-phrasing:
      intent: Download the results of a bulk extract job
      effect: read
      questions:
      - How do I download the extracted output of a finished bulk job?
      - Can bulk job results be exported as CSV rather than JSON?
      - Is there a URL report showing which pages a bulk job processed?
      instructions:
      - text: Download the extracted data from bulk job {name}.
        slots:
          name: query.name
      - text: Export bulk job {name} results as {format}.
        slots:
          name: query.name
          format: query.format
      - text: Get the {num} most recently processed results from bulk job {name}.
        slots:
          num: query.num
          name: query.name
      method: generated
      generated: '2026-09-26'