LittleHorse REST API — Workflow Runs

naftiko: 1.0.0-alpha2
info:
  label: LittleHorse REST API — Workflow Runs
  description: 'LittleHorse REST API — Workflow Runs. 6 operations. Lead operation: Run a workflow. Self-contained Naftiko
    capability covering one Littlehorse business surface.'
  tags:
  - Littlehorse
  - Workflow Runs
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    LITTLEHORSE_API_KEY: LITTLEHORSE_API_KEY
capability:
  consumes:
  - type: http
    namespace: littlehorse-workflow-runs
    baseUri: ''
    description: LittleHorse REST API — Workflow Runs business capability. Self-contained, no shared references.
    resources:
    - name: wfRun
      path: /wfRun
      operations:
      - name: runwf
        method: POST
        description: Run a workflow
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: wfRun-search
      path: /wfRun/search
      operations:
      - name: searchwfruns
        method: GET
        description: Search workflow runs
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: wfSpecName
          in: query
          type: string
        - name: status
          in: query
          type: string
        - name: limit
          in: query
          type: integer
        - name: bookmark
          in: query
          type: string
    - name: wfRun-wfRunId
      path: /wfRun/{wfRunId}
      operations:
      - name: getwfrun
        method: GET
        description: Get a workflow run
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: wfRunId
          in: path
          type: string
          required: true
      - name: deletewfrun
        method: DELETE
        description: Delete a workflow run
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: wfRunId
          in: path
          type: string
          required: true
    - name: wfRun-wfRunId-resume
      path: /wfRun/{wfRunId}/resume
      operations:
      - name: resumewfrun
        method: POST
        description: Resume a workflow run
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: wfRunId
          in: path
          type: string
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: false
    - name: wfRun-wfRunId-stop
      path: /wfRun/{wfRunId}/stop
      operations:
      - name: stopwfrun
        method: POST
        description: Stop a workflow run
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: wfRunId
          in: path
          type: string
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: false
  exposes:
  - type: rest
    namespace: littlehorse-workflow-runs-rest
    port: 8080
    description: REST adapter for LittleHorse REST API — Workflow Runs. One Spectral-compliant resource per consumed operation,
      prefixed with /v1.
    resources:
    - path: /v1/wfrun
      name: wfrun
      description: REST surface for wfRun.
      operations:
      - method: POST
        name: runwf
        description: Run a workflow
        call: littlehorse-workflow-runs.runwf
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/wfrun/search
      name: wfrun-search
      description: REST surface for wfRun-search.
      operations:
      - method: GET
        name: searchwfruns
        description: Search workflow runs
        call: littlehorse-workflow-runs.searchwfruns
        with:
          wfSpecName: rest.wfSpecName
          status: rest.status
          limit: rest.limit
          bookmark: rest.bookmark
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/wfrun/{wfrunid}
      name: wfrun-wfrunid
      description: REST surface for wfRun-wfRunId.
      operations:
      - method: GET
        name: getwfrun
        description: Get a workflow run
        call: littlehorse-workflow-runs.getwfrun
        with:
          wfRunId: rest.wfRunId
        outputParameters:
        - type: object
          mapping: $.
      - method: DELETE
        name: deletewfrun
        description: Delete a workflow run
        call: littlehorse-workflow-runs.deletewfrun
        with:
          wfRunId: rest.wfRunId
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/wfrun/{wfrunid}/resume
      name: wfrun-wfrunid-resume
      description: REST surface for wfRun-wfRunId-resume.
      operations:
      - method: POST
        name: resumewfrun
        description: Resume a workflow run
        call: littlehorse-workflow-runs.resumewfrun
        with:
          wfRunId: rest.wfRunId
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/wfrun/{wfrunid}/stop
      name: wfrun-wfrunid-stop
      description: REST surface for wfRun-wfRunId-stop.
      operations:
      - method: POST
        name: stopwfrun
        description: Stop a workflow run
        call: littlehorse-workflow-runs.stopwfrun
        with:
          wfRunId: rest.wfRunId
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: littlehorse-workflow-runs-mcp
    port: 9090
    transport: http
    description: MCP adapter for LittleHorse REST API — Workflow Runs. One tool per consumed operation, routed inline through
      this capability's consumes block.
    tools:
    - name: run-workflow
      description: Run a workflow
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: littlehorse-workflow-runs.runwf
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: search-workflow-runs
      description: Search workflow runs
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: littlehorse-workflow-runs.searchwfruns
      with:
        wfSpecName: tools.wfSpecName
        status: tools.status
        limit: tools.limit
        bookmark: tools.bookmark
      outputParameters:
      - type: object
        mapping: $.
    - name: get-workflow-run
      description: Get a workflow run
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: littlehorse-workflow-runs.getwfrun
      with:
        wfRunId: tools.wfRunId
      outputParameters:
      - type: object
        mapping: $.
    - name: delete-workflow-run
      description: Delete a workflow run
      hints:
        readOnly: false
        destructive: true
        idempotent: true
      call: littlehorse-workflow-runs.deletewfrun
      with:
        wfRunId: tools.wfRunId
      outputParameters:
      - type: object
        mapping: $.
    - name: resume-workflow-run
      description: Resume a workflow run
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: littlehorse-workflow-runs.resumewfrun
      with:
        wfRunId: tools.wfRunId
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: stop-workflow-run
      description: Stop a workflow run
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: littlehorse-workflow-runs.stopwfrun
      with:
        wfRunId: tools.wfRunId
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.