How to Get a World Anvil API Key or Token

World Anvil's API lets you connect third-party applications with your World Anvil content, so you can build your own apps that use World Anvil or use apps made by other World Anvil users. It's important to distinguish between:

• Master User API tokens: These are codes that let other apps access your worldbuilding on World Anvil. You're in full control of generating or revoking them. If you want to use an app someone else has built, use this.
• Grandmaster Applications keys: You can request an application key to build an app that interacts with World Anvil. These keys don't give access to specific content, but to the API itself. If you want to build your own app, use this.

How to get an API token

To get a personal API token to be used in third-party apps:

1. Click your profile picture at the top right.
2. Select "User API Tokens".

   

3. On the right, type a descriptive name for the token and click "Create new Token".

You can revoke your tokens at any time from the same page, using the "Delete" button next to each of them.

How to get an application key

If you want to build your own app that uses World Anvil, follow these steps:

1. Click your profile picture at the top right.
2. Select "User API Tokens".
3. Click on the "Application Key Form" button and fill out the request form.
4. We review all requests manually. If you don't get a reply within 15 days, you can email us at [email protected].

In order to request and use an application key, you must read and abide by the API license terms. Note that we don't provide dedicated support for building applications with our API, as this is a very advanced feature. However, here are two useful resources:

• Official resource: World Anvil API documentation.
• Community support: Join our Discord server and use the #api-development-help channel to ask questions to other World Anvil users.