---
title: "Read shell output"
method: GET
path: "/api/shell/{id}/output"
tags: ["shell"]
---

# Read shell output

`GET /api/shell/{id}/output`

## Request

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

Page through captured combined output by absolute byte cursor.

## Path parameters

- `id` string, required

## Query parameters

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

## Response `200`

Success

- object
  - `location` LocationPublicRef, required
    - `directory` string, required
  - `data` object, required
    - `output` string, required
    - `cursor` integer, required
    - `size` integer, required
    - `truncated` boolean, required

## Other responses

- `400`: InvalidRequestError
- `401`: UnauthorizedError
- `404`: ShellNotFoundError | 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)