FLORA · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Flora.ai Technique Runs API

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

What the actions change

x-apievangelist-phrasing

Targets 3

$.info
$.paths['/techniques/{techniqueId}/runs'].post
$.paths['/techniques/{techniqueId}/runs/{runId}'].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 Flora.ai Technique Runs API
  version: 1.0.0
extends: openapi/flora-fauna-technique-runs-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['/techniques/{techniqueId}/runs'].post
  update:
    x-apievangelist-phrasing:
      intent: Start a technique run via its nested route
      effect: write
      questions:
      - Can I get a callback to my HTTPS endpoint when a technique run finishes?
      - How do I run a technique by its slug using the older nested runs route with an execution mode?
      instructions:
      - text: Run technique {techniqueId} in {mode} mode with inputs {inputs}.
        slots:
          techniqueId: path.techniqueId
          mode: requestBody.mode
          inputs: requestBody.inputs
      - text: Start technique {techniqueId} with inputs {inputs} in {mode} mode and notify {callback_url} when done.
        slots:
          techniqueId: path.techniqueId
          inputs: requestBody.inputs
          mode: requestBody.mode
          callback_url: requestBody.callback_url
      method: generated
      generated: '2026-10-01'
- target: $.paths['/techniques/{techniqueId}/runs/{runId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Check a technique run's progress
      effect: read
      questions:
      - How far along is my technique run and did it produce outputs?
      - Where can I see error details if a technique run failed?
      instructions:
      - text: Get run {runId} of technique {techniqueId}.
        slots:
          runId: path.runId
          techniqueId: path.techniqueId
      - text: Show progress and errors for technique {techniqueId} run {runId}.
        slots:
          techniqueId: path.techniqueId
          runId: path.runId
      method: generated
      generated: '2026-10-01'