---
title: "Open a terminal"
description: "Opens a terminal session and returns a one-minute ticket for its WebSocket."
canonical: "https://www.cool.computer/docs/api-reference/terminals/open-a-terminal"
---
# Open a terminal

> Opens a terminal session and returns a one-minute ticket for its WebSocket.

```http
POST https://api.cool.computer/api/computers/{id}/terminals
```

Opens a terminal session and returns a one-minute ticket for its WebSocket. request_id is the caller-chosen terminal identity. A site with no VM answers 409 needs_vm; give it its own VM first with POST /api/computers/{id}/vm. Callers: an account bearer of the owner or of someone the computer is shared with.

## Authorization

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

## Parameters

- `id` (path, string, at least 1 characters, required): The computer's name, such as agent-atlas, or its id (cmp_…). Every caller may use either, the computer's own runtime token included.

## Request body

Required.

- `application/json` (object)
  - `request_id` (string, pattern `^cmp_[0-9a-f]{24}\.pty\.[0-9a-f]{32}$`, required)
  - `command` (string)
  - `cols` (integer, 0 to 65535)
  - `rows` (integer, 0 to 65535)

## Responses

- `201`: The terminal session and a WebSocket ticket.
  - `application/json` (object)
    - `id` (string, required)
    - `pid` (integer, required)
    - `started_at` (string, date-time, required)
    - `cols` (integer, at least 0, required)
    - `rows` (integer, at least 0, required)
    - `ticket` (string, required)
    - `expires_at` (string, date-time, required)
    - `ws_url` (string, required)
- `400`: Bad Request.
- `401`: Unauthorized.
- `402`: Payment Required. `pro_required`: VMs need Pro; start Pro with cool billing upgrade, or fix a lapsed subscription with cool billing portal, or use the Account page.
- `403`: Forbidden.
- `404`: Not Found. `computer_not_found`: the computer does not exist or is not yours.
- `409`: Conflict.
- `429`: Too Many Requests. If the problem code is api_request_rate_exceeded, wait for Retry-After seconds; other problem codes describe a separate limit.
- `500`: Internal Server Error.
- `502`: Bad Gateway.
- `503`: Service Unavailable. `computer_starting` means the computer is starting, or stopped and being started again; wait for Retry-After seconds, then retry. Otherwise inspect the problem code and resolution.
- `default`: A machine-readable API error with a stable code and recovery instruction.

An error is an `application/problem+json` document with a stable `code`; [API errors](/docs/api-reference/errors) says how to handle one.

## Example

```sh
curl -X POST "https://api.cool.computer/api/computers/$PARAM_ID/terminals" \
  -H "authorization: Bearer $TOKEN" \
  -H "content-type: application/json" \
  --data '{"request_id":"cmp_0123456789abcdef01234567.pty.0123456789abcdef0123456789abcdef"}'
```
