> ## Documentation Index
> Fetch the complete documentation index at: https://docs.lerian.studio/llms.txt
> Use this file to discover all available pages before exploring further.

# Get a workflow run

> Returns a run's status with per-step progress and partial results. A failed step never silently disappears from the result.



## OpenAPI

````yaml /en/openapi/v3-current/narya.yaml get /v1/workflows/runs/{runId}
openapi: 3.1.0
info:
  title: Narya Host API
  version: 1.0.0
  description: >-
    The contract between the Narya host and every client. One long-lived host
    runs on your machine and serves this API over a Unix socket in your Narya
    home. Narya creates the socket owner-only, and file permissions are the
    whole authorization. There is no password, no token and no TLS. The terminal
    client and the one-shot command that Lerian ships drive this API, and a
    client you write drives the same one.


    Results never arrive on the response of the request that caused them.
    Submitting a message returns 202 with a turn id. Everything the turn
    produces streams over GET /v1/events as server-sent events with a typed
    envelope, and a stream resumes from a Last-Event-ID header.


    One error envelope: code, title, message, and fields on 422. Codes are NRY-
    followed by four digits. A paged list answers items, limit and a nextCursor
    when more remains. Cursors are opaque.
servers: []
security: []
tags:
  - name: host
    description: The host process itself — version, uptime, mode, store.
  - name: sessions
    description: Durable conversation containers. Archive, never destroy.
  - name: messages
    description: Submitting work into a session and interrupting it.
  - name: events
    description: The server-sent event stream every client consumes.
  - name: lanes
    description: Parallel tracks inside a session — main, subagent, side.
  - name: agents
    description: Named recipes — instructions, tools, model, policy. Read-only in v1.
  - name: ladder
    description: >-
      What a person can type: the skills and command files in force for one
      repository, and expanding one into text. Five origins merged, nearest
      winning a name, the repository's own rungs gated on trust.
  - name: permissions
    description: Pending permission asks, decisions, and the decision audit.
  - name: intercom
    description: Sessions on one machine finding and messaging each other.
  - name: packages
    description: The one thing a user installs — resources, Go code, or both.
  - name: workflows
    description: Deterministic multi-agent orchestration runs.
  - name: providers
    description: Model suppliers, their auth state, and the model catalogue.
  - name: monitors
    description: >-
      Long-running watchers a session keeps beside its conversation — a test
      runner in watch mode, a build, a log being followed. Started by the model
      or by the person, always listed, always killable.
  - name: records
    description: The queryable local record of everything that happened.
  - name: schedules
    description: >-
      Work the host's own clock starts with nobody present — a repository, a
      prompt, a rule and what one fire may spend. Cancel, never destroy.
paths:
  /v1/workflows/runs/{runId}:
    parameters:
      - $ref: '#/components/parameters/RunIdParam'
    get:
      tags:
        - workflows
      summary: Get a workflow run
      description: >-
        Returns a run's status with per-step progress and partial results. A
        failed step never silently disappears from the result.
      operationId: getWorkflowRun
      responses:
        '200':
          description: The run with per-step progress.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WorkflowRun'
        '400':
          $ref: '#/components/responses/BadRequest'
        '404':
          $ref: '#/components/responses/NotFound'
        '500':
          $ref: '#/components/responses/InternalServerError'
components:
  parameters:
    RunIdParam:
      name: runId
      in: path
      required: true
      description: The workflow run's id.
      schema:
        type: string
        format: uuid
  schemas:
    WorkflowRun:
      type: object
      description: A deterministic orchestration run with per-step progress.
      required:
        - id
        - status
      properties:
        id:
          type: string
          format: uuid
        status:
          type: string
          enum:
            - pending
            - running
            - completed
            - failed
            - stopped
        scriptPath:
          type: string
          maxLength: 4096
          description: >-
            Reserved response field. The current host snapshots a local path
            into the run's stored source and does not retain or return the path,
            so this field is absent for both source forms.
        sessionId:
          type: string
          format: uuid
          description: >-
            The session the run's agents work in, so their transcripts can be
            read back after the run and after a restart. Absent until the run
            has started one, and cleared if that session is later purged.
        args:
          type: array
          items:
            type: string
        steps:
          type: array
          items:
            $ref: '#/components/schemas/WorkflowStep'
        error:
          $ref: '#/components/schemas/Error'
          description: Present when the run itself failed outside any step.
        startedAt:
          type: string
          format: date-time
        finishedAt:
          type: string
          format: date-time
      examples:
        - id: 2d4e6f8a-0b2c-4d6e-8f0a-2b4c6d8e0f2a
          status: running
          args:
            - '--dry-run'
          steps:
            - name: run-tests
              status: completed
              output: 412 tests passed
            - name: build-artifacts
              status: running
          startedAt: '2026-08-08T13:00:00.000Z'
    WorkflowStep:
      type: object
      description: >-
        One step of a workflow run. A failed step never silently disappears; a
        stop marks running steps stopped and unstarted steps skipped.
      required:
        - name
        - status
      properties:
        name:
          type: string
          maxLength: 256
        status:
          type: string
          enum:
            - pending
            - running
            - completed
            - failed
            - stopped
            - skipped
        output:
          type: string
          description: The step's result or partial result, as the script reported it.
        startedAt:
          type: string
          format: date-time
        finishedAt:
          type: string
          format: date-time
      examples:
        - name: run-tests
          status: completed
          output: 412 tests passed
          startedAt: '2026-08-08T13:00:00.000Z'
          finishedAt: '2026-08-08T13:04:00.000Z'
    Error:
      type: object
      description: >-
        The single error envelope every operation returns. Codes are NRY-
        followed by four digits and are catalogued in the top-level
        x-error-catalog extension. fields appears only on 422 validation errors,
        mapping each offending property to its problem.
      required:
        - code
        - title
        - message
      properties:
        code:
          type: string
          pattern: ^NRY-[0-9]{4}$
          description: Machine-readable error code from the NRY catalogue.
        title:
          type: string
          maxLength: 256
          description: Short human-readable summary of the error class.
        message:
          type: string
          maxLength: 4096
          description: Specific, actionable description of what went wrong.
        fields:
          type: object
          description: Per-field validation problems. Present on 422 only.
          additionalProperties:
            type: string
      examples:
        - code: NRY-0002
          title: Session not found
          message: >-
            No session with id 6b9f6d2e-1c3a-4f5b-9d7e-2a8c4e6f0b1d exists on
            this host.
  responses:
    BadRequest:
      description: Malformed request — invalid parameter, cursor, or JSON body.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    NotFound:
      description: The addressed resource does not exist on this host.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    InternalServerError:
      description: The host failed — including a store that refuses writes (NRY-0012).
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'

````