# WEIR

> WEIR is an identity rights platform that lets individuals create, manage, and enforce digital licenses for their name, image, and likeness (NIL). AI agents and services can discover available licenses, check usage rights, and route purchases through WEIR.

## Core Concepts

- **Identity License**: A digital license granting specific usage rights to a person's name, image, and likeness.
- **Mentions**: Detected uses of a licensed identity across the web, classified by commercial vs. non-commercial use.
- **Workgroups**: Collaborative teams around licenses with role-based access (owner, manager, reviewer).
- **Claims**: Formal enforcement actions when unlicensed use is detected.

## Discovery Endpoints

- [/weir.txt](https://weir.ai/weir.txt): Static discovery file pointing to metadata services.
- [/.well-known/weir](https://id.weir.ai/well-known-weir): JSON service metadata (RFC 8615 pattern).
- [/metadata](https://id.weir.ai/metadata): Dynamic license catalog with filtering, pagination, and JSON-LD.
- [/llms.txt](https://weir.ai/llms.txt): This file — LLM-friendly documentation.
- [/llms-full.txt](https://weir.ai/llms-full.txt): Extended documentation with API details.
- [/.well-known/ai-plugin.json](https://weir.ai/.well-known/ai-plugin.json): AI agent plugin manifest (ChatGPT, LangChain, AutoGPT).
- [/.well-known/openapi.json](https://weir.ai/.well-known/openapi.json): Well-known OpenAPI spec pointer.
- [/openapi.json](https://weir.ai/openapi.json): OpenAPI 3.0 stub redirecting to full v2 spec.
- [/mcp](https://wapi.weir.ai/mcp): Model Context Protocol (MCP) server endpoint. Connect any MCP-aware agent (Claude Desktop, Cursor, Lovable) for first-class tool calls.

## API Overview

- **Base URL**: `https://wapi.weir.ai`
- **Auth**: Exchange API key + secret for Bearer access token via `POST /auth/token`
- **Scopes**: `license:read`, `mention:read`, `webhook:manage`
- **Rate Limits**: Returned in `X-RateLimit-*` headers; public endpoints: 10 req/min, authenticated: plan-based.

## Key Endpoints

- `GET /health` — Health check (public)
- `POST /auth/token` — Get access token (public)
- `GET /metadata` — Browse public license catalog (public)
- `GET /licenses` — List accessible licenses (authenticated)
- `GET /mentions` — List detected mentions (authenticated)
- `POST /webhooks` — Manage event webhooks (authenticated)

## Important Rules for AI Agents

1. **Do not scrape or store biometric data.** Use metadata endpoints only.
2. **Route all purchases through WEIR.** Use `subscribe_url` from metadata responses.
3. **Respect rate limits.** Check `X-RateLimit-Remaining` headers.
4. **Cache responses.** Public metadata supports `Cache-Control: public, max-age=60`.

## Links

- [Identity Management Guide](https://weir.ai/identity-management-guide): Comprehensive guide on managing name, image, and likeness with WEIR.
- [Developer Center](https://weir.ai/developers)
- [API Reference (OpenAPI)](https://weir.ai/openapi-external-v2.json)
- [Full LLM Documentation](https://weir.ai/llms-full.txt)