API documentation
Task-oriented guides for the KleioBase API.
Getting started
Create an API key, list your workspaces, and read your first people in a few minutes.
Authentication
How API keys work, the difference between read and read-write keys, and what happens when your plan changes.
Workspaces
Every resource lives under a workspace id. How to find yours, create, rename, archive and restore workspaces, and what archived workspaces allow.
Pagination
How list endpoints page with limit and cursor.
Errors
The error format and every error code the API returns.
Idempotency
Make write requests safe to retry with the Idempotency-Key header.
MCP server
Connect Claude, ChatGPT or any MCP client to KleioBase. Sign in with OAuth or use an API key, then read, upload, process and confirm records through tools.
Uploads and processing
Upload a record, start AI extraction, poll for the result, review it and confirm. Includes credits and what happens when processing stalls.
Rate limits
How many requests and uploads your plan allows per minute, and what to do on a 429.
Versioning
What can change within v1, what counts as a breaking change, and how long old versions are supported.
People, families and merges
Read a person's close family and tree, add or remove relatives, merge and unmerge duplicates, and resolve conflicts.
Trash and bulk actions
Move people and records to the Trash one at a time or in bulk, restore them, and delete them for good.
Folders and tags
Organise people and records with folders and tags, and filter lists by them.
Places, search, notifications and health
Read places with their coordinates, search a workspace, read and clear notifications, and get the tree health score.
Research Companion conversations
Read past Research Companion conversations with their messages and attached files, rename them or delete them.
GEDCOM import and export
Import a GEDCOM file into a workspace, and export a workspace as a GEDCOM file or GEDZIP archive.
Background jobs
Record processing, GEDCOM import and GEDCOM export run in the background. How to start them, poll them and act on the result.
API reference
Every endpoint, with its parameters, request bodies and responses.
API changelog
Dated changes to the API.