An Agent Skill that gives your AI assistant complete knowledge of the Royalti.io REST API v2.6. When installed, your agent can help you write integration code, debug API calls, set up webhooks, manage DDEX distribution, and navigate the 400+ endpoint API surface without you having to explain the patterns each time.
Works with Claude Code, Claude Desktop, Cursor, OpenAI Codex, GitHub Copilot, OpenClaw, Gemini CLI, Amp, Goose, Roo Code, OpenCode, Letta, and any tool that supports the Agent Skills open standard.
- Authentication — Two-step JWT flow, API keys (RWAK/RUAK), OAuth, rate limits, RBAC roles, feature gating
- Request patterns — Pagination, filtering, search, bulk operations
- Response patterns — Success, error, paginated list, and summary response shapes
- Core resources — CRUD patterns for users, artists, assets, products, splits, royalties, payments, files, labels, releases, and more
- Global search — Cross-entity search across the entire catalog
- Royalty sources — Source management, activation/deactivation
- Source creator — AI-powered source creation wizard (analyze, map, generate, test, save)
- Checklist / data quality — Validation checks, catalog enrichment, workflow orchestration
- DDEX distribution — ERN/MEAD generation, message management, delivery, provider config
- AI chat agent — Conversational AI with Vercel AI SDK streaming support
- Merlin addon — Automated FTP royalty import with approval workflows
- Data shares — Cross-tenant royalty data sharing
- Music publishing — Publishers, writers, works, CWR export, sub-publishing
- Currency management — Multi-currency support with tenant configuration
- Billing & subscriptions — Stripe-backed subscription management
- Custom domains — Cloudflare SaaS domain management
- Admin dashboard — Workspace admin overview, worker management
- Audit trail — Security and compliance audit logging
- Monitoring — FUGA delivery and DDEX registry monitoring
- Analytics — 11 royalty analytics endpoints with filtering and period comparison
- Webhooks — 25+ event types, payload structure, HMAC validation, delivery management
- WebSocket events — Real-time file processing and workflow events via Socket.io
- Data models — User, Artist, Asset, Product, Split, Transaction, Source, Publisher, Writer, Work schemas
- Integration patterns — Step-by-step flows for catalog sync, file upload, source creation, DDEX distribution, data quality, analytics, release lifecycle, and webhook setup
# Clone and copy to your project
git clone https://github.com/Royalti-io/royalti-api-skill.git
cp -r royalti-api-skill/skills/royalti-api .claude/skills/
# Or install globally (all projects)
cp -r royalti-api-skill/skills/royalti-api ~/.claude/skills/Use a symlink instead of copying to get updates automatically with git pull:
# Clone once
git clone https://github.com/Royalti-io/royalti-api-skill.git
# Symlink into your project
ln -s "$(pwd)/royalti-api-skill/skills/royalti-api" .claude/skills/royalti-api
# Or symlink globally (all projects)
ln -s "$(pwd)/royalti-api-skill/skills/royalti-api" ~/.claude/skills/royalti-apiThen to update: cd royalti-api-skill && git pull
- Download the
skills/royalti-api/folder from this repo - Zip it:
zip -r royalti-api.zip royalti-api/ - Open Claude Desktop → Settings → Capabilities → Skills
- Upload the
royalti-api.zipfile
The skill will be available in all your Claude Desktop conversations.
# Copy into your OpenClaw skills directory
cp -r skills/royalti-api ~/.openclaw/skills/Or add the path to skills.load.extraDirs in ~/.openclaw/openclaw.json.
# OpenSkills
npx openskills install Royalti-io/royalti-api-skill
# Vercel Skills
npx skills add Royalti-io/royalti-api-skillThis skill follows the Agent Skills open standard. Copy skills/royalti-api/ into the skills directory for your tool:
| Tool | Path |
|---|---|
| Cursor | .cursor/skills/royalti-api/ |
| OpenAI Codex | .codex/skills/royalti-api/ |
| GitHub Copilot (VS Code) | .github/skills/royalti-api/ |
| Gemini CLI | .gemini/skills/royalti-api/ |
| Amp | .amp/skills/royalti-api/ |
| Goose | .goose/skills/royalti-api/ |
| Roo Code | .roo/skills/royalti-api/ |
| OpenCode | .opencode/skills/royalti-api/ |
| Letta | .letta/skills/royalti-api/ |
Once installed, the skill activates automatically when your conversation involves the Royalti API. Examples:
"How do I authenticate with the Royalti API?"
"What's the pagination pattern for listing assets?"
"Help me set up webhooks to track payment events"
"Write a function to upload and process a royalty file"
.
├── README.md
├── LICENSE
└── skills/
└── royalti-api/
├── SKILL.md # The skill (Agent Skills standard)
└── references/
├── examples-javascript.md # Node.js/TypeScript examples
├── examples-python.md # Python examples
└── examples-php.md # PHP examples
Code examples cover authentication, CRUD operations, pagination, file upload, WebSocket events, webhook receivers, global search, DDEX distribution, AI chat streaming, source creator flows, release lifecycle, and checklist/data quality for each language.
This skill follows the Agent Skills open standard, an open specification originally developed by Anthropic and adopted by 25+ tools. Any AI coding assistant or agent that supports SKILL.md files can use this skill — write once, use everywhere.
Royalti.io is a royalty management platform for music labels, distributors, and publishers. The API provides programmatic access to manage artists, tracks, releases, royalty splits, payments, analytics, and more.
- API Base URL:
https://api.royalti.io - Developer Docs: apidocs.royalti.io
- MCP Server: royalti.io/mcp — AI assistant integration for direct API interaction
- MCP Setup Guide: royalti.io/help/setting-up-the-royalti-mcp-server
MIT