> ## Documentation Index
> Fetch the complete documentation index at: https://cool.computer/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# Get account capabilities

> Returns the account's effective limits: computer and artifact quotas with the computers using them, per-computer resource allocation, sampled memory and storage usage, transfer limits, and network policy limits. Call this before creating a computer or stating account-specific limits.



## OpenAPI

````yaml https://www.cool.computer/openapi.json get /api/capabilities
openapi: 3.1.0
info:
  title: Cool Computers API
  version: 1.0.0
  description: >-
    Create and operate reachable Linux computers. Each computer keeps a stable
    name.cool.computer address, persistent files, and agent-ready command
    execution. REST requests use UTC-aligned one-minute limits: 600 requests per
    account identified by a recognized valid account bearer credential, a
    separate 600-request budget per computer-scoped credential, or 60 requests
    per source IP otherwise. Read-only GETs answered from API state spend a
    separate read budget reported as account-read or computer-read, so status
    polling cannot exhaust the budget that protects work and mutations. To bound
    authentication-provider traffic, at most 60 first-seen bearer values are
    checked per source IP in a minute; recognized valid credentials use their
    account or computer policy. Successful bearer authentication is reused for
    at most five seconds; transient provider failures are not cached. Non-exempt
    API responses include the structured RateLimit and RateLimit-Policy fields;
    request admission 429 responses use code api_request_rate_exceeded and also
    include Retry-After. Health, OpenAPI, webhooks, callbacks, SSE, and
    WebSocket endpoints are exempt from the REST request budget. Authenticated
    SSE connection attempts remain subject to the authentication safeguards and
    can receive the same typed 429 response.
servers:
  - url: https://api.cool.computer
    description: Canonical API origin
security: []
tags:
  - name: Authentication
    description: Obtain and manage bearer credentials.
  - name: Billing
    description: Inspect and manage the account's no-card trial or Pro plan.
  - name: Computers
    description: Create, inspect, and delete resident computers.
  - name: Execution
    description: Run commands on a computer.
  - name: Files
    description: Read and change a computer's persistent files.
  - name: Publishing
    description: >-
      Publish files to a computer's URL as immutable releases, with no VM. To
      show something, publish the files; to run something, use the computer
      (exec, terminal, services), which gets Linux on first use.
  - name: Services
    description: >-
      Manage processes and select the HTTP port exposed at a computer's stable
      address.
  - name: Email
    description: Read and send mail through a computer's inbox.
  - name: Network
    description: Control a computer's public visibility and outbound network policy.
  - name: Sharing
    description: Invite people to use a computer without granting owner controls.
  - name: Public
    description: Unauthenticated discovery endpoints.
externalDocs:
  description: Cool Computers agent registration guide
  url: https://www.cool.computer/auth.md
paths:
  /api/capabilities:
    get:
      tags:
        - Computers
      summary: Get account capabilities
      description: >-
        Returns the account's effective limits: computer and artifact quotas
        with the computers using them, per-computer resource allocation, sampled
        memory and storage usage, transfer limits, and network policy limits.
        Call this before creating a computer or stating account-specific limits.
      operationId: getAccountCapabilities
      responses:
        '200':
          headers:
            RateLimit:
              $ref: '#/components/headers/RateLimit'
            RateLimit-Policy:
              $ref: '#/components/headers/RateLimit-Policy'
          description: Effective account limits and usage.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccountCapabilities'
        '401':
          headers:
            RateLimit:
              $ref: '#/components/headers/RateLimit'
            RateLimit-Policy:
              $ref: '#/components/headers/RateLimit-Policy'
          description: Unauthorized.
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Problem'
        '429':
          headers:
            RateLimit:
              $ref: '#/components/headers/RateLimit'
            RateLimit-Policy:
              $ref: '#/components/headers/RateLimit-Policy'
            Retry-After:
              $ref: '#/components/headers/Retry-After'
          description: >-
            Too Many Requests. If the problem code is api_request_rate_exceeded,
            wait for Retry-After seconds; other problem codes describe a
            separate limit.
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Problem'
        '500':
          headers:
            RateLimit:
              $ref: '#/components/headers/RateLimit'
            RateLimit-Policy:
              $ref: '#/components/headers/RateLimit-Policy'
          description: Internal Server Error.
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Problem'
        default:
          headers:
            RateLimit:
              $ref: '#/components/headers/RateLimit'
            RateLimit-Policy:
              $ref: '#/components/headers/RateLimit-Policy'
          description: >-
            A machine-readable API error with a stable code and recovery
            instruction.
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Problem'
      security:
        - bearerAuth: []
components:
  headers:
    RateLimit:
      description: >-
        The applied policy name, requests remaining after this request, and
        whole seconds until the current UTC-aligned window resets.
      schema:
        type: string
        pattern: >-
          ^"(account|account-read|computer|computer-read|source)";r=[0-9]+;t=([1-9]|[1-5][0-9]|60)$
        examples:
          - '"account";r=599;t=42'
          - '"computer-read";r=598;t=42'
    RateLimit-Policy:
      description: >-
        The selected policy name, quota, and window in seconds. Valid account
        credentials use account or account-read with q=600, computer credentials
        use computer or computer-read with q=600, and unauthenticated or
        unrecognized requests use source with q=60 for their source IP.
      schema:
        type: string
        pattern: >-
          ^("(account|account-read|computer|computer-read)";q=600|"source";q=60);w=60$
        examples:
          - '"account";q=600;w=60'
          - '"computer-read";q=600;w=60'
    Retry-After:
      description: >-
        Whole seconds to wait after an api_request_rate_exceeded response before
        retrying. Other 429 problem codes describe separate resource or provider
        limits and do not inherit this retry value.
      schema:
        type: integer
        minimum: 1
        maximum: 60
        examples:
          - 42
  schemas:
    AccountCapabilities:
      type: object
      additionalProperties: false
      description: >-
        Effective limits and sampled resource usage for the authenticated
        account. Read this before stating account-specific limits.
      required:
        - default_visibility
        - resources
        - computer_quota
        - artifact_quota
        - transfers
        - network
      properties:
        default_visibility:
          type: string
        resources:
          type: object
          additionalProperties: false
          required:
            - allocation
            - usage
          properties:
            allocation:
              type: object
              additionalProperties: false
              required:
                - available
              properties:
                available:
                  type: boolean
                vcpu:
                  type: integer
                guest_memory_ceiling_mib:
                  type: integer
                rootfs_bytes:
                  type: integer
                  format: int64
                pid_limit:
                  type: integer
                  format: int64
                open_files_limit:
                  type: integer
                  format: int64
            usage:
              type: object
              additionalProperties: false
              required:
                - available
                - memory
                - storage
                - computers
              properties:
                available:
                  type: boolean
                sampled_at:
                  type: string
                  format: date-time
                unavailable_reason:
                  type: string
                memory:
                  type: object
                  additionalProperties: false
                  required:
                    - available
                    - account_cgroup_current_mib
                    - active_vms
                    - sampled_vms
                  properties:
                    available:
                      type: boolean
                    unavailable_reason:
                      type: string
                    sampled_at:
                      type: string
                      format: date-time
                    sample_age_ms:
                      type: integer
                      format: int64
                    account_cgroup_current_mib:
                      type: integer
                    active_vms:
                      type: integer
                    sampled_vms:
                      type: integer
                storage:
                  type: object
                  additionalProperties: false
                  required:
                    - available
                    - account_used_bytes
                    - account_limit_bytes
                    - account_available_bytes
                  properties:
                    available:
                      type: boolean
                    unavailable_reason:
                      type: string
                    account_used_bytes:
                      type: integer
                      format: int64
                    account_limit_bytes:
                      type: integer
                      format: int64
                    account_available_bytes:
                      type: integer
                      format: int64
                computers:
                  type: array
                  items:
                    type: object
                    additionalProperties: false
                    required:
                      - id
                      - slug
                      - status
                      - sample_available
                      - cgroup_sample_available
                      - firecracker_rss_available
                      - firecracker_cpu_available
                      - network_sample_available
                      - disk_sample_available
                    properties:
                      id:
                        type: string
                      slug:
                        type: string
                      status:
                        type: string
                      sample_available:
                        type: boolean
                      allocated_vcpu:
                        type: integer
                      cgroup_sample_available:
                        type: boolean
                      cgroup_current_mib:
                        type: integer
                      cgroup_current_bytes:
                        type: integer
                        format: int64
                      firecracker_rss_available:
                        type: boolean
                      firecracker_rss_bytes:
                        type: integer
                        format: int64
                      firecracker_cpu_available:
                        type: boolean
                      firecracker_cpu_seconds:
                        type: number
                      cpu_counter_epoch:
                        type: string
                      balloon:
                        type: object
                        additionalProperties: false
                        required:
                          - target_mib
                          - actual_mib
                        properties:
                          target_mib:
                            type: integer
                          actual_mib:
                            type: integer
                          swap_in:
                            type: integer
                            format: int64
                          swap_out:
                            type: integer
                            format: int64
                          major_faults:
                            type: integer
                            format: int64
                          minor_faults:
                            type: integer
                            format: int64
                          free_memory:
                            type: integer
                            format: int64
                          total_memory:
                            type: integer
                            format: int64
                          available_memory:
                            type: integer
                            format: int64
                          disk_caches:
                            type: integer
                            format: int64
                          hugetlb_allocations:
                            type: integer
                            format: int64
                          hugetlb_failures:
                            type: integer
                            format: int64
                      network_sample_available:
                        type: boolean
                      network_counter_epoch:
                        type: string
                      guest_ingress_bytes_total:
                        type: integer
                        format: int64
                      guest_egress_bytes_total:
                        type: integer
                        format: int64
                      disk_sample_available:
                        type: boolean
                      disk_referenced_bytes:
                        type: integer
                        format: int64
                      disk_available_bytes:
                        type: integer
                        format: int64
        computer_quota:
          type: object
          additionalProperties: false
          required:
            - limit
            - used
            - rule
            - computers
          properties:
            limit:
              type: integer
            used:
              type: integer
            rule:
              type: string
            computers:
              type: array
              items:
                type: object
                additionalProperties: false
                required:
                  - id
                  - slug
                  - status
                properties:
                  id:
                    type: string
                  slug:
                    type: string
                  status:
                    type: string
          description: >-
            Computers with a VM that count against the account's computer limit,
            with the computers using each slot.
        artifact_quota:
          type: object
          additionalProperties: false
          required:
            - limit
            - used
            - rule
            - computers
          properties:
            limit:
              type: integer
            used:
              type: integer
            rule:
              type: string
            computers:
              type: array
              items:
                type: object
                additionalProperties: false
                required:
                  - id
                  - slug
                  - status
                properties:
                  id:
                    type: string
                  slug:
                    type: string
                  status:
                    type: string
          description: >-
            Artifact computers (published files, no VM) that count against the
            account's artifact limit.
        transfers:
          type: object
          additionalProperties: false
          required:
            - single_file_bytes
            - archive_payload_bytes
            - archive_entries
            - upload_request_bytes
            - exec_stream_stdin_bytes
          properties:
            single_file_bytes:
              type: integer
              format: int64
            archive_payload_bytes:
              type: integer
              format: int64
            archive_entries:
              type: integer
            upload_request_bytes:
              type: integer
              format: int64
            exec_stream_stdin_bytes:
              type: integer
          description: Byte and entry limits for file transfers and streamed exec stdin.
        network:
          type: object
          additionalProperties: false
          required:
            - allowed_host_limit
            - protocols
            - connect_ports
            - direct_public_protocols_by_mode
          properties:
            allowed_host_limit:
              type: integer
            protocols:
              type: array
              items:
                type: string
            connect_ports:
              type: array
              items:
                type: integer
            direct_public_protocols_by_mode:
              type: object
              additionalProperties: false
              required:
                - open
                - allowlist
                - none
              properties:
                open:
                  type: array
                  items:
                    type: string
                allowlist:
                  type: array
                  items:
                    type: string
                none:
                  type: array
                  items:
                    type: string
          description: >-
            Outbound network policy limits and the protocols each exposure mode
            accepts.
    Problem:
      type: object
      additionalProperties: false
      required:
        - type
        - title
        - status
        - code
        - detail
        - resolution
      properties:
        type:
          type: string
          format: uri
        title:
          type: string
        status:
          type: integer
          minimum: 400
          maximum: 599
        code:
          type: string
          pattern: ^[a-z0-9_]+$
        detail:
          type: string
        resolution:
          type: string
        context:
          type: object
          additionalProperties: true
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: WorkOS user or agent access token, or Cool Computers API key
      description: >-
        A Cool Computers API key, user access token, or claimed agent access
        token in the Authorization header. Follow
        https://www.cool.computer/auth.md for agent registration and
        https://www.cool.computer/authentication.md for direct user credentials.

````