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

# Get a task's plan

> The task's whole current plan: its steps, each with its work and checks, and the earlier steps it replaced. The task's plan_progress says whether it has one. Any member of the task's organization may read it, a viewer included; a billing member is refused with 403 org_role_insufficient. A task outside the caller's reach, or one with no plan, is 404 not_found.



## OpenAPI

````yaml api-reference/openapi.json GET /tasks/{taskID}/plan
openapi: 3.1.0
info:
  title: Aether API
  version: 0.1.0
servers:
  - url: https://api.runaether.dev
security:
  - bearerAuth: []
paths:
  /tasks/{taskID}/plan:
    get:
      tags:
        - tasks
      summary: Get a task's plan
      description: >-
        The task's whole current plan: its steps, each with its work and checks,
        and the earlier steps it replaced. The task's plan_progress says whether
        it has one. Any member of the task's organization may read it, a viewer
        included; a billing member is refused with 403 org_role_insufficient. A
        task outside the caller's reach, or one with no plan, is 404 not_found.
      operationId: getTaskPlan
      parameters:
        - in: path
          name: taskID
          required: true
          schema:
            format: uuid
            pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$
            type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TaskPlan'
          description: OK
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TasksErrorResponse'
          description: Unauthorized
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OrgAuthorizationErrorResponse'
          description: Forbidden
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TasksErrorResponse'
          description: Not Found
        '422':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TasksErrorResponse'
          description: Unprocessable Entity
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TasksErrorResponse'
          description: Internal Server Error
        '503':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TasksErrorResponse'
          description: Service Unavailable
components:
  schemas:
    TaskPlan:
      additionalProperties: false
      properties:
        completed:
          format: int64
          minimum: 0
          type: integer
        current_step:
          minLength: 1
          pattern: \S
          type: string
        earlier_steps:
          items:
            $ref: '#/components/schemas/TaskPlanEarlierStep'
          type: array
        explanation:
          minLength: 1
          pattern: \S
          type: string
        steps:
          items:
            $ref: '#/components/schemas/TaskPlanStep'
          type: array
        total:
          format: int64
          minimum: 1
          type: integer
        unclaimed_work:
          $ref: '#/components/schemas/TaskPlanWork'
        updated_at:
          format: date-time
          type: string
      required:
        - steps
        - completed
        - total
        - updated_at
        - earlier_steps
        - unclaimed_work
      type: object
    TasksErrorResponse:
      additionalProperties: false
      properties:
        code:
          enum:
            - account_deleting
            - aether_inference_unserved
            - agent_pr_blocked
            - agent_pr_pending
            - agent_profile_changed
            - app_identity_missing
            - attribution_unavailable
            - bad_gateway
            - bad_request
            - caller_inactive
            - conflict
            - connection_harness_mismatch
            - connection_not_held
            - contents_write_required
            - continuation_failed
            - continuation_unavailable
            - control_forbidden
            - creator_github_access_missing
            - embeddings_unavailable
            - fix_not_requested
            - fix_requests_unrecorded
            - forbidden
            - fork_branch_delete_unsupported
            - fork_forbidden
            - gateway_timeout
            - github_claim_unverified
            - github_failed
            - github_identity_mismatch
            - github_identity_required
            - github_push_access_required
            - github_reconnect_required
            - github_ref_not_found
            - gone
            - handed_branch_protected
            - idempotency_key_reused
            - inference_proxy_unavailable
            - insufficient_credits
            - insufficient_inference_balance
            - internal_error
            - invalid_request
            - mcp_server_not_connected
            - message_not_queued
            - method_not_allowed
            - mode_forbidden
            - no_dispatch_target
            - not_acceptable
            - not_found
            - not_implemented
            - onboarding_already_completed
            - onboarding_requirements_missing
            - org_role_insufficient
            - org_suspended
            - payment_required
            - pr_review_actor_required
            - pr_review_publish_forbidden
            - precondition_failed
            - project_archived
            - project_has_no_repository
            - project_repo_disconnected
            - project_repository_differs
            - pull_request_closed
            - pull_request_mirror_failed
            - pull_request_not_mirrored
            - push_file_too_large
            - push_rejected
            - push_secret_detected
            - queued_stop_requires_discard
            - rate_limited
            - repository_administration_not_granted
            - repository_already_connected
            - repository_create_forbidden
            - repository_create_rejected
            - repository_created_not_linked
            - repository_owner_not_caller
            - request_canceled
            - request_timeout
            - request_too_large
            - save_in_progress
            - save_requires_task_creator
            - service_unavailable
            - stack_cycle
            - stack_too_large
            - stack_two_parents
            - stale_execution
            - stale_or_indeterminate
            - stale_pending_input
            - stream_delivery_gap
            - stream_event_conflict
            - task_already_saved
            - task_awaiting_message
            - task_awaiting_tool_response
            - task_bound_at_creation
            - task_branch_diverged
            - task_branch_is_default
            - task_branch_mismatch
            - task_branch_missing
            - task_connection_disconnected
            - task_creator_deleted
            - task_executing
            - task_file_too_large
            - task_has_no_commits
            - task_has_no_files
            - task_has_no_repository
            - task_history_has_merges
            - task_ineligible
            - task_is_child
            - task_not_accepting_messages
            - task_not_pinnable
            - task_not_started
            - task_rebase_in_progress
            - task_settings_changed
            - teleport_unavailable
            - unauthenticated
            - unsigned_aether_head
            - unsigned_commit
            - unsupported_changes
            - unsupported_media_type
            - untyped_error
            - validation_failed
            - working_tree_dirty
            - workspace_git_unavailable
            - workspace_gone
            - workspace_outdated
            - workspace_rejected
          minLength: 1
          type: string
        error:
          minLength: 1
          type: string
        errors:
          items:
            $ref: '#/components/schemas/ErrorDetail'
          type: array
      required:
        - error
        - code
      type: object
    OrgAuthorizationErrorResponse:
      additionalProperties: false
      properties:
        code:
          enum:
            - org_membership_required
            - org_role_insufficient
            - org_suspended
            - account_deleting
            - agent_host_route_not_allowed
            - credential_kind_not_admitted
          type: string
        error:
          minLength: 1
          type: string
      required:
        - error
        - code
      type: object
    TaskPlanEarlierStep:
      additionalProperties: false
      properties:
        content:
          minLength: 1
          pattern: \S
          type: string
        id:
          description: >-
            The step's key: the stream sequence its plan window starts at, and
            its position in that window.
          pattern: ^[0-9]+:[0-9]+$
          type: string
        work:
          $ref: '#/components/schemas/TaskPlanWork'
      required:
        - id
        - content
        - work
      type: object
    TaskPlanStep:
      additionalProperties: false
      properties:
        active_form:
          minLength: 1
          pattern: \S
          type: string
        checks:
          items:
            $ref: '#/components/schemas/TaskPlanStepCheck'
          type: array
        content:
          minLength: 1
          pattern: \S
          type: string
        status:
          enum:
            - pending
            - in_progress
            - completed
          type: string
        work:
          $ref: '#/components/schemas/TaskPlanWork'
      required:
        - content
        - status
        - checks
        - work
      type: object
    TaskPlanWork:
      additionalProperties: false
      properties:
        cloud_agent_task_ids:
          items:
            format: uuid
            type: string
          type: array
        ledger_tool_call_ids:
          items:
            minLength: 1
            type: string
          type: array
      required:
        - ledger_tool_call_ids
        - cloud_agent_task_ids
      type: object
    ErrorDetail:
      additionalProperties: false
      properties:
        location:
          description: >-
            Where the error occurred, e.g. 'body.items[3].tags' or
            'path.thing-id'
          type: string
        message:
          description: Error message text
          type: string
        value:
          description: The value at the given location
      type: object
    TaskPlanStepCheck:
      additionalProperties: false
      properties:
        kind:
          enum:
            - tests
            - typecheck
            - lint
            - browser_check
            - preview_session
          type: string
        outcome:
          enum:
            - passed
            - failed
          type: string
      required:
        - kind
        - outcome
      type: object
  securitySchemes:
    bearerAuth:
      bearerFormat: JWT
      scheme: bearer
      type: http

````

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