Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.wanderersguide.app/llms.txt

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

The Wanderer’s Guide API lets external tools read and write the same content and characters the web app uses: spells, items, feats, ancestries, classes, characters, campaigns, and everything in between.

​
Base URL

https://api.wanderersguide.app/functions/v1
If you’re running a self-hosted Supabase stack (see the development guide), point at your local instance instead. Typically that’s http://127.0.0.1:54321/functions/v1.

​
Every request is POST with a JSON body

There are no GET endpoints, no path parameters, no query strings. Every endpoint is a Supabase Edge Function reached as: 
POST /functions/v1/<function-name>
Content-Type: application/json
Authorization: Bearer <your-key>
If your call has no parameters, send {} (or omit the body where the spec marks it optional).

​
JSend response format

Every response is a JSend envelope: 
{ "status": "success", "data": { /* ... */ } }
{ "status": "fail",    "data": { "message": "Invalid API Key" } }
{ "status": "error",   "message": "Server error" }
  • success: operation completed. Read data for the result.
  • fail: operation refused due to bad input or insufficient permissions. Read data.message.
  • error: server-side problem. Read message.
Always check status before using data. The HTTP status code is 200 for success and fail alike, and only flips to 4xx/5xx when the request never reached the function (e.g. invalid API key returns 401).

​
Authentication

Two flows:
  • API key, for tools, scripts, and integrations. Create one in your Wanderer’s Guide account settings (see Account → Developer → API Clients).
  • Supabase JWT, used by the web app itself.
See Authentication for the full picture, including character-level access grants.

​
Where to next

Quickstart

Make your first request in curl, JavaScript, or Python.

Authentication

API keys, JWTs, and how character access grants work.

Content model

How spells, feats, ancestries, and the rest fit together, and what the operations engine does to them at character build time.

Search

Full-text and advanced search across every content type.