Tool

Description

list_campaigns

List your campaigns. Returns a paginated list.

get_campaign

Get a specific campaign by ID.

get_campaign_stats

Get statistics for a campaign: character count, session count, and more.

create_campaign

Create a new campaign. Subject to the account's subscription-tier campaign limit.

update_campaign

Partially update campaign metadata (title, description, tones, public/mature flags).

Tool

Description

list_sessions

List game sessions. Filter by session type or public-only.

get_session

Get a session by ID. Optionally include related beats and moments.

get_session_cast_analysis

Get cast analysis: talk-share breakdown and core session metrics.

get_session_transcript

Get the cleaned transcript for a game session, including utterances, full text, and aggregate stats.

get_session_handout

Get the generated session handout for a game session, including summary, outlines, spotlights, and notable moments.

patch_session

Partial update (title, session_date, summary, image). Explicit-link contract for wikilinks.

update_session

Full update (PUT). Explicit-link contract for wikilinks.

Tool

Description

list_beats

List beats ordered by index. Beats represent story moments (major, minor, step).

get_beat

Get a specific beat by ID.

create_beat

Create a beat. Explicit-link contract for wikilinks.

update_beat

Partially update a beat.

delete_beat

Delete a beat (child beats have parent_id cleared).

list_moments

List moments in a campaign or session. Moments capture memorable quotes and events.

get_moment

Get a specific moment by ID.

create_moment

Create a moment attached to a session. Explicit-link contract for wikilinks.

update_moment

Partially update a moment.

delete_moment

Delete a moment.

Tool

Description

list_characters

List characters in a campaign. Filter by name, type (PC/NPC), or approval status.

get_character

Get a character by ID including aliases, backstory, and speaker linkage.

create_character

Create a character. Description/backstory wikilinks auto-resolve.

update_character

Partially update a character. Read with with_links: true before editing description/backstory.

delete_character

Delete a character. API unbrackets all inbound [[alias]] references automatically.

list_factions

List factions. Factions represent guilds, organisations, or other groups.

get_faction

Get a specific faction by ID.

create_faction

Create a faction. Description wikilinks auto-resolve.

update_faction

Partially update a faction. Read with with_links: true before editing.

delete_faction

Delete a faction.

list_locations

List locations. Locations can be nested (cities, taverns, dungeons, etc.).

get_location

Get a specific location by ID.

create_location

Create a location. Description wikilinks auto-resolve.

update_location

Partially update a location. Read with with_links: true before editing.

delete_location

Delete a location (child locations have parent_id cleared).

list_items

List items. Items include weapons, armour, artefacts, and other notable objects.

get_item

Get a specific item by ID.

create_item

Create an item. Description wikilinks auto-resolve.

update_item

Partially update an item. Read with with_links: true before editing.

delete_item

Delete an item.

Tool

Description

list_quests

List quests with pagination. Filter by status or category.

get_quest

Get a fully expanded quest: objectives, progress log, related entities, session provenance.

create_quest

Create a quest entry. Quests do not participate in the wikilinks system.

update_quest

Partially update a quest. Lists you send replace their corresponding lists on the record.

delete_quest

Delete a quest and its objectives / progress entries / related refs.

Tool

Description

list_journals

List journal entries. Content omitted from list; use get_journal for full content.

get_journal

Get a journal entry by ID including full content and permission level.

create_journal

Create a journal entry. Returns {success, id}.

update_journal

Update a journal entry (PUT). Returns {success, id}.

delete_journal

Delete a journal entry (embeddings are best-effort deleted).

list_journal_folders

List journal folders ordered by path and position for tree rendering.

get_journal_folder

Get a specific journal folder by ID.

create_journal_folder

Create a journal folder (owners/admins only; path must be unique per campaign).

update_journal_folder

Update a journal folder (PUT).

delete_journal_folder

Delete a folder; entries move to the campaign root.

Tool

Description

list_links

List links between entities. Filter by source/target entity and relationship alias.

create_link

Create a Link row between two entities (upserts if (from_type, from_id, alias) collides).

update_link

Update an existing link's alias.

delete_link

Delete a single Link row (does not rewrite the source's text).

bulk_link_maintenance

Trigger campaign-wide link maintenance (add/remove/update) via webhook — requires an active subscription tier.

Tool

Description

get_image_usage

Return the calling account's image quota for a campaign: used/limit, tier, can_access, and cycle window. Call before generate_image to avoid quota errors.

generate_image

Server-side AI generation for character, faction, location, item, or world. Rewrites the entity's description into an image prompt (user_input optional). Returns a public URL — set it on the entity via the matching update tool if you want to attach it. Consumes the account's image quota.

init_image_upload

Step 1 of direct upload: reserve an object_key and receive a presigned S3 PUT URL. The client then PUTs the raw image bytes to upload_url with the same Content-Type. Expires after expires_in_seconds.

complete_image_upload

Step 2 of direct upload: validate the uploaded object, run NSFW moderation, and (when attach: true) set the entity's image field to the moderated URL.

delete_entity_image

Remove an image. Provide entity_type + entity_id (detaches AND deletes the object) or image_url (deletes just the object).

Record type

Contract

Character, Faction, Location, Item, Character.backstory

Auto-resolve. On write, the API extracts [[…]] from your new text, matches each against records in the same campaign, and syncs the Link table (inserts new, updates changed, deletes removed). New [[Alias]] markup for a matchable target creates a Link automatically.

GameSession, Beat, Moment

Explicit-link only. The API strips [[Alias]] markup that does NOT already have a matching Link row for that source. To add a wikilink, first call create_link with the correct from_type/from_id, then include [[Alias]] in the text on your write.

Journal

Rendering-only. Stored [[…]] markup renders as links on read with with_links: true but writes do not auto-populate the Link table. Use create_link (from_type=Journal) if you want persistent link tracking.

Quest

No wikilinks. Quest text fields are stored verbatim. Relationships are modelled via the related_* list fields, not wikilinks.

Delete (any record)

The API automatically unbrackets all [[alias]] references to a deleted record across every referring text field. No manual cleanup is required.