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

# Complete onboarding

> Completes the caller's onboarding without creating a project or launch task.

Use this tool when you need to:
- Finish onboarding for a user who joined a team organization
- Finish onboarding for a self-serve user who already connected GitHub and an agent provider
- Skip onboarding from the web app's skip button

Examples:
- POST /profile/onboarding/complete?client_flow=web
- POST /profile/onboarding/complete?client_flow=skip

Hints:
- client_flow is optional and says which client flow is completing: setup (the CLI setup wizard), command (the standalone CLI command), web (the web app) or skip (the web app's skip button); any other value is 422.
- Admitted for a user who belongs to a team organization, a self-serve user with a connected GitHub installation and a connected Codex, Claude Code, or OpenCode credential that needs no re-authentication, or any user whose client_flow is skip: a self-serve skip waives the GitHub and agent provider requirements.
- Otherwise refused with 403 onboarding_requirements_missing, whose message names github_installation, agent_provider_credential or both.
- Idempotent: answers onboarding_completed true, with already_completed true when onboarding had already completed.
- Use launchOnboardingTask instead to complete onboarding by launching the caller's first task, after setupOnboardingRepo created its project.
- Any signed-in user, for their own profile. Refused with 404 when the caller has no profile.



## OpenAPI

````yaml api-reference/openapi.json POST /profile/onboarding/complete
openapi: 3.1.0
info:
  title: Aether API
  version: 0.1.0
servers:
  - url: https://api.runaether.dev
security:
  - bearerAuth: []
paths:
  /profile/onboarding/complete:
    post:
      tags:
        - profile
      summary: Complete onboarding
      description: >-
        Completes the caller's onboarding without creating a project or launch
        task.


        Use this tool when you need to:

        - Finish onboarding for a user who joined a team organization

        - Finish onboarding for a self-serve user who already connected GitHub
        and an agent provider

        - Skip onboarding from the web app's skip button


        Examples:

        - POST /profile/onboarding/complete?client_flow=web

        - POST /profile/onboarding/complete?client_flow=skip


        Hints:

        - client_flow is optional and says which client flow is completing:
        setup (the CLI setup wizard), command (the standalone CLI command), web
        (the web app) or skip (the web app's skip button); any other value is
        422.

        - Admitted for a user who belongs to a team organization, a self-serve
        user with a connected GitHub installation and a connected Codex, Claude
        Code, or OpenCode credential that needs no re-authentication, or any
        user whose client_flow is skip: a self-serve skip waives the GitHub and
        agent provider requirements.

        - Otherwise refused with 403 onboarding_requirements_missing, whose
        message names github_installation, agent_provider_credential or both.

        - Idempotent: answers onboarding_completed true, with already_completed
        true when onboarding had already completed.

        - Use launchOnboardingTask instead to complete onboarding by launching
        the caller's first task, after setupOnboardingRepo created its project.

        - Any signed-in user, for their own profile. Refused with 404 when the
        caller has no profile.
      operationId: completeOnboarding
      parameters:
        - description: >-
            Which client flow is completing onboarding: the CLI setup wizard,
            the standalone CLI command, the web app, or the web app's skip
            button. A self-serve skip completes onboarding without the GitHub
            and agent provider requirements.
          explode: false
          in: query
          name: client_flow
          schema:
            description: >-
              Which client flow is completing onboarding: the CLI setup wizard,
              the standalone CLI command, the web app, or the web app's skip
              button. A self-serve skip completes onboarding without the GitHub
              and agent provider requirements.
            enum:
              - setup
              - command
              - web
              - skip
            type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OnboardingCompletion'
          description: OK
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProfileErrorResponse'
          description: Unauthorized
        '403':
          content:
            application/json:
              schema:
                anyOf:
                  - $ref: '#/components/schemas/ProfileErrorResponse'
                  - $ref: '#/components/schemas/OrgAuthorizationErrorResponse'
          description: Forbidden
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProfileErrorResponse'
          description: Not Found
        '410':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProfileErrorResponse'
          description: Gone
        '422':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProfileErrorResponse'
          description: Unprocessable Entity
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProfileErrorResponse'
          description: Internal Server Error
components:
  schemas:
    OnboardingCompletion:
      additionalProperties: false
      properties:
        already_completed:
          type: boolean
        onboarding_completed:
          type: boolean
      required:
        - onboarding_completed
        - already_completed
      type: object
    ProfileErrorResponse:
      additionalProperties: false
      properties:
        code:
          enum:
            - account_deleting
            - aether_inference_unserved
            - agent_pr_blocked
            - agent_pr_pending
            - agent_profile_changed
            - agent_starts_off
            - app_identity_missing
            - attribution_unavailable
            - bad_gateway
            - bad_request
            - caller_inactive
            - chat_archived
            - 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
            - download_unsupported
            - embeddings_unavailable
            - fix_not_requested
            - fix_requests_unrecorded
            - forbidden
            - fork_branch_delete_unsupported
            - fork_forbidden
            - gateway_timeout
            - github_claim_unverified
            - github_failed
            - github_identity_mismatch
            - github_identity_required
            - github_push_access_required
            - github_reconnect_required
            - github_ref_not_found
            - gone
            - handed_branch_protected
            - 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
            - 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_dispatch_target
            - not_acceptable
            - not_found
            - not_implemented
            - onboarding_already_completed
            - onboarding_requirements_missing
            - org_id_required
            - org_role_insufficient
            - org_suspended
            - payment_required
            - pending_input_answered
            - 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_file_too_large
            - push_rejected
            - push_secret_detected
            - question_answers
            - 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_owner_not_caller
            - request_canceled
            - 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_auth_required
            - stack_cycle
            - stack_too_large
            - stack_two_parents
            - stale_execution
            - stale_or_indeterminate
            - stale_pending_input
            - stream_delivery_gap
            - stream_event_conflict
            - task_already_saved
            - task_awaiting_message
            - task_awaiting_tool_response
            - task_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_fork_refused
            - 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_continuation_refused
            - too_many_live_connections
            - 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
          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
    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
  securitySchemes:
    bearerAuth:
      bearerFormat: JWT
      scheme: bearer
      type: http

````

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