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

# Keep a task's full context

> Skips the pending idle compaction a task waiting for a message shows, so its conversation is not replaced with a summary while it sits idle, and answers with the task.

Use this tool when you need to:
- Keep a long planning conversation whole across an idle stretch
- Stop Aether from compacting a task you are about to come back to

Examples:
- POST /tasks/{taskID}/idle-compaction/keep
- POST /tasks/6f1c2a9e-3b7d-4c55-9a2e-0d8b1f4e7c21/idle-compaction/keep

Hints:
- taskID is the task's lowercase uuid. getTask shows the pending compaction as awaiting_input.idle_compaction: when it fires, and the context tokens it replaces.
- It skips this one compaction: the task's next message re-reads the whole context. A later turn that leaves a large context schedules a new one, and there is no setting that keeps every one.
- Answers 200 with the task, which no longer shows the compaction. A task that shows none is refused with 409 idle_compaction_not_pending.
- Use compactTaskNow instead to compact at once.
- A task on its person's computer never shows one, so it is refused with 409 idle_compaction_not_pending.
- Restricted to whoever may act on the task, before anything else is refused: in a sandbox its creator or an admin or owner of its organization, an agent host's grant of theirs included, and on its person's computer that person alone, not through an agent host's grant. Anyone else is refused with 403 control_forbidden, a viewer or billing member with 403 org_role_insufficient, a suspended account or organization with 403 user_suspended or org_suspended, and a task the caller cannot see is 404; 503 when the membership check is unavailable.



## OpenAPI

````yaml api-reference/openapi.json POST /tasks/{taskID}/idle-compaction/keep
openapi: 3.1.0
info:
  title: Aether API
  version: 0.1.0
servers:
  - url: https://api.runaether.dev
security:
  - bearerAuth: []
paths:
  /tasks/{taskID}/idle-compaction/keep:
    post:
      tags:
        - tasks
      summary: Keep a task's full context
      description: >-
        Skips the pending idle compaction a task waiting for a message shows, so
        its conversation is not replaced with a summary while it sits idle, and
        answers with the task.


        Use this tool when you need to:

        - Keep a long planning conversation whole across an idle stretch

        - Stop Aether from compacting a task you are about to come back to


        Examples:

        - POST /tasks/{taskID}/idle-compaction/keep

        - POST /tasks/6f1c2a9e-3b7d-4c55-9a2e-0d8b1f4e7c21/idle-compaction/keep


        Hints:

        - taskID is the task's lowercase uuid. getTask shows the pending
        compaction as awaiting_input.idle_compaction: when it fires, and the
        context tokens it replaces.

        - It skips this one compaction: the task's next message re-reads the
        whole context. A later turn that leaves a large context schedules a new
        one, and there is no setting that keeps every one.

        - Answers 200 with the task, which no longer shows the compaction. A
        task that shows none is refused with 409 idle_compaction_not_pending.

        - Use compactTaskNow instead to compact at once.

        - A task on its person's computer never shows one, so it is refused with
        409 idle_compaction_not_pending.

        - Restricted to whoever may act on the task, before anything else is
        refused: in a sandbox its creator or an admin or owner of its
        organization, an agent host's grant of theirs included, and on its
        person's computer that person alone, not through an agent host's grant.
        Anyone else is refused with 403 control_forbidden, a viewer or billing
        member with 403 org_role_insufficient, a suspended account or
        organization with 403 user_suspended or org_suspended, and a task the
        caller cannot see is 404; 503 when the membership check is unavailable.
      operationId: keepTaskFullContext
      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/Task'
          description: OK
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TasksErrorResponse'
          description: Unauthorized
        '403':
          content:
            application/json:
              schema:
                anyOf:
                  - $ref: '#/components/schemas/TasksErrorResponse'
                  - $ref: '#/components/schemas/OrgAuthorizationErrorResponse'
                  - $ref: '#/components/schemas/ControlForbiddenErrorResponse'
          description: Forbidden
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TasksErrorResponse'
          description: Not Found
        '409':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TasksErrorResponse'
          description: Conflict
        '410':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TasksErrorResponse'
          description: Gone
        '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:
    Task:
      discriminator:
        mapping:
          awaiting_input: '#/components/schemas/TaskAwaitingInput'
          errored: '#/components/schemas/TaskErrored'
          processing: '#/components/schemas/TaskProcessing'
          queued: '#/components/schemas/TaskQueued'
        propertyName: status
      oneOf:
        - $ref: '#/components/schemas/TaskQueued'
        - $ref: '#/components/schemas/TaskProcessing'
        - $ref: '#/components/schemas/TaskAwaitingInput'
        - $ref: '#/components/schemas/TaskErrored'
    TasksErrorResponse:
      additionalProperties: false
      properties:
        code:
          enum:
            - account_deleting
            - aether_inference_unserved
            - agent_pr_blocked
            - agent_pr_pending
            - agent_profile_changed
            - agent_starts_off
            - agent_uses_own_sign_in
            - answer_on_its_way
            - app_identity_missing
            - attachments_unsupported
            - attribution_unavailable
            - bad_gateway
            - bad_request
            - base_branch_unusable
            - branch_exists
            - caller_inactive
            - chat_archived
            - chat_being_forked
            - chat_moved
            - chat_not_removable
            - chat_settings_fixed
            - chats_not_addable
            - checkout_not_archivable
            - cli_upgrade_required
            - client_outdated
            - computer_cli_outdated
            - computer_starts_no_agents
            - computer_starts_no_forks
            - computer_unreachable
            - conflict
            - connection_creator_only
            - connection_harness_mismatch
            - connection_not_held
            - contents_write_required
            - continuation_failed
            - continuation_unavailable
            - control_forbidden
            - creator_github_access_missing
            - credential_kind_not_admitted
            - credential_named_file
            - detached_head
            - download_unsupported
            - embeddings_unavailable
            - feature_unsupported
            - file_references_unsupported
            - fix_not_requested
            - fix_requests_unrecorded
            - forbidden
            - fork_branch_delete_unsupported
            - fork_forbidden
            - fork_in_progress
            - fork_unsupported
            - 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
            - head_moved
            - html_render_nul_byte
            - html_render_too_large
            - idempotency_key_conflict
            - idempotency_key_reused
            - idle_compaction_not_pending
            - idle_compaction_skipped
            - inference_proxy_unavailable
            - insufficient_credits
            - insufficient_inference_balance
            - interaction_mode_unsupported
            - internal_error
            - invalid_request
            - last_queued_message
            - live_protocol_unsupported
            - main_chat_permanent
            - mcp_server_not_connected
            - merge_when_ready_requires_pr_review
            - message_not_queued
            - method_not_allowed
            - mode_forbidden
            - name_follows_session
            - no_checkout_on_computer
            - no_checkpoint_yet
            - no_commit
            - no_dispatch_target
            - no_main_chat
            - no_origin
            - no_turn_running
            - no_work_tree_folder
            - not_acceptable
            - not_found
            - not_implemented
            - onboarding_already_completed
            - onboarding_requirements_missing
            - open_in_terminal
            - org_id_required
            - org_role_insufficient
            - org_suspended
            - payment_required
            - pending_input_answered
            - permission_prompt_answered_in_terminal
            - permission_prompt_expired
            - permission_prompt_open
            - permission_prompt_stopped
            - pr_automation_unsupported
            - pr_review_actor_required
            - pr_review_connection_spent
            - pr_review_publish_forbidden
            - precondition_failed
            - project_archived
            - project_has_no_repository
            - project_repo_disconnected
            - project_repository_differs
            - project_required
            - pull_request_closed
            - pull_request_mirror_failed
            - pull_request_not_mirrored
            - push_failed
            - push_file_too_large
            - push_rejected
            - push_secret_detected
            - question_answers
            - question_shortened
            - queue_for_later_unsupported
            - queued_stop_requires_discard
            - rate_limited
            - reasoning_effort_fixed
            - repository_administration_not_granted
            - repository_already_connected
            - repository_create_forbidden
            - repository_create_rejected
            - repository_created_not_linked
            - repository_not_connected
            - repository_owner_not_caller
            - request_canceled
            - request_expired
            - request_timeout
            - request_too_large
            - review_name_follows_pull_request
            - sandbox_deleted
            - sandbox_failed
            - sandbox_needs_message
            - save_in_progress
            - save_requires_task_creator
            - service_unavailable
            - session_file_missing
            - session_gone
            - session_not_started_by_aether
            - slash_command
            - slash_commands_unsupported
            - 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_archived
            - task_awaiting_message
            - task_awaiting_tool_response
            - task_backed_by_work_tree
            - 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_branch
            - 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
            - task_start_failed
            - task_start_pending
            - teleport_unavailable
            - terminal_chat
            - terminal_chat_continuation_refused
            - terminal_chat_run_running
            - terminal_question
            - too_large
            - too_many_live_connections
            - too_many_waiting_messages
            - turn_running
            - unauthenticated
            - unsigned_aether_head
            - unsigned_commit
            - unsupported_changes
            - unsupported_media_type
            - untyped_error
            - user_suspended
            - validation_failed
            - working_tree_dirty
            - workspace_git_unavailable
            - workspace_gone
            - workspace_outdated
            - workspace_rejected
            - workspace_start_failed
          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
            - grant_scope_insufficient
          type: string
        error:
          minLength: 1
          type: string
      required:
        - error
        - code
      type: object
    ControlForbiddenErrorResponse:
      additionalProperties: false
      properties:
        code:
          enum:
            - control_forbidden
          type: string
        error:
          minLength: 1
          type: string
      required:
        - error
        - code
      type: object
    TaskAwaitingInput:
      additionalProperties: false
      properties:
        agent_type:
          anyOf:
            - $ref: '#/components/schemas/AgentType'
            - type: 'null'
        archived_at:
          format: date-time
          type:
            - string
            - 'null'
        auto_fix_ci:
          type: boolean
        auto_fix_pr_comments:
          type: boolean
        auto_rebase:
          type: boolean
        awaiting_input:
          $ref: '#/components/schemas/TaskAwaitingInputPayload'
        binding:
          anyOf:
            - $ref: '#/components/schemas/TaskRepositoryBinding'
            - type: 'null'
        campaign:
          anyOf:
            - $ref: '#/components/schemas/TaskCampaignSummary'
            - type: 'null'
        can:
          $ref: '#/components/schemas/TaskAbilities'
        conversation:
          $ref: '#/components/schemas/TaskConversation'
        created_at:
          format: date-time
          type: string
        creator_reauth_required:
          type: boolean
        head_branch:
          minLength: 1
          type:
            - string
            - 'null'
        id:
          format: uuid
          type: string
        interaction_mode:
          pattern: ^[a-z][a-z0-9_]{0,31}$
          type:
            - string
            - 'null'
        latest_message_revision:
          description: >-
            Maximum revision_sequence of currently stored task messages,
            including soft-deleted rows; zero means no messages. Compare
            equality only: hard deletion can decrease it. Not an activity/stream
            cursor or a task-wide version.
          format: int64
          maximum: 9007199254740991
          minimum: 0
          type: integer
        latest_status_message:
          type:
            - string
            - 'null'
        machine:
          $ref: '#/components/schemas/TaskMachine'
        merge_when_ready:
          description: >-
            Whether the task merges its own published pull request once it is
            ready: external CI green, Aether Review's APPROVE at the exact head,
            no unresolved review thread and the task idle.
          type: boolean
        model:
          minLength: 1
          type:
            - string
            - 'null'
        name:
          minLength: 1
          type: string
        org_id:
          pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$
          type: string
        outcome:
          description: >-
            The one word a client renders for the task: its lifecycle rolled up
            with its pull request's state. status is the lifecycle alone.
          enum:
            - running
            - awaiting_input
            - approved
            - awaiting_ci
            - merged
            - unmerged
            - errored
            - archived
          type: string
        parent_task_id:
          format: uuid
          type:
            - string
            - 'null'
        pinned_at:
          format: date-time
          type:
            - string
            - 'null'
        plan_progress:
          $ref: '#/components/schemas/TaskPlanProgress'
        post_pr_demo_video:
          type: boolean
        post_pr_screenshots:
          type: boolean
        pr_review_mode:
          enum:
            - review_only
            - fix_on_request
            - apply_fixes
          type:
            - string
            - 'null'
        pr_review_summary:
          anyOf:
            - $ref: '#/components/schemas/TaskPRReviewSummary'
            - type: 'null'
        primary_pull_request:
          anyOf:
            - $ref: '#/components/schemas/TaskPullRequest'
            - type: 'null'
        project:
          $ref: '#/components/schemas/TaskProjectContext'
        project_id:
          format: uuid
          type: string
        pull_requests:
          items:
            $ref: '#/components/schemas/TaskPullRequest'
          type: array
        reasoning_effort:
          pattern: ^[a-z][a-z0-9_]{0,31}$
          type:
            - string
            - 'null'
        review_subject_pull_request:
          anyOf:
            - $ref: '#/components/schemas/TaskReviewSubjectPullRequest'
            - type: 'null'
        run_context:
          anyOf:
            - $ref: '#/components/schemas/TaskRunContext'
            - type: 'null'
        runs_on:
          anyOf:
            - $ref: '#/components/schemas/TaskRunsOn'
            - type: 'null'
        runtime_timing:
          $ref: '#/components/schemas/TaskRuntimeTiming'
        save_to_github:
          $ref: '#/components/schemas/TaskSaveToGitHub'
        source:
          $ref: '#/components/schemas/TaskSource'
        source_metadata:
          additionalProperties: true
          properties: {}
          type:
            - object
            - 'null'
        start:
          anyOf:
            - $ref: '#/components/schemas/TaskStart'
            - type: 'null'
        status:
          enum:
            - awaiting_input
          type: string
        updated_at:
          format: date-time
          type: string
        url:
          description: The task's page in the Aether web app.
          format: uri
          minLength: 1
          type: string
        usage:
          $ref: '#/components/schemas/TaskUsage'
        user_id:
          format: uuid
          type:
            - string
            - 'null'
      required:
        - id
        - url
        - org_id
        - project_id
        - project
        - parent_task_id
        - user_id
        - name
        - agent_type
        - model
        - interaction_mode
        - runs_on
        - auto_fix_ci
        - auto_fix_pr_comments
        - auto_rebase
        - post_pr_screenshots
        - post_pr_demo_video
        - merge_when_ready
        - status
        - outcome
        - pull_requests
        - primary_pull_request
        - review_subject_pull_request
        - pr_review_summary
        - campaign
        - creator_reauth_required
        - usage
        - runtime_timing
        - machine
        - start
        - source
        - created_at
        - updated_at
        - binding
        - save_to_github
        - latest_message_revision
        - reasoning_effort
        - archived_at
        - pinned_at
        - head_branch
        - pr_review_mode
        - source_metadata
        - latest_status_message
        - conversation
        - can
        - run_context
        - awaiting_input
      type: object
    TaskErrored:
      additionalProperties: false
      properties:
        agent_type:
          anyOf:
            - $ref: '#/components/schemas/AgentType'
            - type: 'null'
        archived_at:
          format: date-time
          type:
            - string
            - 'null'
        auto_fix_ci:
          type: boolean
        auto_fix_pr_comments:
          type: boolean
        auto_rebase:
          type: boolean
        binding:
          anyOf:
            - $ref: '#/components/schemas/TaskRepositoryBinding'
            - type: 'null'
        campaign:
          anyOf:
            - $ref: '#/components/schemas/TaskCampaignSummary'
            - type: 'null'
        can:
          $ref: '#/components/schemas/TaskAbilities'
        completed_at:
          format: date-time
          type: string
        conversation:
          $ref: '#/components/schemas/TaskConversation'
        created_at:
          format: date-time
          type: string
        creator_reauth_required:
          type: boolean
        error:
          minLength: 1
          type: string
        failure:
          $ref: '#/components/schemas/TaskFailure'
        head_branch:
          minLength: 1
          type:
            - string
            - 'null'
        id:
          format: uuid
          type: string
        interaction_mode:
          pattern: ^[a-z][a-z0-9_]{0,31}$
          type:
            - string
            - 'null'
        latest_message_revision:
          description: >-
            Maximum revision_sequence of currently stored task messages,
            including soft-deleted rows; zero means no messages. Compare
            equality only: hard deletion can decrease it. Not an activity/stream
            cursor or a task-wide version.
          format: int64
          maximum: 9007199254740991
          minimum: 0
          type: integer
        latest_status_message:
          type:
            - string
            - 'null'
        machine:
          $ref: '#/components/schemas/TaskMachine'
        merge_when_ready:
          description: >-
            Whether the task merges its own published pull request once it is
            ready: external CI green, Aether Review's APPROVE at the exact head,
            no unresolved review thread and the task idle.
          type: boolean
        model:
          minLength: 1
          type:
            - string
            - 'null'
        name:
          minLength: 1
          type: string
        org_id:
          pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$
          type: string
        outcome:
          description: >-
            The one word a client renders for the task: its lifecycle rolled up
            with its pull request's state. status is the lifecycle alone.
          enum:
            - running
            - awaiting_input
            - approved
            - awaiting_ci
            - merged
            - unmerged
            - errored
            - archived
          type: string
        parent_task_id:
          format: uuid
          type:
            - string
            - 'null'
        pinned_at:
          format: date-time
          type:
            - string
            - 'null'
        plan_progress:
          $ref: '#/components/schemas/TaskPlanProgress'
        post_pr_demo_video:
          type: boolean
        post_pr_screenshots:
          type: boolean
        pr_review_mode:
          enum:
            - review_only
            - fix_on_request
            - apply_fixes
          type:
            - string
            - 'null'
        pr_review_summary:
          anyOf:
            - $ref: '#/components/schemas/TaskPRReviewSummary'
            - type: 'null'
        primary_pull_request:
          anyOf:
            - $ref: '#/components/schemas/TaskPullRequest'
            - type: 'null'
        project:
          $ref: '#/components/schemas/TaskProjectContext'
        project_id:
          format: uuid
          type: string
        pull_requests:
          items:
            $ref: '#/components/schemas/TaskPullRequest'
          type: array
        reasoning_effort:
          pattern: ^[a-z][a-z0-9_]{0,31}$
          type:
            - string
            - 'null'
        review_subject_pull_request:
          anyOf:
            - $ref: '#/components/schemas/TaskReviewSubjectPullRequest'
            - type: 'null'
        run_context:
          anyOf:
            - $ref: '#/components/schemas/TaskRunContext'
            - type: 'null'
        runs_on:
          anyOf:
            - $ref: '#/components/schemas/TaskRunsOn'
            - type: 'null'
        runtime_timing:
          $ref: '#/components/schemas/TaskRuntimeTiming'
        save_to_github:
          $ref: '#/components/schemas/TaskSaveToGitHub'
        source:
          $ref: '#/components/schemas/TaskSource'
        source_metadata:
          additionalProperties: true
          properties: {}
          type:
            - object
            - 'null'
        start:
          anyOf:
            - $ref: '#/components/schemas/TaskStart'
            - type: 'null'
        status:
          enum:
            - errored
          type: string
        updated_at:
          format: date-time
          type: string
        url:
          description: The task's page in the Aether web app.
          format: uri
          minLength: 1
          type: string
        usage:
          $ref: '#/components/schemas/TaskUsage'
        user_id:
          format: uuid
          type:
            - string
            - 'null'
      required:
        - id
        - url
        - org_id
        - project_id
        - project
        - parent_task_id
        - user_id
        - name
        - agent_type
        - model
        - interaction_mode
        - runs_on
        - auto_fix_ci
        - auto_fix_pr_comments
        - auto_rebase
        - post_pr_screenshots
        - post_pr_demo_video
        - merge_when_ready
        - status
        - outcome
        - pull_requests
        - primary_pull_request
        - review_subject_pull_request
        - pr_review_summary
        - campaign
        - creator_reauth_required
        - usage
        - runtime_timing
        - machine
        - start
        - source
        - created_at
        - updated_at
        - binding
        - save_to_github
        - latest_message_revision
        - reasoning_effort
        - archived_at
        - pinned_at
        - head_branch
        - pr_review_mode
        - source_metadata
        - latest_status_message
        - conversation
        - can
        - run_context
        - error
        - completed_at
      type: object
    TaskProcessing:
      additionalProperties: false
      properties:
        agent_type:
          anyOf:
            - $ref: '#/components/schemas/AgentType'
            - type: 'null'
        archived_at:
          format: date-time
          type:
            - string
            - 'null'
        auto_fix_ci:
          type: boolean
        auto_fix_pr_comments:
          type: boolean
        auto_rebase:
          type: boolean
        binding:
          anyOf:
            - $ref: '#/components/schemas/TaskRepositoryBinding'
            - type: 'null'
        campaign:
          anyOf:
            - $ref: '#/components/schemas/TaskCampaignSummary'
            - type: 'null'
        can:
          $ref: '#/components/schemas/TaskAbilities'
        conversation:
          $ref: '#/components/schemas/TaskConversation'
        created_at:
          format: date-time
          type: string
        creator_reauth_required:
          type: boolean
        head_branch:
          minLength: 1
          type:
            - string
            - 'null'
        id:
          format: uuid
          type: string
        interaction_mode:
          pattern: ^[a-z][a-z0-9_]{0,31}$
          type:
            - string
            - 'null'
        latest_message_revision:
          description: >-
            Maximum revision_sequence of currently stored task messages,
            including soft-deleted rows; zero means no messages. Compare
            equality only: hard deletion can decrease it. Not an activity/stream
            cursor or a task-wide version.
          format: int64
          maximum: 9007199254740991
          minimum: 0
          type: integer
        latest_status_message:
          type:
            - string
            - 'null'
        machine:
          $ref: '#/components/schemas/TaskMachine'
        merge_when_ready:
          description: >-
            Whether the task merges its own published pull request once it is
            ready: external CI green, Aether Review's APPROVE at the exact head,
            no unresolved review thread and the task idle.
          type: boolean
        model:
          minLength: 1
          type:
            - string
            - 'null'
        name:
          minLength: 1
          type: string
        org_id:
          pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$
          type: string
        outcome:
          description: >-
            The one word a client renders for the task: its lifecycle rolled up
            with its pull request's state. status is the lifecycle alone.
          enum:
            - running
            - awaiting_input
            - approved
            - awaiting_ci
            - merged
            - unmerged
            - errored
            - archived
          type: string
        parent_task_id:
          format: uuid
          type:
            - string
            - 'null'
        pinned_at:
          format: date-time
          type:
            - string
            - 'null'
        plan_progress:
          $ref: '#/components/schemas/TaskPlanProgress'
        post_pr_demo_video:
          type: boolean
        post_pr_screenshots:
          type: boolean
        pr_review_mode:
          enum:
            - review_only
            - fix_on_request
            - apply_fixes
          type:
            - string
            - 'null'
        pr_review_summary:
          anyOf:
            - $ref: '#/components/schemas/TaskPRReviewSummary'
            - type: 'null'
        primary_pull_request:
          anyOf:
            - $ref: '#/components/schemas/TaskPullRequest'
            - type: 'null'
        project:
          $ref: '#/components/schemas/TaskProjectContext'
        project_id:
          format: uuid
          type: string
        pull_requests:
          items:
            $ref: '#/components/schemas/TaskPullRequest'
          type: array
        reasoning_effort:
          pattern: ^[a-z][a-z0-9_]{0,31}$
          type:
            - string
            - 'null'
        review_subject_pull_request:
          anyOf:
            - $ref: '#/components/schemas/TaskReviewSubjectPullRequest'
            - type: 'null'
        run_context:
          $ref: '#/components/schemas/TaskRunContext'
        runs_on:
          anyOf:
            - $ref: '#/components/schemas/TaskRunsOn'
            - type: 'null'
        runtime_timing:
          $ref: '#/components/schemas/TaskRuntimeTiming'
        save_to_github:
          $ref: '#/components/schemas/TaskSaveToGitHub'
        source:
          $ref: '#/components/schemas/TaskSource'
        source_metadata:
          additionalProperties: true
          properties: {}
          type:
            - object
            - 'null'
        start:
          anyOf:
            - $ref: '#/components/schemas/TaskStart'
            - type: 'null'
        status:
          enum:
            - processing
          type: string
        updated_at:
          format: date-time
          type: string
        url:
          description: The task's page in the Aether web app.
          format: uri
          minLength: 1
          type: string
        usage:
          $ref: '#/components/schemas/TaskUsage'
        user_id:
          format: uuid
          type:
            - string
            - 'null'
      required:
        - id
        - url
        - org_id
        - project_id
        - project
        - parent_task_id
        - user_id
        - name
        - agent_type
        - model
        - interaction_mode
        - runs_on
        - auto_fix_ci
        - auto_fix_pr_comments
        - auto_rebase
        - post_pr_screenshots
        - post_pr_demo_video
        - merge_when_ready
        - status
        - outcome
        - pull_requests
        - primary_pull_request
        - review_subject_pull_request
        - pr_review_summary
        - campaign
        - creator_reauth_required
        - usage
        - runtime_timing
        - machine
        - start
        - source
        - created_at
        - updated_at
        - binding
        - save_to_github
        - latest_message_revision
        - reasoning_effort
        - archived_at
        - pinned_at
        - head_branch
        - pr_review_mode
        - source_metadata
        - latest_status_message
        - conversation
        - can
        - run_context
      type: object
    TaskQueued:
      additionalProperties: false
      properties:
        agent_type:
          anyOf:
            - $ref: '#/components/schemas/AgentType'
            - type: 'null'
        archived_at:
          format: date-time
          type:
            - string
            - 'null'
        auto_fix_ci:
          type: boolean
        auto_fix_pr_comments:
          type: boolean
        auto_rebase:
          type: boolean
        binding:
          anyOf:
            - $ref: '#/components/schemas/TaskRepositoryBinding'
            - type: 'null'
        campaign:
          anyOf:
            - $ref: '#/components/schemas/TaskCampaignSummary'
            - type: 'null'
        can:
          $ref: '#/components/schemas/TaskAbilities'
        conversation:
          $ref: '#/components/schemas/TaskConversation'
        created_at:
          format: date-time
          type: string
        creator_reauth_required:
          type: boolean
        head_branch:
          minLength: 1
          type:
            - string
            - 'null'
        id:
          format: uuid
          type: string
        interaction_mode:
          pattern: ^[a-z][a-z0-9_]{0,31}$
          type:
            - string
            - 'null'
        latest_message_revision:
          description: >-
            Maximum revision_sequence of currently stored task messages,
            including soft-deleted rows; zero means no messages. Compare
            equality only: hard deletion can decrease it. Not an activity/stream
            cursor or a task-wide version.
          format: int64
          maximum: 9007199254740991
          minimum: 0
          type: integer
        latest_status_message:
          type:
            - string
            - 'null'
        machine:
          $ref: '#/components/schemas/TaskMachine'
        merge_when_ready:
          description: >-
            Whether the task merges its own published pull request once it is
            ready: external CI green, Aether Review's APPROVE at the exact head,
            no unresolved review thread and the task idle.
          type: boolean
        model:
          minLength: 1
          type:
            - string
            - 'null'
        name:
          minLength: 1
          type: string
        org_id:
          pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$
          type: string
        outcome:
          description: >-
            The one word a client renders for the task: its lifecycle rolled up
            with its pull request's state. status is the lifecycle alone.
          enum:
            - running
            - awaiting_input
            - approved
            - awaiting_ci
            - merged
            - unmerged
            - errored
            - archived
          type: string
        parent_task_id:
          format: uuid
          type:
            - string
            - 'null'
        pinned_at:
          format: date-time
          type:
            - string
            - 'null'
        plan_progress:
          $ref: '#/components/schemas/TaskPlanProgress'
        post_pr_demo_video:
          type: boolean
        post_pr_screenshots:
          type: boolean
        pr_review_mode:
          enum:
            - review_only
            - fix_on_request
            - apply_fixes
          type:
            - string
            - 'null'
        pr_review_summary:
          anyOf:
            - $ref: '#/components/schemas/TaskPRReviewSummary'
            - type: 'null'
        primary_pull_request:
          anyOf:
            - $ref: '#/components/schemas/TaskPullRequest'
            - type: 'null'
        project:
          $ref: '#/components/schemas/TaskProjectContext'
        project_id:
          format: uuid
          type: string
        pull_requests:
          items:
            $ref: '#/components/schemas/TaskPullRequest'
          type: array
        reasoning_effort:
          pattern: ^[a-z][a-z0-9_]{0,31}$
          type:
            - string
            - 'null'
        review_subject_pull_request:
          anyOf:
            - $ref: '#/components/schemas/TaskReviewSubjectPullRequest'
            - type: 'null'
        run_context:
          anyOf:
            - $ref: '#/components/schemas/TaskRunContext'
            - type: 'null'
        runs_on:
          anyOf:
            - $ref: '#/components/schemas/TaskRunsOn'
            - type: 'null'
        runtime_timing:
          $ref: '#/components/schemas/TaskRuntimeTiming'
        save_to_github:
          $ref: '#/components/schemas/TaskSaveToGitHub'
        source:
          $ref: '#/components/schemas/TaskSource'
        source_metadata:
          additionalProperties: true
          properties: {}
          type:
            - object
            - 'null'
        start:
          anyOf:
            - $ref: '#/components/schemas/TaskStart'
            - type: 'null'
        status:
          enum:
            - queued
          type: string
        updated_at:
          format: date-time
          type: string
        url:
          description: The task's page in the Aether web app.
          format: uri
          minLength: 1
          type: string
        usage:
          $ref: '#/components/schemas/TaskUsage'
        user_id:
          format: uuid
          type:
            - string
            - 'null'
      required:
        - id
        - url
        - org_id
        - project_id
        - project
        - parent_task_id
        - user_id
        - name
        - agent_type
        - model
        - interaction_mode
        - runs_on
        - auto_fix_ci
        - auto_fix_pr_comments
        - auto_rebase
        - post_pr_screenshots
        - post_pr_demo_video
        - merge_when_ready
        - status
        - outcome
        - pull_requests
        - primary_pull_request
        - review_subject_pull_request
        - pr_review_summary
        - campaign
        - creator_reauth_required
        - usage
        - runtime_timing
        - machine
        - start
        - source
        - created_at
        - updated_at
        - binding
        - save_to_github
        - latest_message_revision
        - reasoning_effort
        - archived_at
        - pinned_at
        - head_branch
        - pr_review_mode
        - source_metadata
        - latest_status_message
        - conversation
        - can
        - run_context
      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
    AgentType:
      description: >-
        The agent harness that runs a task, a profile or a connection:
        claude-code or claude_code is Claude Code, codex is Codex, opencode is
        OpenCode.
      enum:
        - codex
        - claude-code
        - opencode
        - claude_code
      type: string
    TaskAwaitingInputPayload:
      discriminator:
        mapping:
          message: '#/components/schemas/TaskAwaitingInputMessage'
          plan: '#/components/schemas/TaskAwaitingInputPlan'
          questions: '#/components/schemas/TaskAwaitingInputQuestions'
        propertyName: kind
      oneOf:
        - $ref: '#/components/schemas/TaskAwaitingInputMessage'
        - $ref: '#/components/schemas/TaskAwaitingInputQuestions'
        - $ref: '#/components/schemas/TaskAwaitingInputPlan'
    TaskRepositoryBinding:
      additionalProperties: false
      properties:
        base_branch:
          minLength: 1
          pattern: \S
          type: string
        bound_at:
          format: date-time
          type: string
      required:
        - base_branch
        - bound_at
      type: object
    TaskCampaignSummary:
      additionalProperties: false
      properties:
        active_descendants:
          format: int64
          minimum: 0
          type: integer
        attention:
          enum:
            - error
            - waiting
          type:
            - string
            - 'null'
        descendants_merged:
          format: int64
          minimum: 0
          type: integer
        descendants_total:
          format: int64
          minimum: 1
          type: integer
      required:
        - descendants_total
        - descendants_merged
        - active_descendants
        - attention
      type: object
    TaskAbilities:
      additionalProperties: false
      description: >-
        What the caller can do with the task as things stand, each ability
        computed for them and the kind of credential they hold: add_chat,
        starting a chat beside its main chat; rename, giving it a name; archive,
        archiving it and restoring it; pin, pinning it; change_pr_automation,
        its six pull-request switches (auto_fix_ci, auto_fix_pr_comments,
        auto_rebase, post_pr_screenshots, post_pr_demo_video, merge_when_ready),
        whose notes say when merge_when_ready cannot turn on; download,
        downloading its files; stop, stopping its main chat's turn; fork,
        carrying its main chat's work into a new task, in the cloud or, for a
        task on a computer, on a computer; connect_live, opening a live
        connection to its machine (connectTask), available for a stopped
        sandbox, which the connection can start. The operation an ability
        governs refuses with the code and sentence the ability shows. A download
        may still be refused by what only its workspace knows:
        task_has_no_files, task_branch_missing and workspace_outdated; a live
        connection by what only the call knows: live_protocol_unsupported,
        too_many_live_connections, and the account's standing when it starts a
        sandbox.
      properties:
        add_chat:
          $ref: '#/components/schemas/Ability'
        archive:
          $ref: '#/components/schemas/Ability'
        change_pr_automation:
          $ref: '#/components/schemas/Ability'
        connect_live:
          $ref: '#/components/schemas/Ability'
        download:
          $ref: '#/components/schemas/Ability'
        fork:
          $ref: '#/components/schemas/Ability'
        pin:
          $ref: '#/components/schemas/Ability'
        rename:
          $ref: '#/components/schemas/Ability'
        stop:
          $ref: '#/components/schemas/Ability'
      required:
        - add_chat
        - archive
        - change_pr_automation
        - connect_live
        - download
        - fork
        - pin
        - rename
        - stop
      type: object
    TaskConversation:
      additionalProperties: false
      properties:
        active_turn_id:
          format: uuid
          not:
            enum:
              - 00000000-0000-0000-0000-000000000000
          type:
            - string
            - 'null'
        processing_started_at:
          format: date-time
          type:
            - string
            - 'null'
      required:
        - active_turn_id
        - processing_started_at
      type: object
    TaskMachine:
      description: >-
        Where the task runs: a cloud sandbox, or a folder on one of its
        creator's computers.
      discriminator:
        mapping:
          computer: '#/components/schemas/TaskMachineComputer'
          sandbox: '#/components/schemas/TaskMachineSandbox'
        propertyName: kind
      oneOf:
        - $ref: '#/components/schemas/TaskMachineSandbox'
        - $ref: '#/components/schemas/TaskMachineComputer'
    TaskPlanProgress:
      additionalProperties: false
      properties:
        completed:
          format: int64
          minimum: 0
          type: integer
        current_step:
          minLength: 1
          pattern: \S
          type: string
        total:
          format: int64
          minimum: 1
          type: integer
      required:
        - completed
        - total
      type: object
    TaskPRReviewSummary:
      additionalProperties: false
      properties:
        comment_count:
          format: int64
          minimum: 0
          type:
            - integer
            - 'null'
        pull_request_id:
          format: uuid
          type: string
        review_task_id:
          format: uuid
          type: string
        run_count:
          format: int64
          minimum: 1
          type: integer
        run_status:
          $ref: '#/components/schemas/ReviewRunStatus'
        severity_counts:
          $ref: '#/components/schemas/PRReviewSeverityCounts'
        summary_severity:
          $ref: '#/components/schemas/PRReviewSummarySeverity'
        verdict:
          $ref: '#/components/schemas/PRReviewSummaryVerdict'
      required:
        - review_task_id
        - pull_request_id
        - run_status
        - comment_count
        - run_count
      type: object
    TaskPullRequest:
      additionalProperties: false
      properties:
        additions:
          format: int64
          minimum: 0
          type: integer
        base_branch:
          description: >-
            The branch the pull request targets on GitHub now, which may differ
            from the task's base after a retarget. Absent while it is unknown:
            before the pull request is synced from GitHub, or for one recorded
            before the mirror with its state alone. Never present without state.
          minLength: 1
          type: string
        branch_name:
          minLength: 1
          type: string
        checks_failed:
          format: int64
          minimum: 0
          type: integer
        checks_passed:
          format: int64
          minimum: 0
          type: integer
        checks_total:
          format: int64
          minimum: 0
          type: integer
        ci_status:
          enum:
            - pending
            - passed
            - failed
          type: string
        commits:
          format: int64
          minimum: 0
          type: integer
        deletions:
          format: int64
          minimum: 0
          type: integer
        html_url:
          minLength: 1
          type: string
        lines_changed:
          format: int64
          minimum: 0
          type: integer
        merge_when_ready_blocker:
          additionalProperties: false
          description: >-
            Present on an open pull request whose task opts into
            merge_when_ready while the latest evaluation found its head blocked:
            blocker names the first unmet condition at head_sha, first found
            there at observed_at. no_aether_review_in_org, base_not_authorized
            and dependency_abandoned clear only when a person acts (turn on the
            project's review of its tasks' pull requests; retarget the pull
            request to the task's branch; reopen or unarchive the dependency,
            merge the pull request by hand, or spawn the task again), and the
            pull request carries a line saying so; every other blocker clears as
            CI, Aether Review, the task, its dependencies or GitHub move on. The
            dependency blockers concern a task spawned on top of other tasks,
            its dependencies: dependency_abandoned, a dependency will not merge
            by itself (its pull request was closed without merging or merged
            into another branch, or its task was archived without a merged pull
            request); dependency_unmerged, a dependency has not merged yet;
            dependency_left_out, every dependency has merged but the approval at
            head_sha was made before they did.
          properties:
            blocker:
              enum:
                - not_ready_for_merge
                - base_not_authorized
                - no_external_ci
                - no_aether_review_in_org
                - not_approved_at_head
                - unresolved_review_threads
                - dependency_abandoned
                - dependency_unmerged
                - dependency_left_out
                - task_running
                - not_cleanly_mergeable
              type: string
            head_sha:
              maxLength: 40
              minLength: 40
              pattern: ^[0-9a-f]{40}$
              type: string
            observed_at:
              format: date-time
              type: string
          required:
            - blocker
            - head_sha
            - observed_at
          type: object
        merged_at:
          format: date-time
          type: string
        pr_number:
          format: int64
          minimum: 1
          type: integer
        pull_request_id:
          format: uuid
          type: string
        state:
          enum:
            - open
            - closed
            - merged
          type: string
        title:
          type: string
      required:
        - pull_request_id
        - pr_number
        - html_url
        - title
        - checks_passed
        - checks_failed
        - checks_total
        - commits
        - lines_changed
        - additions
        - deletions
      type: object
    TaskProjectContext:
      discriminator:
        mapping:
          active: '#/components/schemas/TaskActiveProject'
          archived: '#/components/schemas/TaskArchivedProject'
        propertyName: state
      oneOf:
        - $ref: '#/components/schemas/TaskActiveProject'
        - $ref: '#/components/schemas/TaskArchivedProject'
    TaskReviewSubjectPullRequest:
      additionalProperties: false
      properties:
        additions:
          format: int64
          minimum: 0
          type: integer
        base_branch:
          description: >-
            The branch the pull request targets on GitHub now, which may differ
            from the task's base after a retarget. Absent while it is unknown:
            before the pull request is synced from GitHub, or for one recorded
            before the mirror with its state alone. Never present without state.
          minLength: 1
          type: string
        branch_name:
          minLength: 1
          type: string
        checks_failed:
          format: int64
          minimum: 0
          type: integer
        checks_passed:
          format: int64
          minimum: 0
          type: integer
        checks_total:
          format: int64
          minimum: 0
          type: integer
        ci_status:
          enum:
            - pending
            - passed
            - failed
          type: string
        commits:
          format: int64
          minimum: 0
          type: integer
        deletions:
          format: int64
          minimum: 0
          type: integer
        html_url:
          minLength: 1
          type: string
        lines_changed:
          format: int64
          minimum: 0
          type: integer
        merge_when_ready_blocker:
          additionalProperties: false
          description: >-
            Present on an open pull request whose task opts into
            merge_when_ready while the latest evaluation found its head blocked:
            blocker names the first unmet condition at head_sha, first found
            there at observed_at. no_aether_review_in_org, base_not_authorized
            and dependency_abandoned clear only when a person acts (turn on the
            project's review of its tasks' pull requests; retarget the pull
            request to the task's branch; reopen or unarchive the dependency,
            merge the pull request by hand, or spawn the task again), and the
            pull request carries a line saying so; every other blocker clears as
            CI, Aether Review, the task, its dependencies or GitHub move on. The
            dependency blockers concern a task spawned on top of other tasks,
            its dependencies: dependency_abandoned, a dependency will not merge
            by itself (its pull request was closed without merging or merged
            into another branch, or its task was archived without a merged pull
            request); dependency_unmerged, a dependency has not merged yet;
            dependency_left_out, every dependency has merged but the approval at
            head_sha was made before they did.
          properties:
            blocker:
              enum:
                - not_ready_for_merge
                - base_not_authorized
                - no_external_ci
                - no_aether_review_in_org
                - not_approved_at_head
                - unresolved_review_threads
                - dependency_abandoned
                - dependency_unmerged
                - dependency_left_out
                - task_running
                - not_cleanly_mergeable
              type: string
            head_sha:
              maxLength: 40
              minLength: 40
              pattern: ^[0-9a-f]{40}$
              type: string
            observed_at:
              format: date-time
              type: string
          required:
            - blocker
            - head_sha
            - observed_at
          type: object
        merged_at:
          format: date-time
          type: string
        origin_task_id:
          format: uuid
          type: string
        pr_number:
          format: int64
          minimum: 1
          type: integer
        pull_request_id:
          format: uuid
          type: string
        review_check_conclusion:
          enum:
            - success
            - failure
            - cancelled
            - neutral
          type: string
        review_trigger:
          enum:
            - automatic
            - comment_command
            - manual
          type: string
        state:
          enum:
            - open
            - closed
            - merged
          type: string
        title:
          type: string
      required:
        - pull_request_id
        - pr_number
        - html_url
        - title
        - checks_passed
        - checks_failed
        - checks_total
        - commits
        - lines_changed
        - additions
        - deletions
        - review_trigger
      type: object
    TaskRunContext:
      additionalProperties: false
      properties:
        started_at:
          format: date-time
          type: string
        workspace_id:
          format: uuid
          type: string
      required:
        - workspace_id
        - started_at
      type: object
    TaskRunsOn:
      discriminator:
        mapping:
          aether: '#/components/schemas/TaskRunsOnAether'
          disconnected: '#/components/schemas/TaskRunsOnDisconnected'
          stored: '#/components/schemas/TaskRunsOnStored'
        propertyName: runs_on
      oneOf:
        - $ref: '#/components/schemas/TaskRunsOnAether'
        - $ref: '#/components/schemas/TaskRunsOnStored'
        - $ref: '#/components/schemas/TaskRunsOnDisconnected'
    TaskRuntimeTiming:
      discriminator:
        mapping:
          active: '#/components/schemas/TaskRuntimeTimingActive'
          inactive: '#/components/schemas/TaskRuntimeTimingInactive'
        propertyName: state
      oneOf:
        - $ref: '#/components/schemas/TaskRuntimeTimingInactive'
        - $ref: '#/components/schemas/TaskRuntimeTimingActive'
    TaskSaveToGitHub:
      enum:
        - offered
        - saved
        - not_started
        - agent_child
        - bound_at_creation
      type: string
    TaskSource:
      enum:
        - manual
        - web
        - mobile
        - cli
        - ci
        - sentry
        - linear
        - slack
        - automation
        - pr_review
        - teleport
        - agent
        - delegation
      type: string
    TaskStart:
      description: >-
        What still has to happen before the task's first turn runs: on its
        computer, or, for a task forked from a chat on a computer, on that
        computer, which hands the chat's work over. null for any other cloud
        task, for a person's own checkout, and once the first run has started or
        ended.
      discriminator:
        mapping:
          failed: '#/components/schemas/TaskStartFailed'
          pending: '#/components/schemas/TaskStartPending'
        propertyName: state
      oneOf:
        - $ref: '#/components/schemas/TaskStartPending'
        - $ref: '#/components/schemas/TaskStartFailed'
    TaskUsage:
      additionalProperties: false
      properties:
        tokens_in:
          format: int64
          maximum: 9007199254740991
          minimum: 0
          type: integer
        tokens_out:
          format: int64
          maximum: 9007199254740991
          minimum: 0
          type: integer
        vm_uptime_seconds:
          format: int64
          minimum: 0
          type: integer
      required:
        - tokens_in
        - tokens_out
        - vm_uptime_seconds
      type: object
    TaskFailure:
      additionalProperties: false
      properties:
        org_id:
          format: uuid
          type: string
        reason:
          $ref: '#/components/schemas/TaskFailureReason'
      required:
        - reason
        - org_id
      type: object
    TaskAwaitingInputMessage:
      additionalProperties: false
      properties:
        idle_compaction:
          $ref: '#/components/schemas/TaskIdleCompaction'
        kind:
          enum:
            - message
          type: string
      required:
        - kind
      type: object
    TaskAwaitingInputPlan:
      additionalProperties: false
      properties:
        input:
          $ref: '#/components/schemas/ProposePlanToolInput'
        kind:
          enum:
            - plan
          type: string
        tool_id:
          minLength: 1
          type: string
      required:
        - kind
        - tool_id
        - input
      type: object
    TaskAwaitingInputQuestions:
      additionalProperties: false
      properties:
        input:
          $ref: '#/components/schemas/AskUserToolInput'
        kind:
          enum:
            - questions
          type: string
        tool_id:
          minLength: 1
          type: string
      required:
        - kind
        - tool_id
        - input
      type: object
    Ability:
      discriminator:
        mapping:
          available: '#/components/schemas/AbilityAvailable'
          not_now: '#/components/schemas/AbilityNotNow'
          not_permitted: '#/components/schemas/AbilityNotPermitted'
          unsupported: '#/components/schemas/AbilityUnsupported'
        propertyName: availability
      oneOf:
        - $ref: '#/components/schemas/AbilityAvailable'
        - $ref: '#/components/schemas/AbilityNotNow'
        - $ref: '#/components/schemas/AbilityUnsupported'
        - $ref: '#/components/schemas/AbilityNotPermitted'
    TaskMachineComputer:
      additionalProperties: false
      description: >-
        The task runs in a folder on one of its creator's computers, on the
        branch last seen there, null while none is known.
      properties:
        branch:
          maxLength: 255
          minLength: 1
          pattern: "^[^\\0- \\x7f-\\xa0  - \L\P  　]+$"
          type:
            - string
            - 'null'
          x-aether-string-length-unit: unicode-code-point
        computer_id:
          format: uuid
          type: string
        computer_name:
          description: The computer's name, which every reader of the task sees.
          maxLength: 100
          minLength: 1
          type: string
          x-aether-string-length-unit: unicode-code-point
        folder:
          maxLength: 4096
          minLength: 1
          pattern: ^/
          type: string
          x-aether-string-length-unit: unicode-code-point
        folder_kind:
          $ref: '#/components/schemas/TaskFolderKind'
        kind:
          enum:
            - computer
          type: string
        reachable:
          description: >-
            Whether the computer's machine bridge is connected, which every
            reader of the task sees.
          type: boolean
      required:
        - kind
        - computer_id
        - computer_name
        - reachable
        - folder
        - branch
        - folder_kind
      type: object
    TaskMachineSandbox:
      additionalProperties: false
      description: The task runs in a cloud sandbox of this hardware.
      properties:
        hardware:
          $ref: '#/components/schemas/HardwareConfig'
        kind:
          enum:
            - sandbox
          type: string
      required:
        - kind
        - hardware
      type: object
    ReviewRunStatus:
      enum:
        - reviewing
        - completed
        - failed
        - cancelled
        - superseded
        - archived
      type: string
    PRReviewSeverityCounts:
      additionalProperties: false
      properties:
        confirmed:
          format: int64
          minimum: 0
          type: integer
        nit:
          format: int64
          minimum: 0
          type: integer
        p1:
          format: int64
          minimum: 0
          type: integer
        p2:
          format: int64
          minimum: 0
          type: integer
        question:
          format: int64
          minimum: 0
          type: integer
      required:
        - p1
        - p2
        - nit
        - question
        - confirmed
      type: object
    PRReviewSummarySeverity:
      enum:
        - p1
        - p2
        - nit
      type: string
    PRReviewSummaryVerdict:
      enum:
        - approve
        - request_changes
        - comment
        - dismissed
        - superseded
      type: string
    TaskActiveProject:
      additionalProperties: false
      properties:
        name:
          minLength: 1
          pattern: \S
          type: string
        repository:
          anyOf:
            - $ref: '#/components/schemas/ProjectRepository'
            - type: 'null'
        state:
          enum:
            - active
          type: string
      required:
        - state
        - name
        - repository
      type: object
    TaskArchivedProject:
      additionalProperties: false
      properties:
        state:
          enum:
            - archived
          type: string
      required:
        - state
      type: object
    TaskRunsOnAether:
      additionalProperties: false
      properties:
        runs_on:
          enum:
            - aether
          type: string
      required:
        - runs_on
      type: object
    TaskRunsOnDisconnected:
      additionalProperties: false
      properties:
        runs_on:
          enum:
            - disconnected
          type: string
      required:
        - runs_on
      type: object
    TaskRunsOnStored:
      additionalProperties: false
      properties:
        id:
          format: uuid
          type: string
        name:
          minLength: 1
          type: string
        option:
          enum:
            - claude_plan
            - anthropic_api_key
            - chatgpt_plan
            - openai_api_key
            - openrouter_api_key
            - opencode_auth_file
          type: string
        runs_on:
          enum:
            - stored
          type: string
      required:
        - runs_on
        - id
        - option
        - name
      type: object
    TaskRuntimeTimingActive:
      additionalProperties: false
      properties:
        active_started_at:
          format: date-time
          type: string
        state:
          enum:
            - active
          type: string
      required:
        - state
        - active_started_at
      type: object
    TaskRuntimeTimingInactive:
      additionalProperties: false
      properties:
        state:
          enum:
            - inactive
          type: string
      required:
        - state
      type: object
    TaskStartFailed:
      additionalProperties: false
      description: >-
        The start failed: on the computer, checkout_missing,
        base_branch_unreachable, work_tree_failed or session_unplaced; ended by
        Aether, cancelled, hold_expired, credential_ended, computer_removed or
        computer_cli_outdated. A task forked from a chat on a computer whose
        work was not handed over: hand_over_missed, session_file_missing,
        checkout_unavailable, turn_running, ship_failed, credential_named_file,
        push_failed, chat_moved, too_large, create_refused (its message the
        refusal's own), cancelled, computer_removed or computer_cli_outdated.
      properties:
        failure:
          $ref: '#/components/schemas/TaskStartReason'
        state:
          enum:
            - failed
          type: string
      required:
        - state
        - failure
      type: object
    TaskStartPending:
      additionalProperties: false
      description: >-
        The start is under way or held back: making_work_tree while the computer
        makes the task's work tree; placing_session while it makes a fork's and
        places the forked session in it; computer_unreachable while the
        computer's machine bridge is not connected (its message says what to run
        there while the computer needs setting up or its aether CLI is too old);
        agent_starts_off while the computer does not let Aether start agents;
        and, once the work tree is made, starting_agent until the computer asks
        to run the first turn, then what holds that run back: agent_limit,
        not_signed_in, agent_not_installed, chat_busy or open_in_terminal. A
        task forked from a chat on a computer, in a sandbox or on a computer,
        waits first on that computer: turn_running while the chat's turn runs
        there, then handing_over while the computer hands the chat's work over.
      properties:
        state:
          enum:
            - pending
          type: string
        waiting:
          $ref: '#/components/schemas/TaskStartReason'
      required:
        - state
        - waiting
      type: object
    TaskFailureReason:
      enum:
        - inference_balance_empty
        - runtime_credits_exhausted
      type: string
    TaskIdleCompaction:
      additionalProperties: false
      description: >-
        Present while Aether will compact the waiting task's idle conversation:
        at fires_at, just before the prompt cache of the turn that left it idle
        at idle_since expires, it replaces the context_tokens-token conversation
        with a summary. Absent when none is scheduled, a newer turn superseded
        it, the person kept the full context (keepTaskFullContext), or it fired
        or was skipped.
      properties:
        context_tokens:
          format: int64
          maximum: 9007199254740991
          minimum: 1
          type: integer
        fires_at:
          format: date-time
          type: string
        idle_since:
          format: date-time
          type: string
      required:
        - idle_since
        - fires_at
        - context_tokens
      type: object
    ProposePlanToolInput:
      additionalProperties: true
      properties:
        plan:
          type: string
        summary:
          type: string
      required:
        - summary
        - plan
      type: object
    AskUserToolInput:
      additionalProperties: true
      properties:
        questions:
          items:
            $ref: '#/components/schemas/AskUserQuestion'
          minItems: 1
          type: array
      required:
        - questions
      type: object
    AbilityAvailable:
      additionalProperties: false
      description: The action will be carried out.
      properties:
        availability:
          enum:
            - available
          type: string
        notes:
          description: >-
            What a person reads before taking the action; empty when there is
            nothing to note.
          items:
            $ref: '#/components/schemas/AbilityMessage'
          type: array
      required:
        - availability
        - notes
      type: object
    AbilityNotNow:
      additionalProperties: false
      description: The action is possible for this chat or task, but not as things stand.
      properties:
        availability:
          enum:
            - not_now
          type: string
        reason:
          $ref: '#/components/schemas/AbilityMessage'
      required:
        - availability
        - reason
      type: object
    AbilityNotPermitted:
      additionalProperties: false
      description: The caller may not take the action.
      properties:
        availability:
          enum:
            - not_permitted
          type: string
        reason:
          $ref: '#/components/schemas/AbilityMessage'
      required:
        - availability
        - reason
      type: object
    AbilityUnsupported:
      additionalProperties: false
      description: >-
        The action is not possible for this chat or task as it is, and nothing
        the person does here changes that.
      properties:
        availability:
          enum:
            - unsupported
          type: string
        reason:
          $ref: '#/components/schemas/AbilityMessage'
      required:
        - availability
        - reason
      type: object
    TaskFolderKind:
      additionalProperties: false
      description: >-
        The kind of the task's folder: checkout, the person's own checkout,
        which only they see; aether_made, a work tree Aether made, which the
        organization sees. label is what a client shows for it.
      properties:
        code:
          enum:
            - checkout
            - aether_made
          type: string
        label:
          minLength: 1
          pattern: \S
          type: string
      required:
        - code
        - label
      type: object
    HardwareConfig:
      additionalProperties: false
      properties:
        cpu_kind:
          enum:
            - shared
            - performance
          type: string
        cpus:
          format: int64
          maximum: 16
          minimum: 1
          type: integer
        gpu_kind:
          enum:
            - a10
            - l40s
            - a100-40gb
            - a100-80gb
          type:
            - string
            - 'null'
        memory_mb:
          format: int64
          maximum: 32768
          minimum: 256
          type: integer
        volume_size_gb:
          format: int64
          maximum: 500
          minimum: 1
          type: integer
      required:
        - cpu_kind
        - cpus
        - memory_mb
        - volume_size_gb
        - gpu_kind
      type: object
    ProjectRepository:
      additionalProperties: false
      description: >-
        A project's one linked GitHub repository: its identity and the state of
        the link that reaches it.
      properties:
        default_branch:
          minLength: 1
          pattern: \S
          type: string
        github_repo_id:
          format: int64
          maximum: 9007199254740991
          minimum: 1
          type: integer
        link:
          $ref: '#/components/schemas/ProjectRepositoryLink'
        name:
          minLength: 1
          pattern: \S
          type: string
        owner:
          minLength: 1
          pattern: \S
          type: string
        url:
          minLength: 1
          pattern: \S
          type: string
      required:
        - url
        - owner
        - name
        - github_repo_id
        - default_branch
        - link
      type: object
    TaskStartReason:
      additionalProperties: false
      description: What a start waits on or why it failed, as a code and a sentence.
      properties:
        code:
          description: >-
            What the start waits on or why it failed. The set of codes is open:
            a client shows the message of a code it does not know.
          pattern: ^[a-z][a-z0-9_]*$
          type: string
        message:
          description: A plain-text sentence the API writes for the task's readers.
          maxLength: 200
          minLength: 1
          type: string
          x-aether-string-length-unit: unicode-code-point
      required:
        - code
        - message
      type: object
    AskUserQuestion:
      additionalProperties: false
      properties:
        header:
          type: string
        id:
          type: string
        multi_select:
          type: boolean
        options:
          items:
            $ref: '#/components/schemas/AskUserQuestionOption'
          type: array
        question:
          minLength: 1
          pattern: \S
          type: string
      required:
        - question
        - options
      type: object
    AbilityMessage:
      additionalProperties: false
      description: >-
        A note on an available ability, or the reason a refused ability is
        refused.
      properties:
        code:
          description: >-
            What the note or reason is, as a code a client may branch on. An
            open set: a client shows the message of a code it does not know.
          pattern: ^[a-z][a-z0-9_]*$
          type: string
        message:
          description: A full sentence in plain text, written for the person who reads it.
          maxLength: 200
          minLength: 1
          type: string
          x-aether-string-length-unit: unicode-code-point
      required:
        - code
        - message
      type: object
    ProjectRepositoryLink:
      description: >-
        The link state: connected through the installation that reaches the
        repository, or disconnected while the repository identity is kept.
      discriminator:
        mapping:
          connected: '#/components/schemas/ProjectRepositoryLinkConnected'
          disconnected: '#/components/schemas/ProjectRepositoryLinkDisconnected'
        propertyName: state
      oneOf:
        - $ref: '#/components/schemas/ProjectRepositoryLinkConnected'
        - $ref: '#/components/schemas/ProjectRepositoryLinkDisconnected'
    AskUserQuestionOption:
      additionalProperties: false
      properties:
        description:
          type: string
        label:
          minLength: 1
          pattern: \S
          type: string
        preview:
          type: string
      required:
        - label
      type: object
    ProjectRepositoryLinkConnected:
      additionalProperties: false
      properties:
        installation_id:
          format: int64
          maximum: 9007199254740991
          minimum: 1
          type: integer
        state:
          enum:
            - connected
          type: string
      required:
        - state
        - installation_id
      type: object
    ProjectRepositoryLinkDisconnected:
      additionalProperties: false
      properties:
        state:
          enum:
            - disconnected
          type: string
      required:
        - state
      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.