GatiFlow · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Gatiflow Intelligence API

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

What the actions change

x-apievangelist-phrasing

Targets 5

$.info
$.paths['/api/v1/intelligence/report'].get
$.paths['/api/v1/intelligence/report-history'].get
$.paths['/api/v1/intelligence/report/at/{snapshot_id}'].get
$.paths['/api/v1/intelligence/report/export'].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 Gatiflow Intelligence API
  version: 1.0.0
extends: openapi/gatiflow-intelligence-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: 4
- target: $.paths['/api/v1/intelligence/report'].get
  update:
    x-apievangelist-phrasing:
      intent: Generate a fresh intelligence report
      effect: read
      questions:
      - How do I generate a current intelligence report for my organization in Gatiflow?
      - Does each signal in a freshly generated report come with its sources and a confidence score?
      - Does running a new report use up part of my daily quota?
      instructions:
      - text: Generate a new intelligence report from the latest collection cycle.
      - text: Run a fresh intelligence report as JSON using schema version {schema_version}.
        slots:
          schema_version: query.schema_version
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v1/intelligence/report-history'].get
  update:
    x-apievangelist-phrasing:
      intent: List retained report snapshots
      effect: read
      questions:
      - Which past report snapshots are still retained for my organization?
      - How far back does my plan keep archived intelligence report snapshots?
      - Where can I find the snapshot ids I need to open an older report?
      instructions:
      - text: List the report snapshots retained for my organization, newest first.
      - text: Show the {limit} most recent report snapshot ids in my history.
        slots:
          limit: query.limit
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v1/intelligence/report/at/{snapshot_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Retrieve an archived report snapshot
      effect: read
      questions:
      - Can I open the intelligence report exactly as it was collected on an earlier date?
      - What format does a snapshot id need to be in to fetch an archived report?
      - Why would an archived report snapshot come back as not found?
      instructions:
      - text: Fetch the archived intelligence report for snapshot {snapshot_id}.
        slots:
          snapshot_id: path.snapshot_id
      - text: Open the past report saved as snapshot {snapshot_id} so I can compare it with today.
        slots:
          snapshot_id: path.snapshot_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v1/intelligence/report/export'].get
  update:
    x-apievangelist-phrasing:
      intent: Export the intelligence report as a file
      effect: read
      questions:
      - Can I download the intelligence report as a CSV or PDF file instead of JSON?
      - Which plans are allowed to export the report to PDF?
      - How do I get a downloadable copy of my intelligence report?
      instructions:
      - text: Export the current intelligence report as a {format} file.
        slots:
          format: query.format
      - text: Download my intelligence report as a CSV attachment.
      method: generated
      generated: '2026-10-01'