---
title: "Get plugin README content"
method: GET
path: "/api/v1/plugins/{plugin_id}/readme"
tags: ["Plugins"]
---

# Get plugin README content

`GET /api/v1/plugins/{plugin_id}/readme`

**Required scope:** `plugin`

## Path parameters

- `plugin_id` string, required

## Response `200`

Text response

- SuccessEnvelope
  - `status` 'ok', required
  - `message` string
  - `data` unknown, required

## Changes

- **2026-06-14** `6b73b947caab` — 1 info
  - endpoint added
- **2026-03-09** `3d43cee2622a` — 1 breaking
  - api path removed without deprecation

[Change history](https://skmtc.dev/astrbotdevs/apis/astrbot-openapi-v1/changes/api/v1/plugins/:plugin_id/readme/get.md)

---

[API](https://skmtc.dev/astrbotdevs/apis/astrbot-openapi-v1.md) · [All operations](https://skmtc.dev/astrbotdevs/apis/astrbot-openapi-v1/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/astrbotdevs/astrbot-openapi-v1/revisions/9f8da1b16ca0/schema)