> ## 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. # Switch to a workspace > Opens the computer for a GitHub repository branch, creating the computer, and with create true the branch, when missing. Callers: an account bearer (API key or access token). ## OpenAPI ````yaml https://www.cool.computer/openapi.json post /api/workspaces/switch 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. 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. 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, 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: Comments description: >- Notes people leave on a computer's page, when its owner switched comments on: the owner, the people it is shared with and, when the computer is public, any signed-in person. The owner's agent reads every open note and resolves it. - 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. - name: Secrets description: Inspect secret sets and their audit history; values are never returned. - name: Providers description: Inspect connected coding-agent provider credentials. - name: GitHub description: Inspect the GitHub App installations connected to the account. - 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/workspaces/switch: post: tags: - GitHub summary: Switch to a workspace description: >- Opens the computer for a GitHub repository branch, creating the computer, and with create true the branch, when missing. Callers: an account bearer (API key or access token). operationId: switchWorkspace requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/WorkspaceSwitchRequest' responses: '200': headers: RateLimit: $ref: '#/components/headers/RateLimit' RateLimit-Policy: $ref: '#/components/headers/RateLimit-Policy' description: The workspace and its computer. content: application/json: schema: $ref: '#/components/schemas/WorkspaceSwitchResult' '400': headers: RateLimit: $ref: '#/components/headers/RateLimit' RateLimit-Policy: $ref: '#/components/headers/RateLimit-Policy' description: Bad Request. content: application/problem+json: schema: $ref: '#/components/schemas/Problem' '401': $ref: '#/components/responses/Unauthorized' '402': headers: RateLimit: $ref: '#/components/headers/RateLimit' RateLimit-Policy: $ref: '#/components/headers/RateLimit-Policy' description: >- Payment Required. The trial expired or Pro is inactive; inspect the problem code and resolution. content: application/problem+json: schema: $ref: '#/components/schemas/Problem' '403': headers: RateLimit: $ref: '#/components/headers/RateLimit' RateLimit-Policy: $ref: '#/components/headers/RateLimit-Policy' description: Forbidden. content: application/problem+json: schema: $ref: '#/components/schemas/Problem' '404': headers: RateLimit: $ref: '#/components/headers/RateLimit' RateLimit-Policy: $ref: '#/components/headers/RateLimit-Policy' description: Not Found. content: application/problem+json: schema: $ref: '#/components/schemas/Problem' '409': headers: RateLimit: $ref: '#/components/headers/RateLimit' RateLimit-Policy: $ref: '#/components/headers/RateLimit-Policy' description: Conflict. content: application/problem+json: schema: $ref: '#/components/schemas/Problem' '429': $ref: '#/components/responses/TooManyRequests' '500': $ref: '#/components/responses/InternalServerError' default: $ref: '#/components/responses/Problem' security: - bearerAuth: [] components: schemas: WorkspaceSwitchRequest: type: object additionalProperties: false required: - repo - branch properties: repo: type: string description: >- owner/name of a repository a connected GitHub installation can access. branch: type: string create: type: boolean description: Create the branch when it does not exist. from: type: string description: Base branch for a created branch. WorkspaceSwitchResult: type: object required: - repo - branch - workspace_identity - action - branch_outcome - permission_preflight - pull_requests - computer properties: repo: type: string branch: type: string workspace_identity: type: string action: type: string branch_outcome: type: string computer: $ref: '#/components/schemas/Computer' permission_preflight: type: object required: - provider - repository - status - token_scope - permissions properties: provider: type: string repository: type: string status: type: string token_scope: type: string permissions: type: array items: type: string pull_requests: type: object required: - status - matches - ambiguous properties: status: type: string matches: type: - array - 'null' items: type: object required: - number - url - state - draft - merged - head_ref - head_repo - base_ref properties: number: type: integer url: type: string state: type: string draft: type: boolean merged: type: boolean head_ref: type: string head_repo: type: string base_ref: type: string ambiguous: type: boolean error: type: string additionalProperties: false 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 Computer: type: object additionalProperties: false required: - id - hostname - slug - ip - status - visibility - access - site - network_policy - created_at properties: id: type: string hostname: type: string slug: type: string ip: type: string status: type: string public_url: type: string format: uri email_address: type: string format: email visibility: type: string enum: - private - public access: type: string enum: - owner - can_use - claim_key description: >- What the caller holds: owner, can_use for a computer shared with them, or claim_key in the response to a publish without an account, whose claim key republishes to the computer and claims it. site: type: boolean description: >- The URL serves the computer's published files: from the edge, or from its VM's built-in site server, which answers what no file matches with the program on the exposed port. network_policy: $ref: '#/components/schemas/NetworkPolicy' created_at: type: string format: date-time auto_delete_at: type: - string - 'null' format: date-time creation_mode: type: string NetworkPolicy: type: object description: >- Outbound access policy. open allows public destinations, none blocks outbound access, and allowlist permits only the named public hosts. Private and reserved addresses remain blocked. additionalProperties: false required: - mode if: properties: mode: const: allowlist required: - mode then: required: - allowed_hosts properties: allowed_hosts: minItems: 1 else: properties: allowed_hosts: maxItems: 0 properties: mode: type: string enum: - open - none - allowlist allowed_hosts: type: array description: >- Required and non-empty only when mode is allowlist. Each value is a hostname, public IP, or leading wildcard such as *.example.com, without a scheme, port, path, or CIDR. maxItems: 100 items: type: string example: api.example.com 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 responses: Unauthorized: headers: RateLimit: $ref: '#/components/headers/RateLimit' RateLimit-Policy: $ref: '#/components/headers/RateLimit-Policy' description: Unauthorized. content: application/problem+json: schema: $ref: '#/components/schemas/Problem' TooManyRequests: 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' InternalServerError: 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' Problem: 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' 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.