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

# List jobs

List jobs tracked by workspace sessions. Filter by session, state, or command execution.

Completed jobs remain available until the session removes them. Running `wait` or `jobs` can remove completed jobs after reporting them. Times are RFC 3339 strings in UTC.

> [accordion] Errors
>
> | Status | Meaning |
> | - | - |
> | `400` | The request is malformed: the body is not JSON (`invalid_json`) or not a JSON object, a field is missing (`missing_field`), unknown (`unknown_field`) or has a wrong value (`invalid_value`), or the request is otherwise invalid (`invalid_request`). `param` names the field at fault. |
> | `401` | The token is missing or wrong (`unauthorized`). |
> | `404` | The workspace, session, job, file or route does not exist, or the caller may not see it (`not_found`). |
> | `429` | Past a rate limit (`rate_limited`), or a new session past max\_sessions (`session_limit`). |
>
> See [error examples and recovery steps](https://docs.mirage.strukto.ai/api/errors.md). The [complete OpenAPI contract](https://github.com/strukto-ai/mirage/blob/main/docs/openapi.yaml) includes every response schema.


## OpenAPI

````yaml /openapi.yaml get /v1/workspaces/{workspace_id}/jobs
openapi: 3.2.0
info:
  title: Mirage API
  version: '0.1'
servers:
  - url: http://127.0.0.1:8765
    description: A local server on its default port
security:
  - bearerAuth: []
tags:
  - name: Workspace operations
    x-group: Workspaces
  - name: Workspaces
    x-group: Lifecycle
    parent: Workspace operations
  - name: Sessions
  - name: Shell
    parent: Workspace operations
  - name: VFS
    parent: Workspace operations
  - name: Tools
  - name: Documents
    x-group: Agent Instructions
    parent: Workspace operations
  - name: Snapshots
  - name: Templates
    parent: Configuration
  - name: Saved VFS
    x-group: VFS
    parent: Configuration
  - name: Saved CLIs
    x-group: CLI
    parent: Configuration
  - name: Saved machines
    x-group: Machine
    parent: Configuration
  - name: Configuration
  - name: Policies
    parent: Configuration
  - name: Asks
    parent: Workspace operations
    x-group: Approval requests
  - name: Lines
    parent: Workspace operations
    x-group: Commands
  - name: Jobs
    parent: Workspace operations
  - name: Processes
    parent: Workspace operations
  - name: Machines
    parent: Workspace operations
  - name: Server
  - name: Service
    parent: Server
  - name: Daemon
    parent: Server
  - name: Auth
paths:
  /v1/workspaces/{workspace_id}/jobs:
    get:
      tags:
        - Jobs
      summary: List jobs
      operationId: list_jobs_v1_workspaces__workspace_id__jobs_get
      parameters:
        - $ref: '#/components/parameters/workspaceId'
        - name: session_id
          in: query
          required: false
          description: Filter by session ID. If omitted, include all sessions.
          schema:
            type: string
        - name: state
          in: query
          required: false
          description: Filter by execution state.
          schema:
            $ref: '#/components/schemas/JobState'
        - name: line_id
          in: query
          required: false
          description: Command execution ID returned as `line_id` by the shell endpoint.
          schema:
            type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/JobList'
              example:
                items:
                  - id: job_019a5e2c7b417c3e9f204d8e1a6b5c38
                    number: 1
                    session_id: default
                    command: sleep 30
                    cwd: /
                    line_id: line_019a5e2c-7b41-7c3e-9f20-4d8e1a6b5c37
                    group: 42
                    pid: 42
                    state: running
                    started_at: '2026-11-07T00:00:00.000Z'
                    ended_at: null
                    exit: null
                    signal: null
components:
  parameters:
    workspaceId:
      name: workspace_id
      in: path
      required: true
      description: Workspace ID.
      schema:
        type: string
      example: demo
  schemas:
    JobState:
      enum:
        - running
        - stopping
        - exited
      title: JobState
      type: string
    JobList:
      properties:
        items:
          items:
            $ref: '#/components/schemas/JobResponse'
          type: array
      required:
        - items
      type: object
    JobResponse:
      properties:
        command:
          title: Command
          type: string
        cwd:
          type: string
          title: Cwd
        ended_at:
          anyOf:
            - type: string
              format: date-time
            - type: 'null'
          title: Ended At
        exit:
          anyOf:
            - type: integer
            - type: 'null'
          title: Exit
        group:
          anyOf:
            - type: integer
            - type: 'null'
          title: Group
        id:
          title: Id
          type: string
          description: >-
            Job ID, written `job_` and 32 hex digits. Use it with `GET
            /v1/workspaces/{workspace_id}/jobs/{job_id}`.
        line_id:
          anyOf:
            - type: string
            - type: 'null'
          title: Line Id
        number:
          title: Number
          type: integer
        pid:
          anyOf:
            - type: integer
            - type: 'null'
          title: Pid
        session_id:
          type: string
          title: Session Id
        signal:
          anyOf:
            - type: integer
            - type: 'null'
          title: Signal
        started_at:
          type: string
          format: date-time
          title: Started At
        state:
          title: State
          type: string
      required:
        - id
        - number
        - session_id
        - command
        - cwd
        - line_id
        - group
        - pid
        - state
        - started_at
        - ended_at
        - exit
        - signal
      title: JobResponse
      type: object
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: >-
        The server's token (MIRAGE_AUTH_TOKEN) or a JWT. A daemon in the default
        local mode with no token accepts requests without one.

````

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