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

# Set up the onboarding repository

> Creates the caller's onboarding project for a GitHub repository in their personal organization: the project, its repository link, its env vars and its skill indexing commit in one transaction.

Use this tool when you need to:
- Create the first project during onboarding from the repository the caller picked
- Save the repository's .env content as the project's env vars in the same step
- Repair the onboarding project's link after GitHub was disconnected or the repository renamed, by calling it again for the same repository

Examples:
- POST /profile/onboarding/repo {"repo_url": "acme/widgets", "installation_id": 12345678}
- POST /profile/onboarding/repo {"repo_url": "https://github.com/acme/widgets", "installation_id": 12345678, "env_content": "API_URL=https://api.acme.dev"}

Hints:
- repo_url is required, owner/repo or a GitHub URL: an empty one is refused by the schema with 422, and a non-empty one that does not parse as a repository with 400. installation_id is required: the caller's GitHub App installation that reaches the repository, from listGithubRepos or getGithubRepo. env_content is optional .env text up to 49152 characters, parsed before GitHub is called; malformed content or an invalid key is 400.
- The caller needs push access to the repository, and it must have a commit, be at most 2 GB and have a default branch with no surrounding whitespace, which would name another branch trimmed (400 otherwise, naming the branch). A new project is named after the repository.
- Idempotent: a repeat for the same repository returns the project already linked to it with already_linked true, re-saving the link (repairing one a GitHub disconnect cleared, or following a rename) and upserting the env vars.
- Use launchOnboardingTask next with the returned project_id; use importGithubRepo instead to link a repository to a project outside onboarding.
- The caller, acting in their personal organization: a credential acting in another organization is refused with 403. Refused with 401 when the installation is not the caller's, 404 when the repository is out of the caller's reach, 409 github_reconnect_required, 502 when GitHub fails to answer and 503 when this deployment's GitHub integration is disabled.



## OpenAPI

````yaml api-reference/openapi.json POST /profile/onboarding/repo
openapi: 3.1.0
info:
  title: Aether API
  version: 0.1.0
servers:
  - url: https://api.runaether.dev
security:
  - bearerAuth: []
paths:
  /profile/onboarding/repo:
    post:
      tags:
        - profile
      summary: Set up the onboarding repository
      description: >-
        Creates the caller's onboarding project for a GitHub repository in their
        personal organization: the project, its repository link, its env vars
        and its skill indexing commit in one transaction.


        Use this tool when you need to:

        - Create the first project during onboarding from the repository the
        caller picked

        - Save the repository's .env content as the project's env vars in the
        same step

        - Repair the onboarding project's link after GitHub was disconnected or
        the repository renamed, by calling it again for the same repository


        Examples:

        - POST /profile/onboarding/repo {"repo_url": "acme/widgets",
        "installation_id": 12345678}

        - POST /profile/onboarding/repo {"repo_url":
        "https://github.com/acme/widgets", "installation_id": 12345678,
        "env_content": "API_URL=https://api.acme.dev"}


        Hints:

        - repo_url is required, owner/repo or a GitHub URL: an empty one is
        refused by the schema with 422, and a non-empty one that does not parse
        as a repository with 400. installation_id is required: the caller's
        GitHub App installation that reaches the repository, from
        listGithubRepos or getGithubRepo. env_content is optional .env text up
        to 49152 characters, parsed before GitHub is called; malformed content
        or an invalid key is 400.

        - The caller needs push access to the repository, and it must have a
        commit, be at most 2 GB and have a default branch with no surrounding
        whitespace, which would name another branch trimmed (400 otherwise,
        naming the branch). A new project is named after the repository.

        - Idempotent: a repeat for the same repository returns the project
        already linked to it with already_linked true, re-saving the link
        (repairing one a GitHub disconnect cleared, or following a rename) and
        upserting the env vars.

        - Use launchOnboardingTask next with the returned project_id; use
        importGithubRepo instead to link a repository to a project outside
        onboarding.

        - The caller, acting in their personal organization: a credential acting
        in another organization is refused with 403. Refused with 401 when the
        installation is not the caller's, 404 when the repository is out of the
        caller's reach, 409 github_reconnect_required, 502 when GitHub fails to
        answer and 503 when this deployment's GitHub integration is disabled.
      operationId: setupOnboardingRepo
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SetupOnboardingRepoRequest'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OnboardingRepoSetup'
          description: OK
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProfileErrorResponse'
          description: Bad Request
        '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
        '502':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProfileErrorResponse'
          description: Bad Gateway
        '503':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProfileErrorResponse'
          description: Service Unavailable
components:
  schemas:
    SetupOnboardingRepoRequest:
      additionalProperties: false
      properties:
        env_content:
          maxLength: 49152
          type: string
        installation_id:
          format: int64
          minimum: 1
          type: integer
        repo_url:
          minLength: 1
          type: string
      required:
        - repo_url
        - installation_id
      type: object
    OnboardingRepoSetup:
      additionalProperties: false
      properties:
        already_linked:
          type: boolean
        project_id:
          format: uuid
          type: string
      required:
        - project_id
        - already_linked
      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.