Skip to main content
Use this reference to look up request fields and response formats. New to HydraDB? The Quickstart gets you to a first query in five minutes, and Core Concepts explains databases, context, and queries. AI agents can start from the Agent Integration Guide and the v2 OpenAPI spec.

The four calls

Create a database, ingest context, wait for indexing, then query it.
  1. Create Database: POST /databases. Isolates context for a customer, environment, or product. Creation runs in the background, so poll Database Status until ready_for_ingestion is true.
  2. Ingest Context: POST /context/ingest. Files, app sources, or memories, in one multipart request.
  3. Ingestion Status: GET /context/status. Poll the returned ids until indexing_status is completed, or register a webhook instead.
  4. Query: POST /query. Retrieve the context your model needs, from knowledge, memories, or both.

Every endpoint

The Python SDK method is listed for each endpoint; the TypeScript SDK uses the same names in camelCase, such as deleteCollection. Every endpoint page shows Python, TypeScript, and cURL.

Databases

Create and manage the databases that store your context. Overview.

Context

Ingest, check, list, inspect, edit, and delete what you store. Overview.

Query

Retrieve context, and tell HydraDB how a query performed. Overview.

Connectors

Sync data from 70 apps without writing ingestion code. Overview.

Webhooks

Get notified when indexing finishes instead of polling. Overview.

Conventions

Authentication: Every endpoint requires Authorization: Bearer <your_api_key>. Get your key at dashboard.hydradb.com. The SDKs set it, and the version header, for you. Versioning: Send API-Version: 2 with every request.
Response envelope: Core v2 endpoints (/databases, /context/*, /query, /feedback, and /webhooks/indexing*) return a consistent envelope. Endpoint pages show the full envelope; the resource-specific payload lives under data. Connector endpoints (/connectors*) and PATCH /databases/{database}/metadata-schema are the exception: they return their success body without the envelope.
Errors use the same envelope on every endpoint, with success: false and an error object containing code and message. Most errors have data: null. Some Delete Context errors include per-ID results under data. Legacy requests can include deprecation notices. See Migrating from tenant fields.
  • Database scoping: Use database to select a database and collection to scope context within it. Omitting collection uses the default collection.
  • Async operations: Database creation, database and collection deletion, and content ingestion are asynchronous. They return immediately after queuing. Use the relevant status endpoint to confirm completion before downstream operations.
  • Pagination: Listing endpoints (/context/list) return pagination fields for browsing large result sets.
  • Parameter casing: The REST API uses snake_case (database, max_results). The TypeScript SDK uses camelCase keys and method names (maxResults, deleteCollection) and ignores request keys it does not recognize, including snake_case ones. The Python SDK uses snake_case throughout. See SDKs.
Status codes: 200 for success and 202 when an async operation is queued. See Error Responses for response shapes, error codes, and retry patterns.

Rate limits

Rate limits apply per API key. Both SDKs retry 429 responses automatically. For raw HTTP, use exponential backoff; see Error Responses. Contact [email protected] for current limit values.

Next steps

Existing v1 endpoints remain available under the v1 API Reference.
  • Build something: Quickstart walks through your first integration in five minutes
  • Understand the model: Core Concepts explains databases, context, and queries
  • Query options: Query guide explains retrieval modes and ranking
  • Install an SDK: Python ยท TypeScript