Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.royaltyport.com/llms.txt

Use this file to discover all available pages before exploring further.

The Royaltyport API gives you programmatic access to your organization’s projects, contracts, entities, artists, writers, and project sandboxes. It is available as both a traditional REST API and a Model Context Protocol (MCP) server for AI agent integrations.

​
Base URL

All REST API requests are made to: 
https://api.royaltyport.com/v1
The MCP servers are documented at MCP Servers.

​
Authentication

Royaltyport supports two authentication methods:
  • OAuth 2.1 (recommended) — MCP clients, the CLI, and third-party apps authenticate via a browser-based consent flow. No tokens to manage.
  • API tokens — static credentials for server-side integrations, CI/CD pipelines, and headless environments.
curl https://api.royaltyport.com/v1/projects \
  -H "Authorization: Bearer rp_your_token_here"
See Authentication for full details.

​
Response Format

All successful responses return a JSON object with a data key: 
{
  "data": { ... }
}
Error responses return a JSON object with an error key: 
{
  "error": {
    "message": "A human-readable error description"
  }
}
Validation errors may return field-level details: 
{
  "error": {
    "projectId": ["Required"]
  }
}

​
Rate Limiting

API requests are rate-limited per token. Every response includes rate limit headers:
HeaderDescription
X-RateLimit-LimitMaximum requests allowed per window
X-RateLimit-RemainingRequests remaining in the current window
X-RateLimit-ResetUnix timestamp when the window resets
When the limit is exceeded, the API returns a 429 status with an error message.

​
HTTP Status Codes

CodeMeaning
200Success
400Bad request — invalid or missing parameters
401Unauthorized — missing, invalid, or expired token
403Forbidden — token does not have access to the requested project
404Not found — the requested resource does not exist
429Rate limit exceeded
500Internal server error

​
Available Resources

Authentication

OAuth 2.1, API tokens, and token management.

REST API

Projects, contracts, entities, artists, writers, and sandboxes.

MCP Server

Model Context Protocol integration for AI agents.

CLI

Command-line interface for authentication, project browsing, and sandbox access.

Node.js SDK

Official TypeScript SDK with type-safe access to all API resources.