Skip to content
HHarperHarborDocs

Entries of a worldbook

GET
/worldbook/entry/list
curl --request GET \
  --url 'https://api.harperharbor.com/open/v1/worldbook/entry/list?worldbookId=example' \
  --header 'Authorization: Bearer <token>'

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Query Parameters

Section titled “Query Parameters”
worldbookId
required
string
category
string

Responses

Section titled “Responses”

200

Section titled “200”

Keyword fields are always arrays.

Media typeapplication/json
object
worldbookId
string
entries
Array<object>
object
entryId
string
name
string
content
string
keywords
Array<string>
secondaryKeywords

AND gate — the entry fires only when a main keyword and one of these both appear.

Array<string>
matchOptions

null for native entries; { caseSensitive, matchWholeWords, selectiveLogic } for tavern-format worldbooks.

object
caseSensitive
boolean
matchWholeWords
boolean
selectiveLogic

0 any · 1 not all · 2 none · 3 all of secondaryKeywords

integer
<= 3
category
string
isEnabled
boolean
isConstant
boolean
priority
integer
sortOrder
integer
lastUpdateTime
string
activationCount
integer
Examplegenerated
{
  "worldbookId": "example",
  "entries": [
    {
      "entryId": "example",
      "name": "example",
      "content": "example",
      "keywords": [
        "example"
      ],
      "secondaryKeywords": [
        "example"
      ],
      "matchOptions": {
        "caseSensitive": true,
        "matchWholeWords": true,
        "selectiveLogic": 1
      },
      "category": "example",
      "isEnabled": true,
      "isConstant": true,
      "priority": 1,
      "sortOrder": 1,
      "lastUpdateTime": "example",
      "activationCount": 1
    }
  ]
}