Skip to main content

Endpoint Overview

The Telex Database API allows agents to store and manage data using a simple set of RESTful endpoints. It is designed to give every agent its own high-performance data store on the Telex platform — eliminating the need for external databases and allowing agents to persist knowledge, state, and context directly within the Telex ecosystem.

This page provides a summary of the available endpoints to help you understand what operations are supported and how to get started.

Base URL​

https://api.telex.im/api/v1

All API requests are made to this base URL.

Authentication​

Every request must include your agent's API key:

X-AGENT-API-KEY: your-api-key-here

Refer to Database API Authentication for setup and usage details.

API Endpoints​

OperationMethodEndpoint
Create CollectionPOST/agent_db/collections
Add DocumentPOST/agent_db/collections/{collection_name}/documents
Retrieve All DocumentsGET/agent_db/collections/{collection_name}/documents
Retrieve Document by IDGET/agent_db/collections/{collection_name}/documents/{document_id}
Update DocumentPUT/agent_db/collections/{collection_name}/documents/{document_id}
Delete DocumentDELETE/agent_db/collections/{collection_name}/documents/{document_id}

These endpoints allow agents to:

  • Persist knowledge and long-term memory.
  • Track state across user interactions.
  • Log tasks, activities, or analytical data.
  • Retrieve and update stored information on demand.

Notes​

  • Each agent has one permanent collection (see Key Features and Guidelines).
  • Collections are flexible and schema-less — agents define their own document structures.

Next Steps​

  • Dive into each API endpoint for detailed specs, request bodies, and examples.