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

# Read a message sent to a task

> Reads one message sent to a task, as it stands now: held by Aether, on its way, with the agent, in the conversation, or never delivered and why. It changes nothing.

Use this tool when you need to:
- Follow a message you sent until it reaches the agent
- Tell why a message did not reach the agent, and whether sending it again is safe

Examples:
- GET /tasks/{taskID}/messages/{messageID}
- GET /tasks/6f1c2a9e-3b7d-4c55-9a2e-0d8b1f4e7c21/messages/2f8c4d1a-7b3e-4a9f-8c2d-5e6f7a8b9c0d

Hints:
- messageID is the id respondTaskChat or respondToTask answered for the message.
- state queued: Aether holds it, and waiting says why; on a computer expires_at is its deadline. sent: it left Aether, and waiting says where it is. accepted, processing, done: the conversation shows it, in its turn. not_delivered: it never reached the agent, and failure says why; sending it again, as a new message, is safe. unknown: it may have reached the agent, whose record did not show it in time; Aether never sends it again.
- A message of a chat the caller cannot read is 404, as is one taken back: a session a person started in their own terminal is theirs alone.
- Any member of the task's organization may read it, a viewer included; a billing member is refused with 403 org_role_insufficient, a suspended organization with 403 org_suspended, and a task or chat outside the caller's reach is 404 not_found; 503 when the membership check is unavailable.



## OpenAPI

````yaml api-reference/openapi.json GET /tasks/{taskID}/messages/{messageID}
openapi: 3.1.0
info:
  title: Aether API
  version: 0.1.0
servers:
  - url: https://api.runaether.dev
security:
  - bearerAuth: []
paths:
  /tasks/{taskID}/messages/{messageID}:
    get:
      tags:
        - tasks
      summary: Read a message sent to a task
      description: >-
        Reads one message sent to a task, as it stands now: held by Aether, on
        its way, with the agent, in the conversation, or never delivered and
        why. It changes nothing.


        Use this tool when you need to:

        - Follow a message you sent until it reaches the agent

        - Tell why a message did not reach the agent, and whether sending it
        again is safe


        Examples:

        - GET /tasks/{taskID}/messages/{messageID}

        - GET
        /tasks/6f1c2a9e-3b7d-4c55-9a2e-0d8b1f4e7c21/messages/2f8c4d1a-7b3e-4a9f-8c2d-5e6f7a8b9c0d


        Hints:

        - messageID is the id respondTaskChat or respondToTask answered for the
        message.

        - state queued: Aether holds it, and waiting says why; on a computer
        expires_at is its deadline. sent: it left Aether, and waiting says where
        it is. accepted, processing, done: the conversation shows it, in its
        turn. not_delivered: it never reached the agent, and failure says why;
        sending it again, as a new message, is safe. unknown: it may have
        reached the agent, whose record did not show it in time; Aether never
        sends it again.

        - A message of a chat the caller cannot read is 404, as is one taken
        back: a session a person started in their own terminal is theirs alone.

        - Any member of the task's organization may read it, a viewer included;
        a billing member is refused with 403 org_role_insufficient, a suspended
        organization with 403 org_suspended, and a task or chat outside the
        caller's reach is 404 not_found; 503 when the membership check is
        unavailable.
      operationId: getTaskMessage
      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
        - in: path
          name: messageID
          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/TaskUserMessage'
          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'
          description: Forbidden
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TasksErrorResponse'
          description: Not Found
        '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:
    TaskUserMessage:
      discriminator:
        mapping:
          accepted: '#/components/schemas/TaskUserMessageAccepted'
          done: '#/components/schemas/TaskUserMessageDone'
          not_delivered: '#/components/schemas/TaskUserMessageNotDelivered'
          processing: '#/components/schemas/TaskUserMessageProcessing'
          queued: '#/components/schemas/TaskUserMessageQueued'
          sent: '#/components/schemas/TaskUserMessageSent'
          unknown: '#/components/schemas/TaskUserMessageUnknown'
        propertyName: state
      oneOf:
        - $ref: '#/components/schemas/TaskUserMessageQueued'
        - $ref: '#/components/schemas/TaskUserMessageSent'
        - $ref: '#/components/schemas/TaskUserMessageAccepted'
        - $ref: '#/components/schemas/TaskUserMessageProcessing'
        - $ref: '#/components/schemas/TaskUserMessageDone'
        - $ref: '#/components/schemas/TaskUserMessageNotDelivered'
        - $ref: '#/components/schemas/TaskUserMessageUnknown'
    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
    TaskUserMessageAccepted:
      additionalProperties: false
      description: >-
        Taken into a running turn without being its root: admitted as live
        input, or bundled with the root.
      properties:
        attachments:
          items:
            $ref: '#/components/schemas/ConversationAttachment'
          type: array
        client_message_id:
          format: uuid
          type: string
        created_at:
          format: date-time
          type: string
        id:
          description: >-
            A task message's id: a uuid for a message the API queued or a chat
            forked inside its task copied, or a key derived from the message's
            source (an assistant message, a seam, a message replayed from an
            imported session).
          pattern: >-
            ^(?:[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}|message:[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}:(?:text|thinking):[0-9a-f]{64}|implicit:[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}:(?:text|thinking):[0-9]+|seam:compaction:[^:]+:[^:]+|seam:teleport:\S(?:[\s\S]*\S)?|teleport:\S(?:[\s\S]*\S)?:[0-9]{6,})$
          type: string
        kind:
          enum:
            - user
          type: string
        message_event:
          $ref: '#/components/schemas/TimelineMessageEventCard'
        sender:
          $ref: '#/components/schemas/TaskPerson'
        sequence:
          description: >-
            The message's place in the conversation; null until a turn has
            delivered it.
          format: int64
          maximum: 9007199254740991
          minimum: 0
          type:
            - integer
            - 'null'
        state:
          enum:
            - accepted
          type: string
        text:
          type: string
        tool_response:
          discriminator:
            mapping:
              ask_user: '#/components/schemas/AskUserToolResponse'
              propose_plan: '#/components/schemas/ProposePlanToolResponse'
            propertyName: tool_name
          oneOf:
            - $ref: '#/components/schemas/AskUserToolResponse'
            - $ref: '#/components/schemas/ProposePlanToolResponse'
        turn_id:
          description: >-
            The conversation turn the message is part of; null while it is
            queued.
          format: uuid
          type:
            - string
            - 'null'
      required:
        - kind
        - id
        - turn_id
        - sequence
        - state
        - text
        - attachments
        - created_at
      type: object
    TaskUserMessageDone:
      additionalProperties: false
      description: Delivered, and its turn ended.
      properties:
        attachments:
          items:
            $ref: '#/components/schemas/ConversationAttachment'
          type: array
        client_message_id:
          format: uuid
          type: string
        created_at:
          format: date-time
          type: string
        id:
          description: >-
            A task message's id: a uuid for a message the API queued or a chat
            forked inside its task copied, or a key derived from the message's
            source (an assistant message, a seam, a message replayed from an
            imported session).
          pattern: >-
            ^(?:[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}|message:[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}:(?:text|thinking):[0-9a-f]{64}|implicit:[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}:(?:text|thinking):[0-9]+|seam:compaction:[^:]+:[^:]+|seam:teleport:\S(?:[\s\S]*\S)?|teleport:\S(?:[\s\S]*\S)?:[0-9]{6,})$
          type: string
        kind:
          enum:
            - user
          type: string
        message_event:
          $ref: '#/components/schemas/TimelineMessageEventCard'
        sender:
          $ref: '#/components/schemas/TaskPerson'
        sequence:
          description: >-
            The message's place in the conversation; null until a turn has
            delivered it.
          format: int64
          maximum: 9007199254740991
          minimum: 0
          type:
            - integer
            - 'null'
        state:
          enum:
            - done
          type: string
        text:
          type: string
        tool_response:
          discriminator:
            mapping:
              ask_user: '#/components/schemas/AskUserToolResponse'
              propose_plan: '#/components/schemas/ProposePlanToolResponse'
            propertyName: tool_name
          oneOf:
            - $ref: '#/components/schemas/AskUserToolResponse'
            - $ref: '#/components/schemas/ProposePlanToolResponse'
        turn_id:
          description: >-
            The conversation turn the message is part of; null while it is
            queued.
          format: uuid
          type:
            - string
            - 'null'
      required:
        - kind
        - id
        - turn_id
        - sequence
        - state
        - text
        - attachments
        - created_at
      type: object
    TaskUserMessageNotDelivered:
      additionalProperties: false
      description: >-
        The message never reached the agent. Sending it again, as a new message,
        is safe.
      properties:
        attachments:
          items:
            $ref: '#/components/schemas/ConversationAttachment'
          type: array
        client_message_id:
          format: uuid
          type: string
        created_at:
          format: date-time
          type: string
        failure:
          $ref: '#/components/schemas/MessageFailure'
        id:
          description: >-
            A task message's id: a uuid for a message the API queued or a chat
            forked inside its task copied, or a key derived from the message's
            source (an assistant message, a seam, a message replayed from an
            imported session).
          pattern: >-
            ^(?:[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}|message:[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}:(?:text|thinking):[0-9a-f]{64}|implicit:[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}:(?:text|thinking):[0-9]+|seam:compaction:[^:]+:[^:]+|seam:teleport:\S(?:[\s\S]*\S)?|teleport:\S(?:[\s\S]*\S)?:[0-9]{6,})$
          type: string
        kind:
          enum:
            - user
          type: string
        meaning:
          description: >-
            What the message's state means for the person, and whether sending
            it again is safe: the sentence to show beside it.
          minLength: 1
          type: string
        sequence:
          description: 'Null: the conversation does not show the message.'
          type: 'null'
        state:
          enum:
            - not_delivered
          type: string
        text:
          type: string
        turn_id:
          description: 'Null: the conversation does not show the message.'
          type: 'null'
      required:
        - kind
        - id
        - turn_id
        - sequence
        - state
        - text
        - attachments
        - created_at
        - failure
        - meaning
      type: object
    TaskUserMessageProcessing:
      additionalProperties: false
      description: The root of the turn running now.
      properties:
        attachments:
          items:
            $ref: '#/components/schemas/ConversationAttachment'
          type: array
        client_message_id:
          format: uuid
          type: string
        created_at:
          format: date-time
          type: string
        id:
          description: >-
            A task message's id: a uuid for a message the API queued or a chat
            forked inside its task copied, or a key derived from the message's
            source (an assistant message, a seam, a message replayed from an
            imported session).
          pattern: >-
            ^(?:[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}|message:[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}:(?:text|thinking):[0-9a-f]{64}|implicit:[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}:(?:text|thinking):[0-9]+|seam:compaction:[^:]+:[^:]+|seam:teleport:\S(?:[\s\S]*\S)?|teleport:\S(?:[\s\S]*\S)?:[0-9]{6,})$
          type: string
        kind:
          enum:
            - user
          type: string
        message_event:
          $ref: '#/components/schemas/TimelineMessageEventCard'
        sender:
          $ref: '#/components/schemas/TaskPerson'
        sequence:
          description: >-
            The message's place in the conversation; null until a turn has
            delivered it.
          format: int64
          maximum: 9007199254740991
          minimum: 0
          type:
            - integer
            - 'null'
        state:
          enum:
            - processing
          type: string
        text:
          type: string
        tool_response:
          discriminator:
            mapping:
              ask_user: '#/components/schemas/AskUserToolResponse'
              propose_plan: '#/components/schemas/ProposePlanToolResponse'
            propertyName: tool_name
          oneOf:
            - $ref: '#/components/schemas/AskUserToolResponse'
            - $ref: '#/components/schemas/ProposePlanToolResponse'
        turn_id:
          description: >-
            The conversation turn the message is part of; null while it is
            queued.
          format: uuid
          type:
            - string
            - 'null'
      required:
        - kind
        - id
        - turn_id
        - sequence
        - state
        - text
        - attachments
        - created_at
      type: object
    TaskUserMessageQueued:
      additionalProperties: false
      description: Aether holds the message, and it can be taken back.
      properties:
        attachments:
          items:
            $ref: '#/components/schemas/ConversationAttachment'
          type: array
        client_message_id:
          format: uuid
          type: string
        created_at:
          format: date-time
          type: string
        expires_at:
          description: >-
            When Aether stops holding the message, which then reads
            not_delivered with hold_expired; null in a cloud sandbox.
          format: date-time
          type:
            - string
            - 'null'
        id:
          description: >-
            A task message's id: a uuid for a message the API queued or a chat
            forked inside its task copied, or a key derived from the message's
            source (an assistant message, a seam, a message replayed from an
            imported session).
          pattern: >-
            ^(?:[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}|message:[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}:(?:text|thinking):[0-9a-f]{64}|implicit:[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}:(?:text|thinking):[0-9]+|seam:compaction:[^:]+:[^:]+|seam:teleport:\S(?:[\s\S]*\S)?|teleport:\S(?:[\s\S]*\S)?:[0-9]{6,})$
          type: string
        kind:
          enum:
            - user
          type: string
        message_event:
          $ref: '#/components/schemas/TimelineMessageEventCard'
        sender:
          $ref: '#/components/schemas/TaskPerson'
        sequence:
          description: 'Null: the conversation does not show the message.'
          type: 'null'
        state:
          enum:
            - queued
          type: string
        text:
          type: string
        tool_response:
          discriminator:
            mapping:
              ask_user: '#/components/schemas/AskUserToolResponse'
              propose_plan: '#/components/schemas/ProposePlanToolResponse'
            propertyName: tool_name
          oneOf:
            - $ref: '#/components/schemas/AskUserToolResponse'
            - $ref: '#/components/schemas/ProposePlanToolResponse'
        turn_id:
          description: 'Null: the conversation does not show the message.'
          type: 'null'
        waiting:
          $ref: '#/components/schemas/QueuedMessageWaiting'
        waits_for:
          $ref: '#/components/schemas/ChatTurnRef'
          description: >-
            The turn another chat of the task runs while the message waits: one
            turn runs at a time per workspace. Present exactly when waiting's
            code is other_chat_turn.
      required:
        - kind
        - id
        - turn_id
        - sequence
        - state
        - text
        - attachments
        - created_at
        - waiting
        - expires_at
      type: object
    TaskUserMessageSent:
      additionalProperties: false
      description: The message left Aether, and the agent's record does not show it yet.
      properties:
        attachments:
          items:
            $ref: '#/components/schemas/ConversationAttachment'
          type: array
        client_message_id:
          format: uuid
          type: string
        created_at:
          format: date-time
          type: string
        id:
          description: >-
            A task message's id: a uuid for a message the API queued or a chat
            forked inside its task copied, or a key derived from the message's
            source (an assistant message, a seam, a message replayed from an
            imported session).
          pattern: >-
            ^(?:[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}|message:[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}:(?:text|thinking):[0-9a-f]{64}|implicit:[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}:(?:text|thinking):[0-9]+|seam:compaction:[^:]+:[^:]+|seam:teleport:\S(?:[\s\S]*\S)?|teleport:\S(?:[\s\S]*\S)?:[0-9]{6,})$
          type: string
        kind:
          enum:
            - user
          type: string
        sequence:
          description: 'Null: the conversation does not show the message.'
          type: 'null'
        state:
          enum:
            - sent
          type: string
        text:
          type: string
        turn_id:
          description: 'Null: the conversation does not show the message.'
          type: 'null'
        waiting:
          $ref: '#/components/schemas/SentMessageWaiting'
      required:
        - kind
        - id
        - turn_id
        - sequence
        - state
        - text
        - attachments
        - created_at
        - waiting
      type: object
    TaskUserMessageUnknown:
      additionalProperties: false
      description: >-
        The message may have reached the agent, and the agent's record did not
        show it in time. Aether never sends it again.
      properties:
        attachments:
          items:
            $ref: '#/components/schemas/ConversationAttachment'
          type: array
        client_message_id:
          format: uuid
          type: string
        created_at:
          format: date-time
          type: string
        id:
          description: >-
            A task message's id: a uuid for a message the API queued or a chat
            forked inside its task copied, or a key derived from the message's
            source (an assistant message, a seam, a message replayed from an
            imported session).
          pattern: >-
            ^(?:[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}|message:[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}:(?:text|thinking):[0-9a-f]{64}|implicit:[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}:(?:text|thinking):[0-9]+|seam:compaction:[^:]+:[^:]+|seam:teleport:\S(?:[\s\S]*\S)?|teleport:\S(?:[\s\S]*\S)?:[0-9]{6,})$
          type: string
        kind:
          enum:
            - user
          type: string
        meaning:
          description: >-
            What the message's state means for the person, and whether sending
            it again is safe: the sentence to show beside it.
          minLength: 1
          type: string
        sequence:
          description: 'Null: the conversation does not show the message.'
          type: 'null'
        state:
          enum:
            - unknown
          type: string
        text:
          type: string
        turn_id:
          description: 'Null: the conversation does not show the message.'
          type: 'null'
      required:
        - kind
        - id
        - turn_id
        - sequence
        - state
        - text
        - attachments
        - created_at
        - meaning
      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
    ConversationAttachment:
      additionalProperties: false
      properties:
        filename:
          minLength: 1
          type: string
        index:
          maximum: 9
          minimum: 0
          type: integer
        media_type:
          minLength: 1
          type: string
        message_id:
          format: uuid
          type: string
        sha256:
          pattern: ^[0-9a-f]{64}$
          type: string
        task_id:
          format: uuid
          type: string
      required:
        - filename
        - media_type
        - task_id
        - message_id
        - index
        - sha256
      type: object
    TimelineMessageEventCard:
      discriminator:
        mapping:
          auto_rebase: '#/components/schemas/TimelineAutoRebaseMessageEvent'
          child_turn_result: '#/components/schemas/TimelineChildTurnResultMessageEvent'
          ci_failure: '#/components/schemas/TimelineCIFailureMessageEvent'
          external: '#/components/schemas/TimelineExternalMessageEvent'
          github_batch: '#/components/schemas/TimelineGitHubBatchMessageEvent'
          idle_compaction: '#/components/schemas/TimelineIdleCompactionMessageEvent'
          local_parent_message: '#/components/schemas/TimelineLocalParentMessageMessageEvent'
          parent_message: '#/components/schemas/TimelineParentMessageMessageEvent'
          peer_message: '#/components/schemas/TimelinePeerMessageMessageEvent'
          pr_comment: '#/components/schemas/TimelinePRCommentMessageEvent'
          pr_review: '#/components/schemas/TimelinePRReviewMessageEvent'
          task_signal_batch: '#/components/schemas/TimelineTaskSignalBatchMessageEvent'
          task_stopped: '#/components/schemas/TaskStoppedMessageEvent'
        propertyName: kind
      oneOf:
        - $ref: '#/components/schemas/TimelinePRCommentMessageEvent'
        - $ref: '#/components/schemas/TimelineCIFailureMessageEvent'
        - $ref: '#/components/schemas/TimelineAutoRebaseMessageEvent'
        - $ref: '#/components/schemas/TimelinePRReviewMessageEvent'
        - $ref: '#/components/schemas/TimelineExternalMessageEvent'
        - $ref: '#/components/schemas/TimelineGitHubBatchMessageEvent'
        - $ref: '#/components/schemas/TimelineParentMessageMessageEvent'
        - $ref: '#/components/schemas/TimelineTaskSignalBatchMessageEvent'
        - $ref: '#/components/schemas/TimelineChildTurnResultMessageEvent'
        - $ref: '#/components/schemas/TimelineLocalParentMessageMessageEvent'
        - $ref: '#/components/schemas/TimelineIdleCompactionMessageEvent'
        - $ref: '#/components/schemas/TimelinePeerMessageMessageEvent'
        - $ref: '#/components/schemas/TaskStoppedMessageEvent'
    TaskPerson:
      discriminator:
        mapping:
          github_account: '#/components/schemas/TaskGitHubPerson'
          user: '#/components/schemas/TaskUserPerson'
        propertyName: kind
      oneOf:
        - $ref: '#/components/schemas/TaskUserPerson'
        - $ref: '#/components/schemas/TaskGitHubPerson'
    AskUserToolResponse:
      additionalProperties: false
      properties:
        data:
          additionalProperties: false
          properties:
            answers:
              additionalProperties:
                items:
                  format: int64
                  minimum: -1
                  type: integer
                type: array
              type: object
            custom_answers:
              additionalProperties:
                type: string
              type: object
          required:
            - answers
          type: object
        tool_name:
          enum:
            - ask_user
          type: string
      required:
        - tool_name
        - data
      type: object
    ProposePlanToolResponse:
      additionalProperties: false
      properties:
        data:
          additionalProperties: false
          properties:
            approved:
              type: boolean
            feedback:
              type: string
          required:
            - approved
          type: object
        tool_name:
          enum:
            - propose_plan
          type: string
      required:
        - tool_name
        - data
      type: object
    MessageFailure:
      additionalProperties: false
      description: >-
        Why the message never reached the agent. hold_expired: Aether held it
        until its deadline. stopped: a stop ended it. chat_archived: its chat
        was archived. session_gone: the agent's session is gone.
        session_unreachable: the computer could not reach the session.
        slash_commands_unsupported: the computer runs no slash command sent from
        Aether. run_failed: the computer could not start its turn.
        credential_ended: the sign-in or API key it was sent with ended.
        computer_unreachable: its computer could not be reached before its
        hand-over expired. computer_cli_outdated: the computer's Aether CLI is
        too old to take it.
      properties:
        code:
          enum:
            - hold_expired
            - stopped
            - chat_archived
            - session_gone
            - session_unreachable
            - slash_commands_unsupported
            - run_failed
            - credential_ended
            - computer_unreachable
            - computer_cli_outdated
          type: string
        message:
          minLength: 1
          type: string
      required:
        - code
        - message
      type: object
    QueuedMessageWaiting:
      additionalProperties: false
      description: >-
        Why the message has not left Aether. turn_running: its chat's turn runs.
        other_chat_turn: another chat's turn runs, which waits_for names.
        earlier_message: an earlier message of its chat is on its way.
        computer_unreachable: its computer cannot be reached. chat_being_forked:
        its chat's work is being handed to a fork. open_in_terminal,
        agent_starts_off, agent_limit, chat_busy, not_signed_in,
        agent_not_installed: the computer holds its run back for that reason.
      properties:
        code:
          enum:
            - turn_running
            - other_chat_turn
            - earlier_message
            - computer_unreachable
            - chat_being_forked
            - open_in_terminal
            - agent_starts_off
            - agent_limit
            - chat_busy
            - not_signed_in
            - agent_not_installed
            - on_its_way
            - sandbox_not_ready
            - provider_overloaded
            - billing_blocked
            - org_task_concurrency_exceeded
            - credits_exhausted
            - workspace_run_unavailable
          type: string
        message:
          minLength: 1
          type: string
      required:
        - code
        - message
      type: object
    ChatTurnRef:
      additionalProperties: false
      description: >-
        One turn of one chat of a task. A queued message or chat names the turn
        another chat of its task runs: one turn runs at a time per workspace, so
        it runs after that turn.
      properties:
        chat_id:
          format: uuid
          type: string
        turn_id:
          format: uuid
          type: string
      required:
        - chat_id
        - turn_id
      type: object
    SentMessageWaiting:
      additionalProperties: false
      description: >-
        Where the message is. on_its_way: handed to the computer, whose agent
        has not taken it and which has not queued it behind a turn. with_agent:
        in the agent's inbox, or the prompt of a run that started.
      properties:
        code:
          enum:
            - on_its_way
            - with_agent
          type: string
        message:
          minLength: 1
          type: string
      required:
        - code
        - message
      type: object
    TimelineAutoRebaseMessageEvent:
      additionalProperties: false
      properties:
        base_branch:
          minLength: 1
          pattern: \S
          type: string
        branch:
          minLength: 1
          pattern: \S
          type: string
        head_sha:
          minLength: 1
          pattern: \S
          type: string
        kind:
          enum:
            - auto_rebase
          type: string
        mergeable_state:
          minLength: 1
          pattern: \S
          type: string
        pr_number:
          format: int64
          maximum: 9007199254740991
          minimum: 1
          type: integer
        reason:
          type: string
        repo:
          $ref: '#/components/schemas/MessageEventRepo'
        url:
          format: uri
          type: string
      required:
        - kind
        - repo
        - pr_number
      type: object
    TimelineChildTurnResultMessageEvent:
      additionalProperties: false
      properties:
        child_pr_number:
          format: int64
          maximum: 9007199254740991
          minimum: 1
          type: integer
        child_task_id:
          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
        child_task_name:
          minLength: 1
          pattern: \S
          type: string
        continuation:
          additionalProperties: false
          properties:
            tool:
              enum:
                - aether_read_task_messages
              type: string
          required:
            - tool
          type: object
        kind:
          enum:
            - child_turn_result
          type: string
        outcome:
          additionalProperties: false
          properties:
            content:
              minLength: 1
              pattern: \S
              type: string
            kind:
              enum:
                - response
                - question
                - error
                - pr_ready
              type: string
          required:
            - kind
            - content
          type: object
      required:
        - kind
        - child_task_id
        - outcome
        - child_task_name
      type: object
    TimelineCIFailureMessageEvent:
      additionalProperties: false
      properties:
        branch:
          minLength: 1
          pattern: \S
          type: string
        checks:
          items:
            additionalProperties: false
            properties:
              conclusion:
                minLength: 1
                pattern: \S
                type: string
              job_id:
                format: int64
                maximum: 9007199254740991
                minimum: 1
                type: integer
              name:
                minLength: 1
                pattern: \S
                type: string
              summary:
                type: string
            required:
              - name
              - conclusion
              - job_id
            type: object
          type: array
        kind:
          enum:
            - ci_failure
          type: string
        pr_number:
          format: int64
          maximum: 9007199254740991
          minimum: 1
          type: integer
        repo:
          $ref: '#/components/schemas/MessageEventRepo'
        url:
          format: uri
          type: string
      required:
        - kind
        - repo
        - pr_number
        - checks
      type: object
    TimelineExternalMessageEvent:
      additionalProperties: false
      properties:
        data:
          additionalProperties:
            type:
              - string
              - number
              - boolean
              - 'null'
          properties:
            actor:
              type: string
            context:
              type: string
            title:
              type: string
            url:
              type: string
          propertyNames:
            pattern: \S
            type: string
          type: object
        kind:
          enum:
            - external
          type: string
        source:
          enum:
            - slack
            - linear
            - sentry
            - email
          type: string
      required:
        - kind
        - source
      type: object
    TimelineGitHubBatchMessageEvent:
      additionalProperties: false
      properties:
        events:
          items:
            discriminator:
              mapping:
                ci_failure: '#/components/schemas/TimelineCIFailureMessageEvent'
                pr_comment: '#/components/schemas/TimelinePRCommentMessageEvent'
                pr_review: '#/components/schemas/TimelinePRReviewMessageEvent'
              propertyName: kind
            oneOf:
              - $ref: '#/components/schemas/TimelinePRCommentMessageEvent'
              - $ref: '#/components/schemas/TimelineCIFailureMessageEvent'
              - $ref: '#/components/schemas/TimelinePRReviewMessageEvent'
          minItems: 2
          type: array
        kind:
          enum:
            - github_batch
          type: string
      required:
        - kind
        - events
      type: object
    TimelineIdleCompactionMessageEvent:
      additionalProperties: false
      properties:
        kind:
          enum:
            - idle_compaction
          type: string
      required:
        - kind
      type: object
    TimelineLocalParentMessageMessageEvent:
      additionalProperties: false
      properties:
        client:
          enum:
            - claude-code
            - codex
            - personal-agent
            - mcp-connection
            - claude_code
            - personal_agent
            - mcp_connection
          type: string
        kind:
          enum:
            - local_parent_message
          type: string
        local_conversation_id:
          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
      required:
        - kind
        - local_conversation_id
        - client
      type: object
    TimelineParentMessageMessageEvent:
      additionalProperties: false
      properties:
        kind:
          enum:
            - parent_message
          type: string
        parent_task_id:
          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
        parent_task_name:
          minLength: 1
          pattern: \S
          type: string
      required:
        - kind
        - parent_task_id
        - parent_task_name
      type: object
    TimelinePeerMessageMessageEvent:
      additionalProperties: false
      properties:
        frame:
          enum:
            - cross_session
            - teammate
            - agent
          type: string
        from:
          minLength: 1
          pattern: \S
          type: string
        kind:
          enum:
            - peer_message
          type: string
        self_sent:
          type: boolean
      required:
        - kind
        - frame
        - self_sent
      type: object
    TimelinePRCommentMessageEvent:
      additionalProperties: false
      properties:
        action:
          minLength: 1
          pattern: \S
          type: string
        author:
          additionalProperties: false
          properties:
            association:
              minLength: 1
              pattern: \S
              type: string
            login:
              minLength: 1
              pattern: \S
              type: string
            type:
              minLength: 1
              pattern: \S
              type: string
          required:
            - login
          type: object
        body:
          minLength: 1
          pattern: \S
          type: string
        branch:
          minLength: 1
          pattern: \S
          type: string
        kind:
          enum:
            - pr_comment
          type: string
        line:
          format: int64
          maximum: 9007199254740991
          minimum: 1
          type: integer
        path:
          minLength: 1
          pattern: \S
          type: string
        pr_number:
          format: int64
          maximum: 9007199254740991
          minimum: 1
          type: integer
        repo:
          $ref: '#/components/schemas/MessageEventRepo'
        review_id:
          format: int64
          maximum: 9007199254740991
          minimum: 1
          type: integer
        review_state:
          minLength: 1
          pattern: \S
          type: string
        reviewer_task_id:
          format: uuid
          type: string
        url:
          format: uri
          type: string
      required:
        - kind
        - repo
        - pr_number
        - author
        - body
      type: object
    TimelinePRReviewMessageEvent:
      additionalProperties: false
      properties:
        action:
          enum:
            - opened
            - synchronize
            - ready_for_review
            - aether_review_comment
            - manual
          type: string
        branch:
          minLength: 1
          pattern: \S
          type: string
        head_sha:
          minLength: 1
          pattern: \S
          type: string
        kind:
          enum:
            - pr_review
          type: string
        pr_number:
          format: int64
          maximum: 9007199254740991
          minimum: 1
          type: integer
        repo:
          $ref: '#/components/schemas/MessageEventRepo'
        url:
          format: uri
          type: string
      required:
        - kind
        - repo
        - pr_number
        - head_sha
        - action
      type: object
    TimelineTaskSignalBatchMessageEvent:
      additionalProperties: false
      properties:
        entries:
          items:
            discriminator:
              mapping:
                auto_rebase: '#/components/schemas/TimelineTaskSignalAutoRebaseMessageEvent'
                child_turn_result: '#/components/schemas/TimelineChildTurnResultMessageEvent'
                ci_failure: '#/components/schemas/TimelineCIFailureMessageEvent'
                pr_comment: '#/components/schemas/TimelinePRCommentMessageEvent'
                pr_review: '#/components/schemas/TimelinePRReviewMessageEvent'
              propertyName: kind
            oneOf:
              - $ref: '#/components/schemas/TimelinePRCommentMessageEvent'
              - $ref: '#/components/schemas/TimelineCIFailureMessageEvent'
              - $ref: '#/components/schemas/TimelineTaskSignalAutoRebaseMessageEvent'
              - $ref: '#/components/schemas/TimelinePRReviewMessageEvent'
              - $ref: '#/components/schemas/TimelineChildTurnResultMessageEvent'
          minItems: 1
          type: array
        kind:
          enum:
            - task_signal_batch
          type: string
      required:
        - kind
        - entries
      type: object
    TaskStoppedMessageEvent:
      additionalProperties: false
      properties:
        initiator:
          discriminator:
            mapping:
              agent: '#/components/schemas/AgentStopInitiator'
              integration: '#/components/schemas/IntegrationStopInitiator'
              local_agent: '#/components/schemas/LocalAgentStopInitiator'
              system: '#/components/schemas/SystemStopInitiator'
              unknown: '#/components/schemas/UnknownStopInitiator'
              user: '#/components/schemas/UserStopInitiator'
            propertyName: kind
          oneOf:
            - $ref: '#/components/schemas/UserStopInitiator'
            - $ref: '#/components/schemas/IntegrationStopInitiator'
            - $ref: '#/components/schemas/SystemStopInitiator'
            - $ref: '#/components/schemas/AgentStopInitiator'
            - $ref: '#/components/schemas/LocalAgentStopInitiator'
            - $ref: '#/components/schemas/UnknownStopInitiator'
        kind:
          enum:
            - task_stopped
          type: string
      required:
        - kind
        - initiator
      type: object
    TaskGitHubPerson:
      additionalProperties: false
      properties:
        github_id:
          format: int64
          minimum: 1
          type: integer
        kind:
          enum:
            - github_account
          type: string
        login:
          minLength: 1
          pattern: \S
          type: string
      required:
        - kind
        - login
        - github_id
      type: object
    TaskUserPerson:
      additionalProperties: false
      properties:
        display_name:
          minLength: 1
          pattern: \S
          type: string
        github_login:
          minLength: 1
          pattern: \S
          type:
            - string
            - 'null'
        kind:
          enum:
            - user
          type: string
        user_id:
          format: uuid
          type: string
      required:
        - kind
        - user_id
        - display_name
        - github_login
      type: object
    MessageEventRepo:
      additionalProperties: false
      properties:
        name:
          minLength: 1
          pattern: \S
          type: string
        owner:
          minLength: 1
          pattern: \S
          type: string
      required:
        - owner
        - name
      type: object
    TimelineTaskSignalAutoRebaseMessageEvent:
      additionalProperties: false
      properties:
        base_branch:
          minLength: 1
          pattern: \S
          type: string
        branch:
          minLength: 1
          pattern: \S
          type: string
        head_sha:
          minLength: 1
          pattern: \S
          type: string
        kind:
          enum:
            - auto_rebase
          type: string
        mergeable_state:
          enum:
            - behind
            - dirty
          type: string
        pr_number:
          format: int64
          maximum: 9007199254740991
          minimum: 1
          type: integer
        reason:
          minLength: 1
          pattern: \S
          type: string
        repo:
          $ref: '#/components/schemas/MessageEventRepo'
        url:
          format: uri
          type: string
      required:
        - kind
        - repo
        - pr_number
        - branch
        - url
        - base_branch
        - head_sha
        - mergeable_state
        - reason
      type: object
    AgentStopInitiator:
      additionalProperties: false
      properties:
        kind:
          enum:
            - agent
          type: string
        parent_task_id:
          format: uuid
          type: string
        parent_task_name:
          minLength: 1
          type: string
      required:
        - kind
        - parent_task_id
        - parent_task_name
      type: object
    IntegrationStopInitiator:
      additionalProperties: false
      properties:
        external_actor_id:
          minLength: 1
          type: string
        kind:
          enum:
            - integration
          type: string
        provider:
          enum:
            - linear
          type: string
      required:
        - kind
        - provider
        - external_actor_id
      type: object
    LocalAgentStopInitiator:
      additionalProperties: false
      properties:
        client:
          enum:
            - claude-code
            - codex
            - personal-agent
            - mcp-connection
            - claude_code
            - personal_agent
            - mcp_connection
          type: string
        kind:
          enum:
            - local_agent
          type: string
        local_conversation_id:
          format: uuid
          type: string
      required:
        - kind
        - local_conversation_id
        - client
      type: object
    SystemStopInitiator:
      additionalProperties: false
      properties:
        kind:
          enum:
            - system
          type: string
        reason:
          enum:
            - history_rollback
            - runtime_billing_failure
            - service_shutdown
          type: string
      required:
        - kind
        - reason
      type: object
    UnknownStopInitiator:
      additionalProperties: false
      properties:
        kind:
          enum:
            - unknown
          type: string
      required:
        - kind
      type: object
    UserStopInitiator:
      additionalProperties: false
      properties:
        kind:
          enum:
            - user
          type: string
        source:
          enum:
            - aether
            - slack
          type: string
        user_id:
          format: uuid
          type: string
      required:
        - kind
        - user_id
        - source
      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.