# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Dify Service Workflow Runs API
  version: 1.0.0
extends: openapi/dify-workflow-runs-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: 6
- target: $.paths['/workflows/run/{workflow_run_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a workflow run's status and outputs
      effect: read
      questions:
      - What were the inputs, outputs and status of a specific workflow run?
      - How long did a particular workflow run take and how many tokens did it use?
      instructions:
      - text: Show the details of workflow run {workflow_run_id}.
        slots:
          workflow_run_id: path.workflow_run_id
      - text: Get the outputs and status of run {workflow_run_id}.
        slots:
          workflow_run_id: path.workflow_run_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/workflows/logs'].get
  update:
    x-apievangelist-phrasing:
      intent: List past workflow runs with filters
      effect: read
      questions:
      - Which workflow runs failed in my Dify app this week?
      - Can I filter workflow logs by date range or by the account that started them?
      instructions:
      - text: List workflow run logs with status {status}.
        slots:
          status: query.status
      - text: Show workflow runs created after {created_at__after} and before {created_at__before}.
        slots:
          created_at__after: query.created_at__after
          created_at__before: query.created_at__before
      method: generated
      generated: '2026-09-26'
- target: $.paths['/workflow/{workflow_run_id}/events'].get
  update:
    x-apievangelist-phrasing:
      intent: Resume a workflow run's event stream
      effect: read
      questions:
      - How do I reconnect to a workflow run's event stream after my connection drops?
      - Can I keep the stream open across several human input pauses?
      instructions:
      - text: Resume the event stream for workflow run {workflow_run_id} as user {user}.
        slots:
          workflow_run_id: path.workflow_run_id
          user: query.user
      - text: Reconnect to run {workflow_run_id}'s events for {user} and include a state snapshot {include_state_snapshot}.
        slots:
          workflow_run_id: path.workflow_run_id
          user: query.user
          include_state_snapshot: query.include_state_snapshot
      method: generated
      generated: '2026-09-26'
- target: $.paths['/workflows/run'].post
  update:
    x-apievangelist-phrasing:
      intent: Run the app's latest published workflow
      effect: write
      questions:
      - How do I trigger my published workflow from code and get its outputs?
      - Can I stream a workflow's progress instead of waiting for a blocking response?
      instructions:
      - text: Run the published workflow with inputs {inputs} as user {user}.
        slots:
          inputs: requestBody.inputs
          user: requestBody.user
      - text: Execute the app's current workflow for {user} in {response_mode} mode with inputs {inputs}.
        slots:
          user: requestBody.user
          response_mode: requestBody.response_mode
          inputs: requestBody.inputs
      method: generated
      generated: '2026-09-26'
- target: $.paths['/workflows/{workflow_id}/run'].post
  update:
    x-apievangelist-phrasing:
      intent: Run a specific published workflow version
      effect: write
      questions:
      - Can I pin a run to an older published workflow version instead of the latest?
      - What changes when I run a workflow by its version ID?
      instructions:
      - text: Run workflow version {workflow_id} with inputs {inputs} as user {user}.
        slots:
          workflow_id: path.workflow_id
          inputs: requestBody.inputs
          user: requestBody.user
      - text: Execute the pinned workflow version {workflow_id} for {user} with inputs {inputs}.
        slots:
          workflow_id: path.workflow_id
          user: requestBody.user
          inputs: requestBody.inputs
      method: generated
      generated: '2026-09-26'
- target: $.paths['/workflows/tasks/{task_id}/stop'].post
  update:
    x-apievangelist-phrasing:
      intent: Stop a running streaming workflow task
      effect: write
      questions:
      - How do I cancel a workflow task that is still running in streaming mode?
      - Does the user I pass have to match whoever started the workflow to stop it?
      instructions:
      - text: Stop workflow task {task_id} as user {user}.
        slots:
          task_id: path.task_id
          user: requestBody.user
      - text: Cancel the running workflow task {task_id} for {user}.
        slots:
          task_id: path.task_id
          user: requestBody.user
      method: generated
      generated: '2026-09-26'