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

# Get agent run

> What an agent run produced, and the actions it proposed.



## OpenAPI

````yaml GET /runs/{runId}
openapi: 3.1.0
info:
  title: Whirl API
  version: 1.0.0
  description: >-
    Read and change Whirl workspaces, tasks, reminders, agents' instructions and
    approvals as the signed-in user. The same operations are available as tools
    on the MCP server at /mcp.
servers:
  - url: https://api.whirl.sh/api/v1
security:
  - oauth2: []
paths:
  /runs/{runId}:
    get:
      tags:
        - workspace
      summary: Get agent run
      description: >-
        Get one agent run: status, timing, trigger, its result, plan or error
        text (paged with field and offset), and the actions it proposed with
        their approval status.
      operationId: get_run
      parameters:
        - name: runId
          in: path
          required: true
          schema:
            type: string
            minLength: 1
            maxLength: 64
            description: Run id from list_task_runs or get_task's latestRun.
        - name: field
          in: query
          required: false
          schema:
            default: result
            description: Which run text to page through.
            type: string
            enum:
              - result
              - plan
              - error
        - name: offset
          in: query
          required: false
          schema:
            default: 0
            description: Character offset into that text (from nextOffset).
            type: integer
            minimum: 0
            maximum: 9007199254740991
        - name: actionsCursor
          in: query
          required: false
          schema:
            description: nextActionsCursor from a previous get_run of this run.
            type: string
            maxLength: 2000
        - name: actionsLimit
          in: query
          required: false
          schema:
            default: 20
            description: Maximum results to return (default 20, max 50).
            type: integer
            minimum: 1
            maximum: 50
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: object
        '400':
          $ref: '#/components/responses/Problem'
        '401':
          $ref: '#/components/responses/Problem'
        '403':
          $ref: '#/components/responses/Problem'
        '404':
          $ref: '#/components/responses/Problem'
        '409':
          $ref: '#/components/responses/Problem'
        '429':
          $ref: '#/components/responses/Problem'
      security:
        - oauth2:
            - workspace:read
components:
  responses:
    Problem:
      description: RFC 9457 problem details
      content:
        application/problem+json:
          schema:
            $ref: '#/components/schemas/Problem'
  schemas:
    Problem:
      type: object
      properties:
        type:
          type: string
        title:
          type: string
        status:
          type: integer
        detail:
          type: string
        code:
          type: string
      required:
        - title
        - status
        - code
  securitySchemes:
    oauth2:
      type: oauth2
      flows:
        authorizationCode:
          authorizationUrl: https://api.whirl.sh/oauth/authorize
          tokenUrl: https://api.whirl.sh/oauth/token
          refreshUrl: https://api.whirl.sh/oauth/token
          scopes:
            workspace:read: >-
              Workspaces, tasks, notes, messages, reminders, and pending
              approvals.
            workspace:write: Create and update tasks, notes, tags, reminders, and workspaces.
            agents:read: >-
              Agents, their runs, instructions, handbook, knowledge, and
              scheduled tasks.
            agents:write: >-
              Edit instructions, handbook, knowledge, and scheduled tasks, and
              give agents tasks.
            approvals:write: Approve, reject, or edit actions agents want to take.
            offline_access: >-
              Keep access without asking you to sign in again, until you
              disconnect it.

````

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