> ## Documentation Index
> Fetch the complete documentation index at: https://docs.upriver.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# skill.md

> Give your AI agent the Upriver API reference

The [`skill.md`](https://docs.upriver.ai/skill.md) file is a structured, machine-readable API reference that tells AI agents what they can do with the Upriver API. It follows the [skill.md specification](https://agentskills.io/specification) and includes endpoint descriptions, required parameters, and usage guidance in a format LLMs can reliably work with.

View the Upriver skill.md at: [docs.upriver.ai/skill.md](https://docs.upriver.ai/skill.md)

<Tip>
  Both `skill.md` and `llms.txt` help agents work with the Upriver API, but they serve different purposes.

  * `skill.md` is a **capability summary**. It tells agents what actions are available, what inputs they need, and what constraints apply.
  * `llms.txt` is a **documentation index**. It lists available pages with descriptions so agents know where to find information.

  Use `skill.md` when you want agents to call the API directly. Use `llms.txt` when you want agents to browse the docs.
</Tip>

## Use skill.md with agents

### Skills CLI

Agents can process the skill.md with the [skills CLI](https://www.npmjs.com/package/skills).

```bash theme={null}
npx skills add https://docs.upriver.ai
```

### Claude Code / OpenClaw

Add the URL to your project context or reference it in a prompt:

```bash theme={null}
curl -s https://docs.upriver.ai/skill.md >> AGENTS.md
```

```
Use the Upriver API as described in https://docs.upriver.ai/skill.md
```

### Cursor / Windsurf

Add it as a doc in your project settings:

1. Go to **Settings → Docs**
2. Add `https://docs.upriver.ai/skill.md`

### ChatGPT / Claude.ai

Paste the URL or file contents into your conversation:

```
Here's the API reference: https://docs.upriver.ai/skill.md
Use it to help me call the Upriver API.
```

### Any agent or framework

Fetch it at build time or runtime:

```bash theme={null}
curl -s https://docs.upriver.ai/skill.md
```

The file is plain Markdown. Works anywhere that accepts text context.

## What's in the file

The skill.md includes:

* **Metadata**: API name, description, and base URL.
* **Authentication**: How to authenticate requests.
* **Endpoints**: Available actions organized by resource (brands, creators, audiences, trends, etc).
* **Parameters**: Required and optional inputs for each endpoint.
* **Usage guidance**: Tips on how to chain endpoints and handle responses.