> ## 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.

# Resume a workflow run

> Resumes a run that failed or was stopped, carrying on from the step it died on. The script is re-executed from the top — a program has no continuation to restore across a process death — but every step the run already settled answers from the record instead of running again, so a run that died at step 14 of 21 pays only for the steps that are left and writes the same step structure an uninterrupted run would have written. Completed and failed steps both answer from the record; a step that was merely interrupted holds no settled answer and runs. The source re-executed is the source stored when the run started, never a file on disk, so editing the script between attempts cannot change the structure. Only failed and stopped runs are resumable: resuming a pending, running or completed run is a conflict.



## OpenAPI

````yaml /pt/openapi/v3-current/narya.yaml post /v1/workflows/runs/{runId}/resume
openapi: 3.1.0
info:
  title: Narya Host API
  version: 1.0.0
  description: >-
    The contract between the Narya host and every client. On your own machine,
    one long-lived host serves this API over a Unix socket in your Narya home.
    The terminal client and the one-shot command that Lerian ships drive this
    API, and a client you write drives the same one.


    Requests authenticate with a bearer token issued by the identity provider
    the host is configured with. On your own machine, the host also accepts a
    request with no token from your own operating system user. Once signed-in
    work has claimed the home for an organization, it does so only while this
    machine is signed in to that organization. Such a request gets 401 with
    NRY-0011 on work that reaches your organization beyond the machine. An
    operation that declares another security scheme also accepts that
    credential. Any other request without a valid credential gets 401 with
    NRY-0011. A caller whose role lacks the permission an operation needs gets
    403 with NRY-0028.


    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 and message. Codes are NRY- followed by four
    digits. Cursors are opaque.
servers: []
security:
  - bearerAuth: []
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: extensions
    description: >-
      Host-side extensions and the operations each exposes over the wire. This
      is the generic lane a host extension uses to serve its own client half (a
      TUI component, a web panel) or any API-only consumer, without adding
      routes to this contract.
  - 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: environments
    description: >-
      Where a session's code lives and its commands run — this machine, or a
      container narya operates. A session that names none runs here.
  - 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.
  - name: sharing
    description: >-
      Publishing a session from a developer's own home to the organisation's,
      and what is held back before a byte leaves the machine.
  - name: refinements
    description: >-
      What this owner has taught narya and allowed it to keep — distilled facts,
      and the skills, agents and commands the model wrote for itself. Propose,
      read, consent, roll back. Nothing here fires until a person answers.
  - name: platform
    description: >-
      Calls Lerian's control plane made to a home it hosts, as this home
      recorded them.
paths:
  /v1/workflows/runs/{runId}/resume:
    parameters:
      - $ref: '#/components/parameters/RunIdParam'
    post:
      tags:
        - workflows
      summary: Resume a workflow run
      description: >-
        Resumes a run that failed or was stopped, carrying on from the step it
        died on. The script is re-executed from the top — a program has no
        continuation to restore across a process death — but every step the run
        already settled answers from the record instead of running again, so a
        run that died at step 14 of 21 pays only for the steps that are left and
        writes the same step structure an uninterrupted run would have written.
        Completed and failed steps both answer from the record; a step that was
        merely interrupted holds no settled answer and runs. The source
        re-executed is the source stored when the run started, never a file on
        disk, so editing the script between attempts cannot change the
        structure. Only failed and stopped runs are resumable: resuming a
        pending, running or completed run is a conflict.
      operationId: resumeWorkflowRun
      responses:
        '202':
          description: >-
            Run accepted and resuming. It reads pending, as a started run does,
            until its runner picks it up; watch events or poll the run.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WorkflowRun'
        '400':
          $ref: '#/components/responses/BadRequest'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
        '409':
          $ref: '#/components/responses/Conflict'
        '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.
      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.
          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'
    Forbidden:
      description: >-
        The caller is authenticated and is not allowed this operation (NRY-0028
        or NRY-0030).
      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'
    Conflict:
      description: >-
        The resource's current state rejects the request — archived session,
        busy lane, slot conflict, failed build, already-final state.
      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'
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: >-
        Enforced on every transport, with no exempt operation. A person's
        request must carry a JWT issued by the configured identity provider,
        which the host verifies itself against that issuer's key set: signature,
        issuer, expiry, and the person and organisation it names. Requests
        without a valid one receive 401 NRY-0011 — except a request with no
        token on a laptop's socket from the OS user the kernel names as the
        host's own, which is that machine's user.

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.