Skip to content
HHarperHarborDocs

Overview

The v1 API for character conversations, authoring, trial cards and models.

HarperHarbor Open API 1.0

Section titled “HarperHarbor Open API 1.0”

Every request carries a Bearer access token obtained through OAuth 2.1 (authorization code + PKCE), a language header, and optionally from: web. Responses never contain internal account identifiers; user identifiers are public numeric IDs. Only the endpoints listed here are part of v1.

Information

  • OpenAPI version: 3.1.0

Operations

Section titled “Operations”
POST
/oauth/register
GET
/oauth/authorize
POST
/oauth/token
GET
/me
POST
/conversation/start
POST
/conversation/stop
POST
/conversation/rewrite
POST
/conversation/rewrite-by-id
GET
/conversation/operations
GET
/conversation/operations/{operationId}
GET
/conversation/replay
GET
/conversation/messages
GET
/conversation/list
POST
/conversation/delete
POST
/conversation/delete-message
POST
/conversation/save-and-start-new
POST
/conversation/backward
GET
/conversation/archives
POST
/conversation/title
POST
/conversation/switch
POST
/conversation/fork
POST
/conversation/suggest-reply
GET
/conversation/directives
GET
/conversation/prompt-diagnostics
GET
/conversation/memory/{conversationId}/atoms
DELETE
/conversation/memory/{conversationId}/atoms/{atomId}
POST
/conversation/ws-ticket
GET
/role/detail
GET
/role/author-asset/serve
GET
/player/preference
POST
/player/preference/save
GET
/player/role-settings
POST
/player/role-settings/save
GET
/player/agent-mode
POST
/player/agent-mode
POST
/player/compact-preference
POST
/role
PATCH
/role/{roleId}
POST
/role/{roleId}/document
PATCH
/role/{roleId}/welcome
POST
/role/{roleId}/visibility
GET
/role/validate
POST
/role/{roleId}/publish
POST
/image/upload
GET
/trial-cards
GET
/trial-cards/{clientKey}
PUT
/trial-cards/{clientKey}
DELETE
/trial-cards/{clientKey}
GET
/worldbook/mine
POST
/worldbook
GET
/worldbook/detail
GET
/worldbook/entry/list
POST
/worldbook/{worldbookId}/document
GET
/worldbook/bindings
GET
/models
GET
/models/uptime-history
GET
/conversation/notepad
POST
/conversation/notepad/save
GET
/notepad/templates
GET
/notepad/template
POST
/notepad/template/save
POST
/notepad/template/delete
POST
/notepad/template/share
POST
/notepad/template/share/revoke
GET
/share/preview
POST
/share/import

Authentication

Section titled “Authentication”

oauth

Section titled “oauth”

Authorization code with PKCE (S256). Send resource=https://api.harperharbor.com/open/v1 on both the authorize and token requests.

Security scheme type: oauth2

Flow type: authorizationCode

Authorization URL: https://api.harperharbor.com/oauth/authorize

Token URL: https://api.harperharbor.com/oauth/token

Refresh URL: https://api.harperharbor.com/oauth/token

Scopes:

  • mcp:card-writer - Play and author cards on behalf of the signed-in user