Skip to Content

Getting Started

API overview

REST endpoints for writing knowledge and memory, recalling memories, and asking engines.

The Docklee REST API gives you everything Dock and Lynk do, over plain HTTP. Use it from any language, or when you'd rather not add a package to your app.

You need an API key to call the API. Create one in API Keys in the Docklee dashboard.

Quick start

Write a memory

Send events to POST /v1/dock/ingest with a memory_space_id.

Recall it

Ask a question with POST /v1/dum/search in the same memory space.

Ask an engine

Get a cited answer from your knowledge with POST /v1/engine/query.

Core operations

API categories

Authentication

Every request needs your API key as a bearer token:

curl https://api.docklee.com/v1/dum/search \
  -H "Authorization: Bearer $DOCKLEE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"memory_space_id": "your-memory-space-id", "query": "How does Maya like to be contacted?"}'
Endpoint groupKey capabilityKey runtime
Dockwrite or bothKnowledge Engines for a container, DUM for a memory_space_id
Memory writeswrite or bothDUM
Memory searchesread or bothDUM
Knowledgeread or bothKnowledge Engines
Contextread or both, and write to save the turnKnowledge Engines, and DUM with a memory_space_id

A request outside the key's capability, runtimes, or scope fails with 403. Every request runs inside the workspace that owns the key, so IDs from another workspace can never be read or written. See API keys.

Next steps

Start with the endpoint every write goes through, then learn how errors and limits work.

On this page