Developer API
Build on your Archivist data with a straightforward web API.
Read and write world data, manage sessions and recaps, use Ask Archivist for real-time Q & A, and build dashboards, automate workflows, or sync Archivist with your systems.
What’s in the API
Sessions
- List sessions
- Update titles and summaries
Compendium
- Characters
- Items
- Locations
- Factions
Chatbot (Ask Archivist)
- Real-time Q and A grounded in your campaign
- Streamed responses for faster feedback
Getting started
Where to get your key
Archivist Profile → Developer tab
Base URL
https://api.myarchivist.ai/v1
Authentication header
x-api-key: YOUR_API_KEY
Requires an active Archivist subscription.