API Reference

Authorization: Bearer sk_server_your_key_here

{
  // Required
  text: string;              // Player's message (max 10,000 chars)
  entityMindId: string;      // Entity Mind ID (provides name, personality, knowledge filters)
  playerId: string;          // Your player identifier (for rate limiting, memory, and conversation tracking)
 
  // Optional
  context?: {
    location?: string;           // Current location name
    locationDetails?: string;    // Location description
    timeOfDay?: string;          // "morning", "evening", etc.
    weather?: string;            // Weather conditions
    npcMood?: string;            // NPC's current mood
    playerAppearance?: string;   // How player looks to NPC
    nearbyCharacters?: string[]; // Other characters present
    recentEvents?: string[];     // Recent world events
  };
 
  memory?: {
    retrieve?: boolean;      // Retrieve past memories for this player (default: false)
  };
 
  activeKnowledgeTags?: string[];  // Narrow which lore the NPC can reference (by tag name)
 
  conversationHistory?: Array<{
    role: "user" | "assistant";
    content: string;
  }>;
}

{
  success: true;
  response: string;          // NPC's response text
  character: string;         // Character name
 
  metadata: {
    memoryCheckpoint?: boolean;       // True when session hit max length and memories were auto-saved
  };
}

curl -X POST https://loremind.peekgames.dev/api/loremind/v1/npc/interact \
  -H "Authorization: Bearer sk_server_your_key" \
  -H "Content-Type: application/json" \
  -d '{
    "text": "What can you tell me about the dragon?",
    "entityMindId": "em_abc123",
    "playerId": "steam_76561198012345678",
    "context": {
      "location": "Blacksmith Shop",
      "timeOfDay": "evening",
      "weather": "rainy"
    },
    "memory": {
      "retrieve": true
    },
    "activeKnowledgeTags": ["dragon-war", "village-history"]
  }'

{
  "success": true,
  "response": "The dragon? Aye, I've heard the rumors. Spotted near the old watchtower, they say. If you're thinking of going after it, you'll need better steel than what you're carrying.",
  "character": "Grom the Blacksmith",
  "metadata": {}
}

{
  minds: Array<{
    id: string;
    entityName: string;
    personality: string;
    backstory: string | null;
    backstorySummary: string | null;
    role: string | null;
    speakingStyle: string | null;
    hints: string[];
    restrictions: string[];
    locationId: string | null;
    location: { id: string; name: string } | null;
    knowledgeTags: string[];
    knowledgeDescription: string;
    computedFilter: object;
    responseConfig: object;
    buildCreditsUsed: number;
    interactionCount: number;
    relationshipCount: number;
    createdAt: string;
    updatedAt: string;
  }>;
}

curl https://loremind.peekgames.dev/api/loremind/v1/lore/minds \
  -H "Authorization: Bearer sk_editor_your_key"

{
  success: true;
  tags: Array<{
    id: string;
    name: string;
    color: string | null;
    isDefault: boolean;
    documentCount: number;
  }>;
  defaultTags: Array<{ id: string; name: string; color: string | null; documentCount: number }>;
  customTags: Array<{ id: string; name: string; color: string | null; documentCount: number }>;
  totalCount: number;
}

{
  files: Array<{
    filename: string;     // File name (e.g., "story.ink")
    sizeBytes: number;    // File size in bytes
  }>;
}

{
  estimatedMicrocredits: number;
  estimatedCredits: number;
  availableCredits: number;    // Team's current credit balance
  perFile: Array<{
    filename: string;
    estimatedMicrocredits: number;
  }>;
}

curl -X POST https://loremind.peekgames.dev/api/loremind/v1/scanner/estimate \
  -H "Authorization: Bearer sk_editor_your_key" \
  -H "Content-Type: application/json" \
  -d '{
    "files": [
      { "filename": "story.ink", "sizeBytes": 45000 },
      { "filename": "npcs.json", "sizeBytes": 12000 }
    ]
  }'

{
  "estimatedMicrocredits": 57000,
  "estimatedCredits": 57,
  "availableCredits": 500,
  "perFile": [
    { "filename": "story.ink", "estimatedMicrocredits": 45000 },
    { "filename": "npcs.json", "estimatedMicrocredits": 12000 }
  ]
}

{
  jobId: string;
  status: "QUEUED";
  totalFiles: number;
  estimatedCredits: number;
  rejected?: Array<{ name: string; error: string }>;
}

curl -X POST https://loremind.peekgames.dev/api/loremind/v1/scanner/submit \
  -H "Authorization: Bearer sk_editor_your_key" \
  -F "files=@story.ink" \
  -F "files=@npcs.json" \
  -F "userContext=A fantasy RPG set in the kingdom of Eldrath"

{
  "jobId": "clx1abc123def456",
  "status": "QUEUED",
  "totalFiles": 2,
  "estimatedCredits": 57
}

{
  jobs: Array<{
    jobId: string;
    status: "QUEUED" | "PROCESSING" | "COMPLETED" | "FAILED";
    totalFiles: number;
    completedFiles: number;
    failedFiles: number;
    createdAt: string;
    completedAt: string | null;
  }>;
}

curl https://loremind.peekgames.dev/api/loremind/v1/scanner/jobs \
  -H "Authorization: Bearer sk_editor_your_key"

{
  jobId: string;
  status: "QUEUED" | "PROCESSING" | "COMPLETED" | "FAILED";
  totalFiles: number;
  completedFiles: number;
  failedFiles: number;
  estimatedCredits: number;
  actualCredits: number;
  errorMessage: string | null;
  createdAt: string;
  startedAt: string | null;
  completedAt: string | null;
  extractions: Array<{
    id: string;
    title: string;
    tags: string[];
    location: string | null;
    confidence: number;
    contentPreview: string;
    sourceFiles: string[];
  }>;
  skippedContent: Array<{
    section: string;
    reason: string;
    sourceFile: string;
  }>;
}

curl https://loremind.peekgames.dev/api/loremind/v1/scanner/jobs/clx1abc123def456 \
  -H "Authorization: Bearer sk_editor_your_key"

{
  jobId: string;
  extractionIds: string[];   // IDs of extractions to approve
}

{
  committed: number;
  documentIds: string[];
}

curl -X POST https://loremind.peekgames.dev/api/loremind/v1/scanner/commit \
  -H "Authorization: Bearer sk_editor_your_key" \
  -H "Content-Type: application/json" \
  -d '{
    "jobId": "clx1abc123def456",
    "extractionIds": ["ext_1", "ext_2", "ext_5"]
  }'

{
  "committed": 3,
  "documentIds": ["doc_abc", "doc_def", "doc_ghi"]
}

{
  files: Array<{
    filename: string;
    contentHash: string;    // SHA-256 hash of file content
  }>;
}

{
  changed: string[];     // Files with different hash
  added: string[];       // New files not in previous scan
  deleted: string[];     // Files in previous scan but not in current
  unchanged: string[];   // Files with same hash
}

curl -X POST https://loremind.peekgames.dev/api/loremind/v1/scanner/rescan \
  -H "Authorization: Bearer sk_editor_your_key" \
  -H "Content-Type: application/json" \
  -d '{
    "files": [
      { "filename": "story.ink", "contentHash": "a1b2c3..." },
      { "filename": "new_quest.ink", "contentHash": "d4e5f6..." }
    ]
  }'

{
  "changed": ["story.ink"],
  "added": ["new_quest.ink"],
  "deleted": ["old_quest.ink"],
  "unchanged": []
}

{
  "error": "Insufficient credits",
  "message": "This request requires approximately 0.45 credits. Current balance: 0.12.",
  "creditsNeeded": 0.45,
  "credits": 0.12
}

// In Editor: SDK uses Server API Key from Control Panel
// In Production: SDK routes through your backend URL
var npc = GetComponent<LoreMindNPC>();
var response = await npc.RespondAsync("Hello!");