---
title: "Create PTY session"
method: POST
path: "/api/pty"
tags: ["pty"]
---

# Create PTY session

`POST /api/pty`

## Request

- Base URL: `https://opencode.ai` (the document declares no server; this is the origin it was published from)
- URL: `https://opencode.ai/api/pty`
- Auth: none required

Create a pseudo-terminal session for a location.

## Query parameters

- `location` object, nullable
  - `directory` string, nullable

## Request body

- object
  - `command` string
  - `args` string[]
  - `cwd` string
  - `title` string
  - `env` object

## Response `200`

Success

- object
  - `location` LocationPublicRef, required
    - `directory` string, required
  - `data` Pty, required
    - `id` string, required
    - `title` string, required
    - `command` string, required
    - `args` string[], required
    - `cwd` string, required
    - `status` 'running' | 'exited', required
    - `pid` integer, required
    - `exitCode` integer

## Other responses

- `400`: InvalidRequestError
- `401`: UnauthorizedError
- `404`: LocationNotFoundError

---

[API](https://skmtc.dev/kaaass/apis/opencode.md) - [All operations](https://skmtc.dev/kaaass/apis/opencode/llms.txt) - [OpenAPI document](https://skmtc.dev/kaaass/apis/opencode/revisions/4e083d954707?raw)