Archivist Developer Docs

Quick Start

1. Sign in to Archivist and create an API key in Account Settings → API Keys.
2. Save your key securely as an environment variable.
3. Ping the health endpoint to verify connectivity.

curl https://api.myarchivist.ai/health

Expected response:

{
  "status": "healthy",
  "service": "archivist-api",
  "version": "1.0.0",
  "environment": "production",
  "port": 8000,
  "timestamp": "2025-01-15T10:30:00.123456Z"
}

Authentication

Send your API key with every request using the x-api-key header.

curl -H "x-api-key: YOUR_API_KEY" https://api.myarchivist.ai/v1/campaigns

Do not embed keys in client-side code. Rotate compromised keys immediately.

Core Concepts

Data Models

Representative TypeScript interfaces for common resources. Fields may be extended over time; unknown fields should be ignored by clients.

// Common primitives
export type ID = string; // stable, opaque identifier
export type ISODate = string; // ISO 8601 timestamp

// Campaign
export interface Campaign {
  id: ID;
  title: string;
  description?: string;
  system: string;
  summary?: string;
  language: string;
  image?: string;
  public: boolean;
  mature: boolean;
  owner_id: ID;
  created_at: ISODate;
  updated_at?: ISODate;
}

export interface CampaignStats {
  campaign_id: ID;
  title: string;
  characters: number;
  sessions: number;
  moments: number;
  public: boolean;
  created_at: ISODate;
}

// Session
export type SessionType = 'audioUpload' | 'playByPost' | 'discordVoice' | 'txtUpload' | 'rawNotes' | 'other';
export interface GameSession {
  id: ID;
  campaign_id: ID;
  type: SessionType;
  title: string;
  summary?: string;
  notes?: string;
  session_date: ISODate;
  image?: string;
  index?: number;
  public: boolean;
  pbp_start_msg_url?: string;
  pbp_end_msg_url?: string;
  created_at: ISODate;
  updated_at?: ISODate;
}

export interface GameSessionDetail extends GameSession {
  beats?: Beat[];
  moments?: Moment[];
}

// Beat
export type BeatType = 'major' | 'minor' | 'step';
export interface Beat {
  id: ID;
  campaign_id: ID;
  label: string;
  type: BeatType;
  description?: string;
  index: number;
  parent_id?: ID;
  metadata?: Record<string, unknown>;
  game_session_ids: ID[];
  game_session_id?: ID;
  created_at: ISODate;
  updated_at?: ISODate;
}

export interface BeatHierarchyRead extends Beat {
  children: BeatHierarchyRead[];
}

// Moment
export interface Moment {
  id: ID;
  campaign_id: ID;
  session_id: ID;
  label?: string;
  content?: string;
  image?: string;
  index?: number;
  categories?: string[];
  created_at: ISODate;
  updated_at?: ISODate;
}

// Card shapes (fields=card list endpoints)
export interface CharacterCard {
  id: ID;
  character_name: string;
  type: CharacterType;
  image?: string;
}

export interface MomentCard {
  id: ID;
  label?: string;
  image?: string;
  session_id: ID;
  created_at: ISODate;
  categories: string[];
}

export interface JournalCard {
  id: ID;
  title: string;
  summary?: string;
  updated_at?: ISODate;
  folder_id?: ID;
}

export interface EntityCard {
  id: ID;
  name: string;
  type?: string;
  image?: string;
}

export interface EntitiesListResponse {
  results: EntityCard[];
  hasMore: boolean;
  page: number;
  pages: number;
  total: number;
}

// Character
export type CharacterType = 'PC' | 'NPC' | 'Other';
export interface CharacterPlayer {
  id: ID;
  name?: string;
  handle?: string;
  roles: string[];
  campaign_id: ID;
  created_at: ISODate;
}

export interface Character {
  id: ID;
  campaign_id: ID;
  character_name: string;
  character_alias?: string;
  character_aliases: string[];
  player_name?: string;
  player_handle?: string;
  player?: CharacterPlayer | null;
  description?: string;
  backstory?: string;
  type: CharacterType;
  image?: string;
  tcg_image?: string;
  merge: boolean;
  created_at: ISODate;
  updated_at?: ISODate;
}

// Faction
export interface Faction {
  id: ID;
  campaign_id: ID;
  name: string;
  aliases: string[];
  description?: string;
  type?: string;
  image?: string;
  tcg_image?: string;
  merge: boolean;
  created_at: ISODate;
  updated_at?: ISODate;
}

// Location
export interface Location {
  id: ID;
  campaign_id: ID;
  name: string;
  aliases: string[];
  description?: string;
  type?: string;
  parent_id?: ID;
  image?: string;
  tcg_image?: string;
  merge: boolean;
  created_at: ISODate;
  updated_at?: ISODate;
}

// Item
export interface Item {
  id: ID;
  campaign_id: ID;
  name: string;
  aliases: string[];
  description?: string;
  type?: string;
  image?: string;
  tcg_image?: string;
  merge: boolean;
  created_at: ISODate;
  updated_at?: ISODate;
}

// Cast Analysis
export interface CastAnalysis {
  id: ID;
  session_id: ID;
  analysis: Record<string, unknown>;
  created_at: ISODate;
  updated_at?: ISODate;
}

// Session Handout (note: camelCase keys in response)
export interface SessionHandout {
  summary: string;
  sessionOutline: string | Array<{ title: string }>;
  encounters: Array<{ title: string; bullets: string[] }>;
  characterSpotlight: Array<{ name: string; description: string; bullets: string[] }>;
  otherEntitySpotlight: Array<{ name: string; description: string }>;
  items: Array<{ name: string; description: string }>;
  valuableInformation: Array<{ info: string }>;
  partyStatusAndNextSteps: {
    partyStatus: { summary: string; bullets: string[] };
    nextSteps: { summary: string };
  };
  moments: Array<{ label: string; content: string }>;
}

// Quest
export type QuestCategory = 'main' | 'side' | 'faction' | 'personal' | 'n/a';
export type QuestStatus = 'planned' | 'in-progress' | 'blocked' | 'failed' | 'done' | 'n/a';
export type ObjectiveStatus = 'pending' | 'in-progress' | 'completed' | 'failed' | 'blocked';
export type QuestEntityType = 'character' | 'faction' | 'location' | 'item';

export interface QuestObjective {
  id: ID;
  text: string;
  status: ObjectiveStatus;
  order: number;
}

export interface QuestProgressEntry {
  id: ID;
  text: string;
  order: number;
  session_id?: ID | null;
  session_number?: number | null;
  session_title?: string | null;
  session_date?: ISODate | null;
}

export interface QuestRelatedEntityRef {
  id: ID;
  entity_type: QuestEntityType;
  entity_id?: ID | null;
  entity_name_snapshot?: string | null;
  label?: string | null;
  order: number;
}

export interface QuestSessionRef {
  id: ID;
  number?: number | null;
  title?: string | null;
  session_date?: ISODate | null;
}

export interface Quest {
  id: ID;
  campaign_id: ID;
  order_index: number;
  quest_name: string;
  quest_giver?: string | null;
  quest_giver_id?: ID | null; // resolved Character/Faction id when available
  quest_category: QuestCategory;
  status: QuestStatus;
  success_definition?: string | null;
  failure_conditions?: string | null;
  next_action?: string | null;
  resolution?: string | null;
  objectives: QuestObjective[];
  progress_log: string[];
  progress_log_entries: QuestProgressEntry[];
  related_characters: string[];
  related_factions: string[];
  related_locations: string[];
  related_items: string[];
  related_entity_refs: QuestRelatedEntityRef[];
  first_session?: QuestSessionRef | null;
  last_session?: QuestSessionRef | null;
  created_at: ISODate;
  updated_at?: ISODate | null;
}

// Link (relationship)
export type EntityType = 'Character' | 'Faction' | 'Location' | 'Item' | 'Beat' | 'Moment';
export interface Link {
  id: ID;
  campaign_id: ID;
  from_id: ID;
  from_type: EntityType;
  to_id: ID;
  to_type: EntityType;
  alias: string;
  created_at: ISODate;
}

// Journal Entry
export interface JournalEntry {
  id: ID;
  campaign_id: ID;
  title: string;
  summary?: string;
  content?: string; // included on detail GET, omitted from list
  content_rich?: unknown; // Lexical editor state JSON (detail only)
  content_metadata?: unknown; // detail only
  tags: string[];
  token_count: number;
  cover_image?: string;
  is_pinned: boolean;
  is_public: boolean;
  status?: 'draft' | 'published' | 'archived';
  published_at?: ISODate;
  archived_at?: ISODate;
  folder_id?: ID;
  author_id?: ID;
  last_edited_by_id?: ID;
  permission_level?: 'view' | 'comment' | 'edit' | 'manage'; // detail only
  created_at: ISODate;
  updated_at?: ISODate;
}

// Journal Folder
export interface JournalFolder {
  id: ID;
  campaign_id: ID;
  parent_id?: ID;
  name: string;
  path: string;
  description?: string;
  position: number;
  metadata?: unknown;
  created_at: ISODate;
  updated_at?: ISODate;
}

// Ask (RAG)
export interface ChatMessage { role: 'system' | 'user' | 'assistant'; content: string; }
export interface AskRequest { campaign_id: ID; messages: ChatMessage[]; stream?: boolean; }
export interface AskChunk { id: string; type: 'delta' | 'done'; content?: string; }

Conventions

• Base URL: https://api.myarchivist.ai
• Authentication: All endpoints require x-api-key unless otherwise noted.
• Pagination: list endpoints accept page and size. The default size is server‑defined; clients should not assume a maximum.
• Timestamps: All dates are returned in ISO 8601 (UTC). Client UIs should localize for display.
• Idempotency: POST generally creates, PATCH updates via JSON Merge Patch where specified.
• Errors: Error responses use FastAPI-style JSON bodies with a top-level detail field.
• Filtering: List endpoints support filters such as campaign_id, character_type, and search. Compendium and journal search uses Postgres full-text search (searchVector) across names, aliases, tags, and related indexed fields, with ILIKE fallback. Moments and quests still use substring matching on label/name fields.
• Card lists: Pass fields=card on characters, moments, and journals list endpoints for lightweight picker items.
• Entity picker: GET /v1/entities uses limit (not size) and returns a {results, hasMore} envelope.
• Moment filters: Moment list supports character_ids, location_ids, faction_ids, item_ids, and session_ids comma-separated ID filters.
• Image URLs: The image field for Characters, Items, Factions, and Locations must be an HTTPS URL (max 2048 characters). HTTP URLs are rejected with a validation error.

Read-Only Properties

Certain properties are system-managed and cannot be set through POST or PATCH requests. These fields appear in GET responses but are ignored if included in create/update operations.

• Campaigns: public, created_at
• Sessions: public, created_at
• Characters, Locations, Factions, Items: merge, created_at
• All entities: id, created_at

These properties are managed by the system based on application logic, user permissions, and moderation workflows.

Wikilinks & Relationships

Resources

Typical Workflow

A simple sequence: create a campaign, rely on bootstrap defaults, add a character, then list sessions.

API_KEY="your-api-key"
BASE_URL="https://api.myarchivist.ai"

# 1) Create a campaign
curl -s -X POST \
  -H "x-api-key: $API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "title": "My First API Campaign",
    "description": "Created via API",
    "system": "D&D 5e"
  }' \
  "$BASE_URL/v1/campaigns"