Overview

HarperHarbor provides APIs for AI applications. Use them to run model conversations, store agent configurations and manage supporting knowledge and media.

An agent configuration contains instructions, example conversations and opening messages. A Lorebook contains background information organized into entries. The conversation API uses these assets with the user’s settings and history to generate replies. Your application remains responsible for any external tools it executes.

For your own account, start with a personal API key. To act for another user, use OAuth authorization. The API reference documents request fields and responses. See MCP integration for the tool and authorization conventions used by AI clients.

QuickstartMake your first API call with a personal key.

AuthenticationChoose permissions and handle authorization.

Agent configurationsManage instructions, Lorebooks and presentation assets.

API referenceLook up endpoints, fields and response formats.

API areas

The API reference is generated from the shared provider contract, so it lists exactly the endpoints this API serves.

Area	Purpose
Identity	Read the authenticated user’s public account identifier, wallet balance and this application’s ledger
Agent configurations	Read an agent configuration (public ones without signing in), list your own, look up canonical tags
Authoring	Create and edit agent configurations, opening messages, display rules, Lorebooks and media; control use by ID independently of community review
Conversations	Start or resume, stream replies, stop generation and read saved history and operation states
Models and settings	Read model rates and save per-agent model and user settings

Conversation requests require chat.play and consume credits from the authenticated user’s account. See Usage and billing. Trial slots, conversation archives and external tool execution are not part of this API.

Names used in the API

Product names and request identifiers serve different purposes. Agent configuration maps to /role and roleId; Lorebook maps to /worldbook and worldbookId. Use the identifiers shown in code examples when making requests.

These names do not expand access. Private data still requires the owner’s permission, and paid conversation operations consume credits. See Authentication and Quotas and pricing.

For an application integration, contact the team with the services you need. Individual users can register directly.