---
title: "Read plugin GUI bundle"
method: GET
path: "/api/plugin/gui"
tags: ["plugin"]
---

# Read plugin GUI bundle

`GET /api/plugin/gui`

## Request

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

Read an active plugin's prebuilt CommonJS `./gui-experimental` bundle. Desktop app windows run its default export; the desktop app's main process runs its `main` export. Fails with not found when no active plugin has the id or the plugin exports no `./gui-experimental`.

## Query parameters

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

## Response `200`

Success

- object
  - `location` LocationPublicRef, required
    - `directory` string, required
  - `data` PluginGuiBundle, required
    - `code` string, required
    - `revision` string, required
    - `options` object, required

## Other responses

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

## Changes

> 50 revisions in range; 1 not diffed.

- **2026-10-27** `d149ea008d28`: 1 info
  - endpoint added

[Operation history](https://skmtc.dev/kaaass/apis/opencode/changes/api/plugin/gui/get.md)

---

[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)