API reference
Every endpoint, grouped by resource and generated from the same OpenAPI document the API serves. Base URL: https://kleiobase.com/api/v1. Send Authorization: Bearer kb_live_YOUR_KEY on every request.
Meta
The API's own description: this OpenAPI document, readable without a key.
Workspaces
List, create, rename, archive and restore your workspaces. Every other resource lives under one.
People
Read, create, edit, merge, unmerge and delete the people in a workspace; read a person's timeline, close family, tree and expected records; add and remove relatives.
- getList people
- postCreate a person
- getGet a person
- patchUpdate a person
- deleteMove a person to Trash
- postMove many people to Trash
- getGet a person's timeline
- postMerge two people
- getGet a person's parents, partners and children
- getGet tree data from a person
- getList records a person should have
- postAdd a relative
- deleteRemove a relationship
- postUndo a merge
- patchDismiss an expected record
Families
Read and create families, edit a couple's status or events, and add or remove partners and children.
Records
Upload a record, run AI extraction, review and confirm the result, link or unlink people, and move records to the Trash.
- getList records
- postUpload a record
- getGet a record
- patchEdit a record's title or type
- deleteMove a record to Trash
- postMove many records to Trash
- getGet a signed image URL
- postStart AI extraction
- getGet the extraction
- patchReplace the extraction
- postConfirm a reviewed record
- postLink a person to a record
- deleteUnlink a person from a record
Trash
Trashed people and records: list, restore or permanently delete them.
Places
Places derived from a workspace's people and confirmed records: list them, read one with its people and events, and get place-name suggestions.
Events
Dated life events derived from people's facts, filterable by person and year.
Conflicts
Conflicting facts in a workspace, computed on demand: resolve a person's competing birth families, or fold spelling variants of a fact into one value.
Matches
Suggested duplicate people: review them, then accept (merge) or reject. A group of duplicates can be merged in one request.
Findings
Research findings the app has detected, such as gaps: read, resolve or dismiss.
Folders
Folders for people and records: list, create, rename, move and delete them, and move items into one.
Tags
Tags for people and records: list, create, rename, recolour and delete them, and add or remove them on many items at once.
Search
Search a workspace's people, records and places, as the app's search box.
Notifications
The notifications the app shows in a workspace: list them, count the unread ones, and mark them read.
Health
The tree health score of a workspace, its pillars and suggested quick wins.
Conversations
Past Research Companion conversations: read them with their messages and attached files, rename or delete them. Nothing can be sent through the API.
GEDCOM
Import a GEDCOM file into a workspace, and export a workspace as GEDCOM. Both run in the background: start, then poll the job.