Northbeam · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for V1 Data Export API

3 actions 3 updates phrasing extends openapi/northbeam-data-export-api-openapi.yml
Generated by API Evangelist Written by API Evangelist tooling for Northbeam's API. It is a proposal applied on top of the contract, not a document Northbeam publishes.
View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 3

$.info
$.paths['/data-export'].post
$.paths['/data-export/result/{export_id}'].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 V1 Data Export API
  version: 1.0.0
extends: openapi/northbeam-data-export-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-10-01'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 2
- target: $.paths['/data-export'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a data export configuration
      effect: write
      questions:
      - How do I start a new data export from Northbeam?
      - Can I set up an export config to pull my marketing data out?
      instructions:
      - text: Create a new data export config.
      - text: Set up a data export job so I can download the results later.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/data-export/result/{export_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Fetch the result of a data export
      effect: read
      questions:
      - Where do I get the output of a data export I already started?
      - Is my data export finished, and can I download its result?
      instructions:
      - text: Fetch the result of data export {export_id}.
        slots:
          export_id: path.export_id
      - text: Check whether export {export_id} is ready and get its download.
        slots:
          export_id: path.export_id
      method: generated
      generated: '2026-10-01'