Andromeda API

openapi: 3.1.0
info:
  title: Andromeda API
  version: '2026-10-28'
  description: 'GENERATED FROM DOCUMENTATION by API Evangelist on 2026-10-28: 24 operation(s) read from 9 public documentation page(s) (each operation
    names its page in x-source). This is not the provider''s published contract; Andromeda has published no machine-readable contract that the
    pipeline could find. Engine: local.'
  x-evidence-tiers:
    code-example: 0
    documentation: 24
    pages-with-code: 0
    pages-read: 9
  x-generated-from: documentation
  x-provenance: generated
  x-authored-by: API Evangelist
  x-generated: '2026-10-28'
  x-generator: generate-contract-from-docs.py
  x-engine: local
  x-sources:
  - https://docs.andromeda.ai/api-reference/overview
  - https://docs.andromeda.ai/api-reference/errors.md
  - https://docs.andromeda.ai/api-reference/overview.md
  - https://docs.andromeda.ai/api-reference/platform/access.md
  - https://docs.andromeda.ai/api-reference/platform/storage.md
  - https://docs.andromeda.ai/api-reference/business/clusters.md
  - https://docs.andromeda.ai/api-reference/business/identity.md
  - https://docs.andromeda.ai/api-reference/business/ssh-keys.md
  - https://docs.andromeda.ai/api-reference/platform/clusters.md
servers:
- url: https://business-api.andromedacluster.xyz
paths:
  /clusters:
    get:
      operationId: get_clusters
      tags:
      - Clusters
      summary: Retrieve the list of clusters for the specified business organization.
      description: Platform endpoint that returns a paginated list of clusters.
      x-source: https://docs.andromeda.ai/api-reference/overview
      parameters:
      - name: businessOrgId
        in: query
        required: true
        schema:
          type: string
        description: The organization identifier required for platform cluster routes.
      - name: limit
        in: query
        required: false
        schema:
          type: string
        description: Maximum number of items to return (1‑200, default 50).
      - name: after
        in: query
        required: false
        schema:
          type: string
        description: Pagination token (nextPageToken) to continue listing.
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /clusters/{clusterid}:
    get:
      operationId: get_clusters_clusterid
      tags:
      - Clusters
      summary: Read a cluster
      x-source: https://docs.andromeda.ai/api-reference/platform/clusters.md
      parameters:
      - name: clusterid
        in: path
        required: true
        schema:
          type: string
      - name: businessOrgId
        in: query
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetClustersClusteridResponse'
      x-evidence:
        kind: documentation
  /clusters/{clusterid}/kubeconfig:
    get:
      operationId: get_clusters_clusterid_kubeconfig
      tags:
      - Clusters
      summary: Retrieve the kubeconfig for a specific cluster.
      description: Returns the Kubernetes configuration needed to connect to the cluster.
      x-source: https://docs.andromeda.ai/api-reference/overview
      parameters:
      - name: clusterid
        in: path
        required: true
        schema:
          type: string
      - name: organizationId
        in: query
        required: true
        schema:
          type: string
        description: Organization identifier required for platform calls.
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /clusters/{clusterid}/machines:
    get:
      operationId: get_clusters_clusterid_machines
      tags:
      - Clusters
      summary: List a cluster's machines
      x-source: https://docs.andromeda.ai/api-reference/platform/clusters.md
      parameters:
      - name: clusterid
        in: path
        required: true
        schema:
          type: string
      - name: businessOrgId
        in: query
        required: true
        schema:
          type: string
      - name: limit
        in: query
        required: false
        schema:
          type: integer
      - name: after
        in: query
        required: false
        schema:
          type: string
      responses:
        '200':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetClustersClusteridMachinesResponse'
      x-evidence:
        kind: documentation
  /clusters/{clusterid}/options:
    get:
      operationId: get_clusters_clusterid_options
      tags:
      - Clusters
      summary: Read cluster options
      x-source: https://docs.andromeda.ai/api-reference/platform/clusters.md
      parameters:
      - name: clusterid
        in: path
        required: true
        schema:
          type: string
      - name: businessOrgId
        in: query
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetClustersClusteridOptionsResponse'
      x-evidence:
        kind: documentation
  /clusters/{clusterid}/scheduler-configuration:
    put:
      operationId: put_clusters_clusterid_scheduler_configuration
      tags:
      - Clusters
      summary: Update the Slurm scheduler configuration for a specific cluster.
      description: Replaces the entire Slurm configuration document for the cluster.
      x-source: https://docs.andromeda.ai/api-reference/overview
      parameters:
      - name: clusterid
        in: path
        required: true
        schema:
          type: string
      - name: organizationId
        in: query
        required: true
        schema:
          type: string
        description: Organization identifier required for platform calls.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PutClustersClusteridSchedulerConfigurationRequest'
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /clusters/{clusterid}/ssh-access:
    get:
      operationId: get_clusters_clusterid_ssh_access
      tags:
      - Clusters
      summary: Get SSH access information for a specific cluster.
      description: Provides the SSH endpoint details for the given cluster.
      x-source: https://docs.andromeda.ai/api-reference/overview
      parameters:
      - name: clusterid
        in: path
        required: true
        schema:
          type: string
      - name: organizationId
        in: query
        required: true
        schema:
          type: string
        description: Organization identifier required for platform calls.
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /me:
    get:
      operationId: get_me
      tags:
      - Me
      summary: Identity
      x-source: https://docs.andromeda.ai/api-reference/overview
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /me/login-preferences:
    put:
      operationId: put_me_login_preferences
      tags:
      - Me
      summary: SSH keys
      x-source: https://docs.andromeda.ai/api-reference/overview
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /me/resource-grants:
    get:
      operationId: get_me_resource_grants
      tags:
      - Me
      summary: Permissions
      x-source: https://docs.andromeda.ai/api-reference/overview
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /me/ssh-keys:
    get:
      operationId: get_me_ssh_keys
      tags:
      - Me
      summary: GET /me/ssh-keys returns the list of personal SSH keys.
      x-source: https://docs.andromeda.ai/api-reference/overview.md
      responses:
        '200':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetMeSshKeysResponse'
      x-evidence:
        kind: documentation
    post:
      operationId: post_me_ssh_keys
      tags:
      - Me
      summary: SSH keys
      x-source: https://docs.andromeda.ai/api-reference/overview
      responses:
        '201':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /me/ssh-keys/{keyid}/revoke:
    post:
      operationId: post_me_ssh_keys_keyid_revoke
      tags:
      - Me
      summary: SSH keys
      x-source: https://docs.andromeda.ai/api-reference/overview
      parameters:
      - name: keyid
        in: path
        required: true
        schema:
          type: string
      responses:
        '201':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /organizations/{orgid}:
    get:
      operationId: get_organizations_orgid
      tags:
      - Organizations
      summary: Identity
      x-source: https://docs.andromeda.ai/api-reference/overview
      parameters:
      - name: orgid
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /organizations/{orgid}/clusters:
    get:
      operationId: get_organizations_orgid_clusters
      tags:
      - Organizations
      summary: Clusters (Business)
      x-source: https://docs.andromeda.ai/api-reference/overview
      parameters:
      - name: orgid
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /organizations/{orgid}/clusters/{clusterid}:
    get:
      operationId: get_organizations_orgid_clusters_clusterid
      tags:
      - Organizations
      summary: Read a cluster
      x-source: https://docs.andromeda.ai/api-reference/business/clusters.md
      parameters:
      - name: orgid
        in: path
        required: true
        schema:
          type: string
      - name: clusterid
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetOrganizationsOrgidClustersClusteridResponse'
      x-evidence:
        kind: documentation
  /organizations/{orgid}/clusters/{clusterid}/access:
    get:
      operationId: get_organizations_orgid_clusters_clusterid_access
      tags:
      - Organizations
      summary: Read a cluster's access
      x-source: https://docs.andromeda.ai/api-reference/business/clusters.md
      parameters:
      - name: orgid
        in: path
        required: true
        schema:
          type: string
      - name: clusterid
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetOrganizationsOrgidClustersClusteridAccessResponse'
      x-evidence:
        kind: documentation
  /organizations/{orgid}/members:
    get:
      operationId: get_organizations_orgid_members
      tags:
      - Organizations
      summary: Identity
      x-source: https://docs.andromeda.ai/api-reference/overview
      parameters:
      - name: orgid
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /organizations/{orgid}/members/{userid}/permissions:
    put:
      operationId: put_organizations_orgid_members_userid_permissions
      tags:
      - Organizations
      summary: Permissions
      x-source: https://docs.andromeda.ai/api-reference/overview
      parameters:
      - name: orgid
        in: path
        required: true
        schema:
          type: string
      - name: userid
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /organizations/{orgid}/ssh-keys:
    post:
      operationId: post_organizations_orgid_ssh_keys
      tags:
      - Organizations
      summary: SSH keys
      x-source: https://docs.andromeda.ai/api-reference/overview
      parameters:
      - name: orgid
        in: path
        required: true
        schema:
          type: string
      responses:
        '201':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /organizations/{orgid}/scheduler-configuration:
    put:
      operationId: put_organizations_orgid_scheduler_configuration
      tags:
      - Organizations
      summary: Update the Slurm scheduler configuration for an organization.
      description: Replaces the Slurm configuration for all clusters under the organization.
      x-source: https://docs.andromeda.ai/api-reference/overview
      parameters:
      - name: orgid
        in: path
        required: true
        schema:
          type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PutOrganizationsOrgidSchedulerConfigurationRequest'
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /organizations/{orgid}/storage:
    get:
      operationId: get_organizations_orgid_storage
      tags:
      - Organizations
      summary: Retrieve storage information for a specific organization.
      description: Returns storage details associated with the organization.
      x-source: https://docs.andromeda.ai/api-reference/overview
      parameters:
      - name: orgid
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /permission-profiles:
    get:
      operationId: get_permission_profiles
      tags:
      - Permission Profiles
      summary: Permissions
      x-source: https://docs.andromeda.ai/api-reference/overview
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /resource-access:
    get:
      operationId: get_resource_access
      tags:
      - Resource Access
      summary: Permissions
      x-source: https://docs.andromeda.ai/api-reference/overview
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
components:
  schemas:
    GetClustersClusteridResponse:
      type: object
      properties:
        cluster:
          type: object
          description: Cluster object as defined in the documentation.
    GetClustersClusteridMachinesResponse:
      type: object
      properties:
        organization_id:
          type: string
          description: The organization.
        cluster_id:
          type: string
          description: The cluster.
        items:
          type: array
          description: List of machine objects.
        next_page_token:
          type: string
          description: Pass as `after` to get the next page. Absent on the last page.
    GetClustersClusteridOptionsResponse:
      type: object
      properties:
        state:
          type: string
          description: '`available`, `unknown`, or `unavailable`.'
        reason:
          type: string
          description: Why state is not `available`.
        observedAt:
          type: string
          description: When the cluster was last observed.
        scheduler:
          type: object
          description: Scheduler configuration and readiness.
        storage:
          type: object
          description: Storage configuration, quota, and readiness.
    PutClustersClusteridSchedulerConfigurationRequest:
      type: object
      properties:
        schedulerConfig:
          type: string
          description: The full scheduler configuration document to replace the existing one.
      required:
      - schedulerConfig
    GetMeSshKeysResponse:
      type: object
      properties:
        ssh_keys:
          type: array
          description: Array of SSH key objects
    GetOrganizationsOrgidClustersClusteridResponse:
      type: object
      properties:
        id:
          type: string
          description: Cluster ID, a UUID. The same ID Platform uses.
        organization_id:
          type: string
          description: The owning organization.
        state:
          type: string
          description: '`provisioning`, `active`, `releasing`, or `released`.'
        reason_code:
          type: string
          description: A stable reason for the current state, when there is one.
        expected_node_count:
          type: integer
          description: How many nodes the cluster should have.
        assigned_node_count:
          type: integer
          description: How many nodes are assigned now.
        selected_scheduler:
          type: string
          description: '`sunk` (Slurm) or `kubernetes`, as purchased.'
        reservation_id:
          type: string
          description: The reservation that created the cluster.
        infrastructure_ready_at:
          type: string
          description: When the infrastructure first became ready.
        teardown_completed_at:
          type: string
          description: When the cluster was torn down.
        cleanup_state:
          type: string
          description: Teardown progress.
        end_command_id:
          type: string
          description: The request that ended the cluster, if any.
        version:
          type: integer
          description: Increases with every change to this record.
        created_at:
          type: string
          description: RFC 3339 timestamp.
        updated_at:
          type: string
          description: RFC 3339 timestamp.
    GetOrganizationsOrgidClustersClusteridAccessResponse:
      type: object
      properties:
        cluster_id:
          type: string
          description: The cluster.
        organization_id:
          type: string
          description: The cluster's organization.
        generation:
          type: integer
          description: Version of the access list. Increases with each change.
        state:
          type: string
          description: 'Delivery of this version to the cluster: `pending`, `accepted`, `converged`, `stale`, `rejected`, or `failed`.'
        observation_state:
          type: string
          description: '`pending`, `converged`, or `failed`, as last reported by the cluster.'
        desired_generation:
          type: integer
          description: The cluster configuration version this access list was sent for.
        observed_generation:
          type: integer
          description: The version the cluster last reported.
        source_hash:
          type: string
          description: Details of this version.
        updated_at:
          type: string
          description: Details of this version.
        users[]:
          type: object
          description: List of users with access.
        users[].user_id:
          type: string
          description: The member.
        users[].username:
          type: string
          description: Their login name on the cluster.
        users[].access_mode:
          type: string
          description: '`use`, or `admin` for members with `clusters.ssh.admin`.'
        users[].desired_login_state:
          type: string
          description: '`ready`, or `waiting_for_key` if the member has no active key.'
        users[].ssh_key_set_generation:
          type: integer
          description: Which version of the member's key set the cluster should use.
        users[].allocation:
          type: object
          description: The member's POSIX identity.
        users[].allocation.uid:
          type: integer
          description: The member's numeric user ID.
        users[].allocation.gid:
          type: integer
          description: The member's numeric group ID.
        users[].allocation.home:
          type: string
          description: '`/home/<username>`.'
        users[].allocation.shell:
          type: string
          description: The member's requested shell in this access list.
    PutOrganizationsOrgidSchedulerConfigurationRequest:
      type: object
      properties:
        schedulerConfig:
          type: string
          description: The full scheduler configuration document to replace the existing one.
      required:
      - schedulerConfig
  securitySchemes:
    OIDC_Bearer_Token:
      type: http
      scheme: bearer
      x-source: https://docs.andromeda.ai/clusters/authentication.md
tags:
- name: Clusters
- name: Me
- name: Organizations
- name: Permission Profiles
- name: Resource Access
security:
- OIDC_Bearer_Token: []