Developer API

Integrate with the Jolly Rogenerator API to build your own tools.

API Overview

Bot API keys cover characters, campaigns, and crews. First-party mobile clients use Firebase auth on /api/app/v1/groups for revisioned campaign and crew sync.

Interactive Documentation

Explore the full API specification with our interactive Swagger UI. Test endpoints, view request/response schemas, and understand the complete API capabilities.

Open Swagger UI

API Key

Bot API endpoints require authentication via the X-Bot-API-Key header.

# Example request

curl -H "X-Bot-API-Key: your-bot-api-key" \

"https://jollyrogenerator.com/api/bot/characters?discordId=123456789"

App Groups routes under /api/app/v1 use Authorization: Bearer with a Firebase ID token. They are private and outside public CORS.

Rate Limits

Rate limits are applied per API key to ensure fair usage and system stability.

Operation Type	Limit
Read (GET)	100 requests/minute
Write (POST, PATCH, DELETE)	30 requests/minute

Rate limit headers (X-RateLimit-Limit, X-RateLimit-Remaining, X-RateLimit-Reset) are included in all responses.

Endpoints

Highlights below. Swagger lists the full surface, including App Groups schemas.

Characters (Bot)

GET/api/bot/characters

List all characters for a Discord user

GET/api/bot/characters/:id

Get full character details including items and abilities

PATCH/api/bot/characters/:id

Update HP, luck, silver, or ability scores

GET/api/bot/characters/:id/inventory

Get character inventory categorized by type

POST/api/bot/characters/:id/inventory

Add a new item to character inventory

DELETE/api/bot/characters/:id/inventory/:itemId

Remove an item from character inventory

POST/api/bot/characters/:id/advance

Level up character with automatic HP roll

Campaigns (Bot)

GET/api/bot/campaigns

List campaigns for a Discord user

POST/api/bot/campaigns

Create a campaign with the user as GM

GET/api/bot/campaigns/:id

Get campaign details, members, and characters

POST/api/bot/campaigns/join/:inviteCode

Join a campaign with an invite code

POST/api/bot/campaigns/:id/characters

Assign an owned character to a campaign

GET/api/bot/campaigns/:id/members

List campaign members

Crews (Bot)

GET/api/bot/crews

List crews for a Discord user

POST/api/bot/crews

Create a crew with equal member permissions

GET/api/bot/crews/:id

Get crew details, members, and characters

POST/api/bot/crews/join/:inviteCode

Join a crew with an invite code

GET/PATCH/api/bot/crews/:id/notes

Read or update shared crew notes

POST/api/bot/crews/:id/leave

Leave a crew

App Groups (Firebase)

GET/api/app/v1/groups?type=…

List campaigns or crews for the signed-in user

POST/api/app/v1/groups

Create a campaign or crew with a mutation envelope

POST/api/app/v1/groups/join

Join by invite code with clientMutationId

GET/api/app/v1/groups/:id

Fetch a revisioned group snapshot

PATCH/api/app/v1/groups/:id

Update group fields against baseRevision

GET/api/app/v1/groups/:id/activity

Cursor-paginated activity for a group

View full endpoint documentation

Error Codes

All errors return a JSON response with an error code for easy handling.

Code	Description
`UNAUTHORIZED`	Authentication required
`INVALID_API_KEY`	Invalid API key provided
`OWNERSHIP_DENIED`	User does not own the resource
`RATE_LIMITED`	Rate limit exceeded
`NOT_FOUND`	Resource not found
`CHARACTER_NOT_FOUND`	Character not found
`ITEM_NOT_FOUND`	Item not found
`CAMPAIGN_NOT_FOUND`	Campaign not found
`NOT_CAMPAIGN_MEMBER`	User is not a campaign member
`CREW_NOT_FOUND`	Crew not found
`NOT_CREW_MEMBER`	User is not a crew member
`REVISION_CONFLICT`	Stale baseRevision on an app group write
`VALIDATION_ERROR`	Request validation failed

Ready to integrate? Explore the interactive API documentation or contact us to get your API key.

Open Swagger UI

Join Discord