> For the complete documentation index, see [llms.txt](https://clanker.gitbook.io/documentation/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://clanker.gitbook.io/documentation/readme.md).

# Introduction

Clanker is a token deployment protocol on Base, Arbitrum, and other EVM chains. This repository is the source for the [Clanker Gitbook documentation](https://clanker.gitbook.io) and is auto-generated from the SDK and API.

## Droids

A Droid is an AI agent that ships with your token — own Farcaster account, personality you design, compute funded by the token itself via a carve-out of its LP rewards.

* [Droids Overview](/documentation/droids/droids.md) — What a Droid is and the two ways to create one
* [Droid Funding & Runway](/documentation/droids/funding.md) — How a droid pays for its own compute
* [Create a Droid](/documentation/droids/create.md) — Launch a droid with a token (or standalone)
* [Manage your Droid](/documentation/droids/manage.md) — The Droid panel and chat flow
* [Writing a Droid Voice](/documentation/droids/voice.md) — Designing a personality worth tagging
* [Droid FAQ](/documentation/droids/faq.md) and [Troubleshooting](/documentation/droids/troubleshooting.md)

## API Reference

The Clanker REST API is available at `https://www.clanker.world/api`.

| Auth Method     | Header                          | Description                            |
| --------------- | ------------------------------- | -------------------------------------- |
| Public          | None                            | No authentication required             |
| Partner API Key | `x-api-key: <key>`              | Issued per-partner by the Clanker team |
| User Auth       | `Authorization: Bearer <token>` | Farcaster or Privy authentication      |

* [Public API](/documentation/api-reference/public.md) — Token search, trending, users, presales, airdrops, market data
* [Authenticated API](/documentation/api-reference/authenticated.md) — Partner endpoints for tokens, deployment, fees
* [User API](/documentation/api-reference/user.md) — Preclank management, UI token saves

## SDK Reference

The [clanker-sdk](https://www.npmjs.com/package/clanker-sdk) is a TypeScript library for deploying and managing Clanker tokens on-chain.

```bash
npm install clanker-sdk
```

* [Core Utilities](/documentation/sdk-reference/index.md) — Types, constants, vanity address, merkle tree helpers
* [V4 Clanker Class](/documentation/sdk-reference/v4.md) — Deploy, claim rewards, update metadata (current version)
* [V3 Clanker Class](/documentation/sdk-reference/v3.md) — V3 token deployment and management
* [V4 Extensions](/documentation/sdk-reference/extensions.md) — Airdrops, presales, allowlist management
* [Legacy Fee Claims](/documentation/sdk-reference/legacyfeeclaims.md) — Fee claims for V0–V3.1 tokens

## Contributing

Documentation is auto-generated from source code:

* **API docs** are generated from [`clanker.world/docs/api-registry.ts`](https://github.com/clanker-devco/clanker.world/blob/main/docs/api-registry.ts) — update the registry to change API documentation
* **SDK docs** are generated via [TypeDoc](https://typedoc.org/) from JSDoc comments in [`clanker-sdk/src/`](https://github.com/clanker-devco/clanker-sdk/tree/main/src) — update JSDoc in source to change SDK documentation

Both repos have GitHub Actions that regenerate and push docs here on every merge to `main`.