> ## 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 usage > Returns the account's effective limits and defaults next to what it uses now: the computer quota with the computers using it, per-computer resource allocation, sampled memory and storage usage, sites created in the last 24 hours against the daily limit, 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/usage openapi: 3.1.0 info: title: Cool Computers API version: 1.0.0 description: >- Create and operate reachable 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. Revoking a credential through this API (POST /api/auth/logout or DELETE /api/api-keys/{id}) drops that reuse in every serving process, so the revoked credential is refused from the next request on; only if that announcement fails does another process keep admitting it, for at most five seconds. JSON request bodies must be sent with Content-Type: application/json; any other body answers 415 unsupported_media_type. A request that gives a published site its own VM (POST /api/computers/{id}/vm, POST /api/computers/{id}/service/run, or a publish whose cool.json declares run) answers with a Cool-Notice header saying that the site now runs there and cool.json no longer applies; exec, terminals, the port proxy and exposure never give one and answer 409 needs_vm on a site with no VM. Every error is an application/problem+json object whose type links to https://cool.computer/docs/api-reference/errors; a malformed body names the unknown field, the wrong type, or the byte where the JSON breaks. 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, give the site its own VM with POST /api/computers/{id}/vm or start a service with POST /api/computers/{id}/service/run, then use exec, terminals and services. - 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: Comments description: >- Comments people leave on a computer's page, unless its owner switched comments off: the owner, the people it is shared with and, when the computer is public, any signed-in person. A comment is content; the owner's agents (Operator, or any agent with the owner's credential) pull the open comments and answer them, and the owner hands chosen comments as a job with POST /api/computers/{id}/comments/ask to Operator, or to the owner's own coding agent while it listens on the site with POST /api/computers/{id}/comments/watch (one listening session per site; it claims the job by pulling it, and Operator takes the job over when it goes quiet). - 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: Domains description: >- Serve a computer at a hostname you control, such as app.example.com, beside its own address. - name: Public description: Unauthenticated discovery endpoints. - name: Secrets description: Inspect secret sets and their audit history; values are never returned. - name: Integrations description: Connect, inspect and revoke outside service accounts. - name: GitHub description: Work with repository workspaces using the connected user account. - name: Messaging description: >- Connect Telegram, Slack or WhatsApp so direct messages, and mentions of the Slack app in a channel, become chat turns. - name: Terminals description: Inspect a computer's terminal sessions. - name: Operator description: Read the operator agent's conversations, turns, and events. - name: Feedback description: >- Tell the Cool Computers team what works and what does not, with or without an account. externalDocs: description: Cool Computers agent registration guide url: https://www.cool.computer/auth.md paths: /api/usage: get: tags: - Computers summary: Get account usage description: >- Returns the account's effective limits and defaults next to what it uses now: the computer quota with the computers using it, per-computer resource allocation, sampled memory and storage usage, sites created in the last 24 hours against the daily limit, transfer limits, and network policy limits. Call this before creating a computer or stating account-specific limits. operationId: getAccountUsage 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/AccountUsage' '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|comment-board|comment-live)";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, unauthenticated or unrecognized requests use source with q=60 for their source IP, a browser session's read of a comment board uses comment-board with q=300 for its source IP, and its handshake of a comment live channel uses comment-live with q=60 for its source IP. schema: type: string pattern: >- ^("(account|account-read|computer|computer-read)";q=600|"source";q=60|"comment-board";q=300|"comment-live";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, comment_rate_exceeded, comment_site_rate_exceeded, comment_live_full or computer_starting response before retrying (up to 3600 for comment_site_rate_exceeded, whose window is an hour). Other 429 problem codes describe separate resource or provider limits and do not inherit this retry value. schema: type: integer minimum: 1 maximum: 3600 examples: - 42 schemas: AccountUsage: type: object additionalProperties: false description: >- Effective limits and defaults next to sampled resource usage for the authenticated account. Read this before stating account-specific limits. required: - default_visibility - resources - computer_quota - site_creations - 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_limit_mib - account_used_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_limit_mib: type: integer description: >- Memory all of the account's computers may hold together, idle ones included. The host holds them to it: a computer that needs more than the room left has a process stopped by its own kernel, and a new computer is refused with account_memory_full. account_used_mib: type: integer description: >- Memory the account's computers hold now, counted as account_limit_mib counts it: without page cache the host can drop at once. 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 - name - status - sample_available - cgroup_sample_available - firecracker_rss_available - firecracker_cpu_available - network_sample_available - disk_sample_available properties: id: type: string name: 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 - name - status properties: id: type: string name: type: string status: type: string description: >- Computers with a VM that count against the account's computer limit, with the computers using each slot. site_creations: type: object additionalProperties: false required: - limit - used - window_hours properties: limit: type: integer used: type: integer window_hours: type: integer description: >- Sites the account created or claimed in the last 24 hours, including ones since deleted, against the most it may in that window; a site that gains a VM stops counting. 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 properties: type: type: string format: uri description: >- https://cool.computer/docs/api-reference/errors, the page that explains every code. 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 suggestions: type: array items: type: string maxItems: 3 description: >- Values to send instead. With name_taken: up to three free names made from the requested one, the first with a random suffix; each was free when the answer was made. 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. ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.