Skip to content
HarperHarbor
Docs
Search
Ctrl
K
Cancel
Select theme
Dark
Light
Auto
Select language
繁體中文
简体中文
English
日本語
한국어
Menu
Start
Overview
Quickstart
Authentication
Conventions
Guides
Conversation loop
Streaming
Agent configurations and authoring
Testing private configurations
Models
Usage and billing
Model API
Model API
Image and video API
Beta
AI clients
MCP integration
AI client integration
API reference
Overview
OAuth
Overview
Authorization server metadata (RFC 8414)
Protected resource metadata for the Open API (RFC 9728)
Start the authorization-code flow (PKCE S256 required)
Start device sign-in with a one-time code (RFC 8628)
Dynamic client registration (RFC 7591)
Revoke an access or refresh token (RFC 7009)
Exchange a code, refresh token or device code for tokens
Identity
Overview
Who am I
Set my nickname in this app
Points ledger
Daily points summary
Credits balance and activity
Whether the caller may mark featured cards for this app
Referral code, rules and results
Enter a referral code
Public referral and signup reward terms
Roles
Overview
Create an agent configuration
Read an agent configuration presentation
List the caller's own role cards
Read the compatibility preview-page response
Validate an owned role and report limits
Render an opening through the card's display rules
Delete an owned role card
Patch an owned agent configuration
Write many role fields in one request
Allow use of an agent configuration by ID
Change agent configuration access
Set the opening message, alternate openings and prologue options
List the canonical tag vocabulary grouped by dimension
Mark or clear a featured card on behalf of the community
World mode members
World mode members
Read the heat of several role cards at once
Author assets
Overview
Read the author-side display rules of an owned role
Read agent display rules for rendering
Replace the display rules of an owned role
Remove the display rules of an owned role
Lorebooks
Overview
Create a Lorebook
List Lorebooks bound to a role
Get a Lorebook record
List all entries of a Lorebook
List the caller's Lorebooks
Update metadata, add/update/delete entries and bind a Lorebook in one request
Set the priority order of entries
Remove a Lorebook from one of your cards
Delete one of your Lorebooks
Read Lorebook upload limits
Player settings
Overview
Agent mode (multi-pass) switch for a card
Enable/disable agent mode for a card
Per-card player settings
Save per-card player settings
Record a cost warning choice
Conversation
Overview
List messages of a conversation (newest first) or fetch specific messages by id
Open (or resume) the current conversation with a role
Stop the reply currently being generated for a conversation
Issue a one-time ticket for the chat WebSocket
Connect an authenticated conversation stream
Operations
Overview
List chat operation statuses of a conversation
Get one chat operation status
Models
Overview
Model catalog
Media library
Overview
Delete a library item
Add items to a folder
Create a folder
Delete a folder
List folders
Remove items from a folder
Rename a folder
List library items
Upload a media file to the caller's library
Start a browser direct-to-storage upload
Register a file that was PUT to the signed URL
Register an external image reference
Rename or move a file
Campaign pool
Overview
Read the app's campaign pool
Pay a reward from the campaign pool
Look up a campaign payout
Conversations
Read conversation response preferences
Save conversation response preferences
Media
Resolve an author-owned resource path
Select theme
Dark
Light
Auto
Select language
繁體中文
简体中文
English
日本語
한국어
Overview
Models
Section titled “Models”
Available models and their uptime.
Operations
Section titled “Operations”
GET
/open/v1/models
