Getting started

The KleioBase API lets you read and write your own research data from scripts and tools. Everything lives under one base URL:

https://kleiobase.com/api/v1

1. Create an API key

API access is included with the Researcher, Archivist and Professional plans. Open Settings > Developer, choose a name, pick Read or Read and write, and create the key. The full key is shown once, so copy it somewhere safe right away. See Authentication for the details.

2. List your workspaces

Every resource lives inside a workspace, so start there. Replace kb_live_YOUR_KEY with your key:

curl https://kleiobase.com/api/v1/workspaces \
  -H "Authorization: Bearer kb_live_YOUR_KEY"

The response lists the workspaces you own. Copy the id of the one you want to work in.

3. List the people in a workspace

curl "https://kleiobase.com/api/v1/workspaces/WORKSPACE_ID/people?limit=10" \
  -H "Authorization: Bearer kb_live_YOUR_KEY"

You get back { "data": [...], "next_cursor": "..." }. Pass next_cursor as ?cursor= to fetch the next page. See Pagination.

Where to go next

• Authentication covers key types and what a plan change does.
• Errors lists every error code.
• Uploads walks through uploading and processing a record.
• MCP server connects Claude, ChatGPT or another AI assistant to the same API.
• Background jobs explains how to poll processing, GEDCOM import and GEDCOM export.
• The API reference lists every endpoint.
• The raw OpenAPI document describes every endpoint in machine-readable form.

Your key is personal and meant for your own research. Building a product on KleioBase? Contact us.