# Wanderer's Guide Docs

## Docs

- [Authentication](https://docs.wanderersguide.app/api-reference/authentication.md): Pick the right auth flow (API key for tools and integrations, JWT for the web app) and understand how character-level access grants work.
- [Create or update a campaign](https://docs.wanderersguide.app/api-reference/campaigns/create-campaign.md): Creating a new campaign requires Patreon tier 1+ (free users cannot create campaigns).
- [Create or update an encounter](https://docs.wanderersguide.app/api-reference/campaigns/create-encounter.md): Creating new encounters requires Patreon tier 1+.
- [Find campaigns](https://docs.wanderersguide.app/api-reference/campaigns/find-campaign.md): Find campaigns
- [Find encounters](https://docs.wanderersguide.app/api-reference/campaigns/find-encounter.md): Find encounters
- [Remove a character (and its player) from a campaign](https://docs.wanderersguide.app/api-reference/campaigns/remove-from-campaign.md): Remove a character (and its player) from a campaign
- [Regenerate the campaign join key](https://docs.wanderersguide.app/api-reference/campaigns/reset-campaign-key.md): Only the campaign owner (GM) can reset the key. Existing join codes immediately stop working.
- [Create or update a character](https://docs.wanderersguide.app/api-reference/characters/create-character.md): Free users are limited to 6 characters. Patreon tier 2+ removes the cap. Pass id to update.
- [Find characters](https://docs.wanderersguide.app/api-reference/characters/find-character.md): When called with an API key, the caller must have a client_access grant on the requested character (set via the user UI). Without a grant, returns 403. Filtering by campaign_id only returns all characters in that campaign so members can see each other.
- [Update an existing character](https://docs.wanderersguide.app/api-reference/characters/update-character.md): Same body shape as create-character but id is required. Forbidden keys (id, created_at, content_source_id, user_id) are stripped server-side.
- [Create or update an ability block (feat, action, etc.)](https://docs.wanderersguide.app/api-reference/content/create-ability-block.md): Create or update an ability block (feat, action, etc.)
- [Create or update an ancestry](https://docs.wanderersguide.app/api-reference/content/create-ancestry.md): Auto-creates the associated ancestry trait if trait_id is missing.
- [Create or update an archetype](https://docs.wanderersguide.app/api-reference/content/create-archetype.md): Create or update an archetype
- [Create or update a background](https://docs.wanderersguide.app/api-reference/content/create-background.md): Create or update a background
- [Create or update a class](https://docs.wanderersguide.app/api-reference/content/create-class.md): Create or update a class
- [Create or update a class archetype](https://docs.wanderersguide.app/api-reference/content/create-class-archetype.md): Create or update a class archetype
- [Create or update a content source (book)](https://docs.wanderersguide.app/api-reference/content/create-content-source.md): Creating a new homebrew content source requires Patreon tier 2+. Updating an existing source requires ownership.
- [Create or update a creature](https://docs.wanderersguide.app/api-reference/content/create-creature.md): Create or update a creature
- [Create or update an item](https://docs.wanderersguide.app/api-reference/content/create-item.md): Create or update an item
- [Create or update a language](https://docs.wanderersguide.app/api-reference/content/create-language.md): Create or update a language
- [Create or update a spell](https://docs.wanderersguide.app/api-reference/content/create-spell.md): Pass id to update an existing row, omit id (or set to -1) to insert a new one.
- [Create or update a trait](https://docs.wanderersguide.app/api-reference/content/create-trait.md): Create or update a trait
- [Create or update a versatile heritage](https://docs.wanderersguide.app/api-reference/content/create-versatile-heritage.md): Create or update a versatile heritage
- [Delete a content row](https://docs.wanderersguide.app/api-reference/content/delete-content.md): Deletes any single row from a content table. Caller must be the row owner (or owner of the row's content source) or an admin/mod. Anyone else gets a JSend fail.
- [Find ability blocks (feats, actions, class features, etc.)](https://docs.wanderersguide.app/api-reference/content/find-ability-block.md): Ability blocks cover feats, actions, physical-features, senses, class-features, heritages, and modes. Filter by type to narrow.
- [Find ancestries](https://docs.wanderersguide.app/api-reference/content/find-ancestry.md): Find ancestries
- [Find archetypes](https://docs.wanderersguide.app/api-reference/content/find-archetype.md): Find archetypes
- [Find backgrounds](https://docs.wanderersguide.app/api-reference/content/find-background.md): Find backgrounds
- [Find classes](https://docs.wanderersguide.app/api-reference/content/find-class.md): Find classes
- [Find class archetypes](https://docs.wanderersguide.app/api-reference/content/find-class-archetype.md): Find class archetypes
- [Find content sources (books)](https://docs.wanderersguide.app/api-reference/content/find-content-source.md): Returns published official sources by default. Pass homebrew: true to include user-created sources.
- [Find content updates / errata](https://docs.wanderersguide.app/api-reference/content/find-content-update.md): Find content updates / errata
- [Find creatures](https://docs.wanderersguide.app/api-reference/content/find-creature.md): Find creatures
- [Find items](https://docs.wanderersguide.app/api-reference/content/find-item.md): Look up items by id, name, or content source.
- [Find languages](https://docs.wanderersguide.app/api-reference/content/find-language.md): Find languages
- [Find spells](https://docs.wanderersguide.app/api-reference/content/find-spell.md): Look up spells by id, name, content source, or trait. Omit id to get an array; pass a single integer id to get one row or null.
- [Find traits](https://docs.wanderersguide.app/api-reference/content/find-trait.md): Find traits
- [Find versatile heritages](https://docs.wanderersguide.app/api-reference/content/find-versatile-heritage.md): Find versatile heritages
- [Join a Game Master's virtual-tier group](https://docs.wanderersguide.app/api-reference/gm/gm-add-to-group.md): A GM with the GAME-MASTER Patreon tier shares an access_code so members of their group inherit Patreon perks. The caller exchanges the code for membership.
- [Regenerate your GM access code](https://docs.wanderersguide.app/api-reference/gm/gm-regenerate-code.md): Invalidates the previous code; existing members stay in the group.
- [Remove a user from your GM group](https://docs.wanderersguide.app/api-reference/gm/gm-remove-from-group.md): Caller must be the GM. Removes the named user from the caller's virtual-tier group.
- [List the users in your GM group](https://docs.wanderersguide.app/api-reference/gm/gm-users-in-group.md): List the users in your GM group
- [Introduction](https://docs.wanderersguide.app/api-reference/introduction.md): The Wanderer’s Guide HTTP API: base URL, response format, and how to get started.
- [Quickstart](https://docs.wanderersguide.app/api-reference/quickstart.md): Make your first request: find a spell by name, then parse the JSend response.
- [Get usage stats for a content source](https://docs.wanderersguide.app/api-reference/search/get-content-source-stats.md): Returns the source itself plus the count of subscribers (users with this source enabled).
- [Search across all content](https://docs.wanderersguide.app/api-reference/search/search-data.md): Two modes:
- [Get a public user profile](https://docs.wanderersguide.app/api-reference/users/get-user.md): Without a body, returns the caller's own profile. Pass id (Supabase auth user id, UUID) or _id (numeric public_user.id) to look up another user. Sensitive fields (Patreon tokens, API keys) are stripped from the response.
- [Update your own profile](https://docs.wanderersguide.app/api-reference/users/update-user.md): Updates a subset of public_user fields for the authenticated caller. Accepts display_name, summary, image_url, background_image_url, organized_play_id, site_theme, subscribed_content_sources, api. The user id and timestamps are never writable.
- [Development](https://docs.wanderersguide.app/development.md): Running Wanderer's Guide locally
- [Docker](https://docs.wanderersguide.app/docker.md)
- [Content Data](https://docs.wanderersguide.app/guides/content-data.md): How spells, feats, ancestries and the rest are stored, linked, and turned into the rules that drive a character sheet.
- [Operations](https://docs.wanderersguide.app/guides/operations.md): Every operation type that runs at character build time, what it does, and the JSON shape it expects.
- [Introduction](https://docs.wanderersguide.app/index.md): Welcome to the documentation for Wanderer's Guide!

## OpenAPI Specs

- [openapi](https://docs.wanderersguide.app/api-reference/openapi.json)

## Optional

- [Community](https://discord.com/invite/FxsFZVvedr)
- [GitHub](https://github.com/wanderers-guide/wanderers-guide)
- [Legacy Docs](https://legacy.wanderersguide.app/wsc_docs/#code_basics)