# 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 Runs API
  version: 1.0.0
extends: openapi/flora-fauna-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: 4
- target: $.paths['/runs/{runId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Check a run's status and outputs
      effect: read
      questions:
      - How do I check whether my generation or action run has finished?
      - Where do I get the output URLs once a run completes?
      instructions:
      - text: Get the status of run {runId}.
        slots:
          runId: path.runId
      - text: Fetch the output URLs for run {runId}.
        slots:
          runId: path.runId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/runs/action'].post
  update:
    x-apievangelist-phrasing:
      intent: Run a prebuilt action headlessly
      effect: write
      questions:
      - Can I run an action like rotate-image on an image URL without touching any canvas?
      - What inputs does a headless action run need, and is the project canvas changed by it?
      instructions:
      - text: Run action {action_id} headlessly on {inputs} in workspace {workspace_id} and project {project_id}.
        slots:
          action_id: requestBody.action_id
          inputs: requestBody.inputs
          workspace_id: requestBody.workspace_id
          project_id: requestBody.project_id
      - text: Start a direct {action_id} run with inputs {inputs} and params {params}, billed to project {project_id} in workspace {workspace_id}.
        slots:
          action_id: requestBody.action_id
          inputs: requestBody.inputs
          params: requestBody.params
          project_id: requestBody.project_id
          workspace_id: requestBody.workspace_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/runs/generation'].post
  update:
    x-apievangelist-phrasing:
      intent: Start a generation run on a project canvas
      effect: write
      questions:
      - How do I generate an image into a project canvas through the normalized runs resource?
      - Can a generation started under /runs use a specific model and parameters?
      instructions:
      - text: Start a {type} generation run on the canvas of project {project_id} in workspace {workspace_id} with prompt {prompt}.
        slots:
          type: requestBody.type
          project_id: requestBody.project_id
          workspace_id: requestBody.workspace_id
          prompt: requestBody.prompt
      - text: Create a canvas generation run with model {model} for prompt {prompt}, type {type}, project {project_id}, workspace {workspace_id}.
        slots:
          model: requestBody.model
          prompt: requestBody.prompt
          type: requestBody.type
          project_id: requestBody.project_id
          workspace_id: requestBody.workspace_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/runs/technique'].post
  update:
    x-apievangelist-phrasing:
      intent: Start a technique run via the top-level runs route
      effect: write
      questions:
      - How do I start a technique run using the newer top-level runs endpoint?
      - Can I launch a technique by passing its ID in the body rather than the URL path?
      instructions:
      - text: Start a top-level run of technique {technique_id} in workspace {workspace_id} with inputs {inputs}.
        slots:
          technique_id: requestBody.technique_id
          workspace_id: requestBody.workspace_id
          inputs: requestBody.inputs
      - text: Launch technique {technique_id} through /runs/technique for workspace {workspace_id} using inputs {inputs}.
        slots:
          technique_id: requestBody.technique_id
          workspace_id: requestBody.workspace_id
          inputs: requestBody.inputs
      method: generated
      generated: '2026-10-01'