---
title: "Get host readme"
method: GET
path: "/api/scripts/{handle}/{host}/readme"
---

# Get host readme

`GET /api/scripts/{handle}/{host}/readme`

## Request

- Base URL: `https://reduck.ai`
- URL: `https://reduck.ai/api/scripts/{handle}/{host}/readme`
- Auth: one of:
  - HTTP bearer
  - API key in header `X-API-Key`

Read the README for a host: the notes an owner shares across every script they own for that site, like rate limits, login quirks, or ordering rules. Anyone can read it while that owner has a public, unarchived script on the host; otherwise only the owner, or a member of the project that owns it.

## Path parameters

- `handle` string, required: The owner a resource is addressed under: "@username" for a personal scope, or a bare slug for a project.
- `host` string, required: The site the script automates, as a hostname.

## Response `200`

OK

- HostReadme
  - `host` string, required
  - `content` string, required
  - `created_at` string, required
  - `updated_at` string, required

## Other responses

- `401`: Not authenticated
- `403`: Forbidden
- `404`: Not found

---

[API](https://skmtc.dev/reduck/apis/reduck-api.md) · [All operations](https://skmtc.dev/reduck/apis/reduck-api/llms.txt) · [OpenAPI document](https://skmtc.dev/reduck/apis/reduck-api/revisions/a573b91206d6?raw)