Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1,674 changes: 862 additions & 812 deletions AGENTS.mdx

Large diffs are not rendered by default.

3 changes: 3 additions & 0 deletions api-reference/endpoint/add-memory.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,11 @@
title: "Add Memory"
description: "Ingest user memories – preferences, conversation history, or inline text."
openapi: "POST /memories/add_memory"
noindex: true
---

<Warning>This page is deprecated: it documents the knowledge and memory API, which unified databases replace. See [Ingest context](/essentials/v2/ingest) and [Query](/essentials/v2/query).</Warning>

## When to use it

Use this endpoint to store user-specific context that personalizes recall:
Expand Down
3 changes: 3 additions & 0 deletions api-reference/endpoint/boolean-recall.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,11 @@
title: "Boolean Recall"
description: "Deterministic full-text search – exact term matching, no embeddings."
openapi: "POST /recall/boolean_recall"
noindex: true
---

<Warning>This page is deprecated: it documents the knowledge and memory API, which unified databases replace. See [Ingest context](/essentials/v2/ingest) and [Query](/essentials/v2/query).</Warning>

## When to use it

`/recall/boolean_recall` runs a BM25-style full-text search. It's the right tool when:
Expand Down
3 changes: 3 additions & 0 deletions api-reference/endpoint/create-tenant.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,11 @@
title: "Create Tenant"
description: "Create an isolated workspace for your data."
openapi: "POST /tenants/create"
noindex: true
---

<Warning>This page is deprecated: it documents the knowledge and memory API, which unified databases replace. See [Ingest context](/essentials/v2/ingest) and [Query](/essentials/v2/query).</Warning>

## When to use it

Creating a new tenant is the first step before any ingestion or recall. A tenant is a fully isolated workspace – no tenant can read another tenant's data.
Expand Down
3 changes: 3 additions & 0 deletions api-reference/endpoint/delete-knowledge.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,11 @@
title: "Delete Knowledge"
description: "Permanently delete one or more knowledge sources by ID."
openapi: "POST /knowledge/delete_knowledge"
noindex: true
---

<Warning>This page is deprecated: it documents the knowledge and memory API, which unified databases replace. See [Ingest context](/essentials/v2/ingest) and [Query](/essentials/v2/query).</Warning>

## When to use it

- **Cleanup** – remove outdated documents
Expand Down
3 changes: 3 additions & 0 deletions api-reference/endpoint/delete-memory.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,11 @@
title: "Delete Memory"
description: "Permanently delete a single memory by its ID."
openapi: "DELETE /memories/delete_memory"
noindex: true
---

<Warning>This page is deprecated: it documents the knowledge and memory API, which unified databases replace. See [Ingest context](/essentials/v2/ingest) and [Query](/essentials/v2/query).</Warning>

## When to use it

- **Right-to-deletion** – remove a specific user's memory upon request
Expand Down
3 changes: 3 additions & 0 deletions api-reference/endpoint/delete-tenant.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,11 @@
title: "Delete Tenant"
description: "Permanently delete a tenant and all its data."
openapi: "DELETE /tenants/delete"
noindex: true
---

<Warning>This page is deprecated: it documents the knowledge and memory API, which unified databases replace. See [Ingest context](/essentials/v2/ingest) and [Query](/essentials/v2/query).</Warning>

## When to use it

- **Offboarding** – a customer has churned and you need to remove their data
Expand Down
3 changes: 3 additions & 0 deletions api-reference/endpoint/fetch-content.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,11 @@
title: "Fetch Content"
description: "Retrieve the original content of an ingested source."
openapi: "POST /fetch/content"
noindex: true
---

<Warning>This page is deprecated: it documents the knowledge and memory API, which unified databases replace. See [Ingest context](/essentials/v2/ingest) and [Query](/essentials/v2/query).</Warning>

## When to use it

- **Download original files** – PDFs, DOCX, etc. that you uploaded
Expand Down
3 changes: 3 additions & 0 deletions api-reference/endpoint/full-recall.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,11 @@
title: "Full Recall"
description: "Hybrid semantic + graph + metadata recall over knowledge sources."
openapi: "POST /recall/full_recall"
noindex: true
---

<Warning>This page is deprecated: it documents the knowledge and memory API, which unified databases replace. See [Ingest context](/essentials/v2/ingest) and [Query](/essentials/v2/query).</Warning>

## When to use it

`/recall/full_recall` is the primary endpoint for retrieving knowledge (documents, app sources). It runs a multi-stage pipeline that combines:
Expand Down
3 changes: 3 additions & 0 deletions api-reference/endpoint/graph-relations.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,11 @@
title: "Graph Relations By Source ID"
description: "Retrieve all entity relationships extracted from a single source."
openapi: "GET /list/graph_relations_by_id"
noindex: true
---

<Warning>This page is deprecated: it documents the knowledge and memory API, which unified databases replace. See [Ingest context](/essentials/v2/ingest) and [Query](/essentials/v2/query).</Warning>

## When to use it

- **Debugging graph construction** – verify HydraDB extracted the relationships you expected
Expand Down
3 changes: 3 additions & 0 deletions api-reference/endpoint/infra-status.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,11 @@
title: "Check Infra Status"
description: "Check whether a tenant's infrastructure is fully provisioned."
openapi: "GET /tenants/infra/status"
noindex: true
---

<Warning>This page is deprecated: it documents the knowledge and memory API, which unified databases replace. See [Ingest context](/essentials/v2/ingest) and [Query](/essentials/v2/query).</Warning>

## When to use it

- **After tenant creation** – poll until provisioning completes
Expand Down
3 changes: 3 additions & 0 deletions api-reference/endpoint/ingestion-overview.mdx
Original file line number Diff line number Diff line change
@@ -1,8 +1,11 @@
---
title: "Ingestion - Overview"
description: "Quick reference for ingestion endpoints, their lifecycle, and when to use which."
noindex: true
---

<Warning>This page is deprecated: it documents the knowledge and memory API, which unified databases replace. See [Ingest context](/essentials/v2/ingest) and [Query](/essentials/v2/query).</Warning>

## Lifecycle

```mermaid
Expand Down
3 changes: 3 additions & 0 deletions api-reference/endpoint/list-data.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,11 @@
title: "List Data"
description: "Paginated listing of stored knowledge or memories with optional filters."
openapi: "POST /list/data"
noindex: true
---

<Warning>This page is deprecated: it documents the knowledge and memory API, which unified databases replace. See [Ingest context](/essentials/v2/ingest) and [Query](/essentials/v2/query).</Warning>

## When to use it

- **Admin dashboards** – browse what's been ingested into a tenant
Expand Down
3 changes: 3 additions & 0 deletions api-reference/endpoint/list-overview.mdx
Original file line number Diff line number Diff line change
@@ -1,8 +1,11 @@
---
title: "List – Overview"
description: "Browse stored knowledge and memories, and inspect their graph relationships."
noindex: true
---

<Warning>This page is deprecated: it documents the knowledge and memory API, which unified databases replace. See [Ingest context](/essentials/v2/ingest) and [Query](/essentials/v2/query).</Warning>

## Endpoint reference

| Endpoint | Method | Purpose |
Expand Down
3 changes: 3 additions & 0 deletions api-reference/endpoint/list-sub-tenant-ids.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,11 @@
title: "List Sub-Tenant IDs"
description: "List all sub-tenants that have indexed data under a tenant."
openapi: "GET /tenants/sub_tenant_ids"
noindex: true
---

<Warning>This page is deprecated: it documents the knowledge and memory API, which unified databases replace. See [Ingest context](/essentials/v2/ingest) and [Query](/essentials/v2/query).</Warning>

## When to use it

- **Audit** – confirm which sub-tenants exist for compliance or usage reporting
Expand Down
3 changes: 3 additions & 0 deletions api-reference/endpoint/list-tenant-ids.mdx
Original file line number Diff line number Diff line change
@@ -1,8 +1,11 @@
---
title: "List Tenant IDs"
description: "List all tenants registered for your organization."
noindex: true
---

<Warning>This page is deprecated: it documents the knowledge and memory API, which unified databases replace. See [Ingest context](/essentials/v2/ingest) and [Query](/essentials/v2/query).</Warning>

## When to use it

- **Org-level admin dashboards** – show all tenants belonging to an organization
Expand Down
3 changes: 3 additions & 0 deletions api-reference/endpoint/memories-overview.mdx
Original file line number Diff line number Diff line change
@@ -1,8 +1,11 @@
---
title: "Memories – Overview"
description: "Quick reference for all Memories endpoints, their lifecycle, and when to call each."
noindex: true
---

<Warning>This page is deprecated: it documents the knowledge and memory API, which unified databases replace. See [Ingest context](/essentials/v2/ingest) and [Query](/essentials/v2/query).</Warning>

## Lifecycle

```mermaid
Expand Down
3 changes: 3 additions & 0 deletions api-reference/endpoint/monitor-tenant.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,11 @@
title: "Monitor Tenant"
description: "Get usage statistics for a tenant – object counts."
openapi: "GET /tenants/monitor"
noindex: true
---

<Warning>This page is deprecated: it documents the knowledge and memory API, which unified databases replace. See [Ingest context](/essentials/v2/ingest) and [Query](/essentials/v2/query).</Warning>

## When to use it

- **Verify ingestion** – confirm data landed after upload (expect `row_count` to grow)
Expand Down
3 changes: 3 additions & 0 deletions api-reference/endpoint/recall-overview.mdx
Original file line number Diff line number Diff line change
@@ -1,8 +1,11 @@
---
title: "Recall – Overview"
description: "Quick reference for all Recall endpoints, their differences, and when to call each."
noindex: true
---

<Warning>This page is deprecated: it documents the knowledge and memory API, which unified databases replace. See [Ingest context](/essentials/v2/ingest) and [Query](/essentials/v2/query).</Warning>

## Which recall endpoint should I use?

```mermaid
Expand Down
3 changes: 3 additions & 0 deletions api-reference/endpoint/recall-preferences.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,11 @@
title: "Recall Preferences"
description: "Hybrid recall over user memories – preferences, conversation history, inline notes."
openapi: "POST /recall/recall_preferences"
noindex: true
---

<Warning>This page is deprecated: it documents the knowledge and memory API, which unified databases replace. See [Ingest context](/essentials/v2/ingest) and [Query](/essentials/v2/query).</Warning>

## When to use it

`/recall/recall_preferences` retrieves user-specific context that was ingested via [`POST /memories/add_memory`](/api-reference/endpoint/add-memory). Use it when your agent needs to:
Expand Down
3 changes: 3 additions & 0 deletions api-reference/endpoint/tenants-overview.mdx
Original file line number Diff line number Diff line change
@@ -1,8 +1,11 @@
---
title: "Tenants – Overview"
description: "Quick reference for all Tenants endpoints, their lifecycle, and when to call each."
noindex: true
---

<Warning>This page is deprecated: it documents the knowledge and memory API, which unified databases replace. See [Ingest context](/essentials/v2/ingest) and [Query](/essentials/v2/query).</Warning>

## Lifecycle

```mermaid
Expand Down
3 changes: 3 additions & 0 deletions api-reference/endpoint/upload-knowledge.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,11 @@
title: "Upload Knowledge"
description: "Ingest documents (files) and/or app-generated content (app knowledge) into a tenant."
openapi: "POST /ingestion/upload_knowledge"
noindex: true
---

<Warning>This page is deprecated: it documents the knowledge and memory API, which unified databases replace. See [Ingest context](/essentials/v2/ingest) and [Query](/essentials/v2/query).</Warning>

## When to use it

Use this endpoint to add knowledge that your agents will recall later:
Expand Down
3 changes: 3 additions & 0 deletions api-reference/endpoint/verify-processing.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,11 @@
title: "Verify Processing"
description: "Check the processing status of ingested content."
openapi: "POST /ingestion/verify_processing"
noindex: true
---

<Warning>This page is deprecated: it documents the knowledge and memory API, which unified databases replace. See [Ingest context](/essentials/v2/ingest) and [Query](/essentials/v2/query).</Warning>

## When to use it

Both `/ingestion/upload_knowledge` and `/memories/add_memory` are asynchronous. After ingesting, use this endpoint to check whether content is fully indexed and ready to be recalled.
Expand Down
3 changes: 3 additions & 0 deletions api-reference/error-responses.mdx
Original file line number Diff line number Diff line change
@@ -1,8 +1,11 @@
---
title: "Error Responses"
description: "HTTP error codes, response shapes, and handling patterns across all HydraDB endpoints."
noindex: true
---

<Warning>This page is deprecated: it documents the knowledge and memory API, which unified databases replace. See [Ingest context](/essentials/v2/ingest) and [Query](/essentials/v2/query).</Warning>

{/*
PRO-1276 — DEFERRED, NOT FIXED.

Expand Down
3 changes: 3 additions & 0 deletions api-reference/index.mdx
Original file line number Diff line number Diff line change
@@ -1,8 +1,11 @@
---
title: "API Reference"
description: "Complete reference for every HydraDB endpoint, organized by group."
noindex: true
---

<Warning>This page is deprecated: it documents the knowledge and memory API, which unified databases replace. See [Ingest context](/essentials/v2/ingest) and [Query](/essentials/v2/query).</Warning>

## Quick links

- **New to HydraDB?** Start with the [Quickstart](/get-started/quickstart)
Expand Down
3 changes: 3 additions & 0 deletions api-reference/sdks.mdx
Original file line number Diff line number Diff line change
@@ -1,8 +1,11 @@
---
title: "SDKs – Node and Python"
description: "Official TypeScript/Node.js and Python SDKs for the HydraDB platform."
noindex: true
---

<Warning>This page is deprecated: it documents the knowledge and memory API, which unified databases replace. See [Ingest context](/essentials/v2/ingest) and [Query](/essentials/v2/query).</Warning>

{/*
PRO-1276 — DEFERRED, NOT FIXED.

Expand Down
2 changes: 1 addition & 1 deletion api-reference/v2/endpoint/connectors-overview.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ title: "Connectors - Overview"
description: "Quick reference for all connector endpoints, their lifecycle, and when to call each."
---

Connectors continuously sync external app data (Slack, GitHub, Linear, Notion, Gmail) into your knowledge store without manual ingestion.
Connectors continuously sync external app data (Slack, GitHub, Linear, Notion, Gmail) into your database without manual ingestion.

## Endpoint references

Expand Down
23 changes: 20 additions & 3 deletions api-reference/v2/endpoint/create-tenant.mdx
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
---
title: "Create Database"
description: "Creates a space for storing context. "
openapi: "api-reference/v2/openapi.json POST /databases"
---

import { Field } from "/snippets/field.jsx";
Expand Down Expand Up @@ -86,11 +85,29 @@ curl -X POST 'https://api.hydradb.com/databases' \
| Name | Description |
| --- | --- |
| <Field name="database" type="string" required /> | Account-scoped database identifier. Use a stable, case-sensitive ID up to 25 characters; prefer lowercase letters, numbers, and underscores for portability. Formerly `tenant_id`; the `tenant_id` alias is still accepted (deprecated). |
| <Field name="database_metadata_schema" type="array" /> | Defines database-level metadata fields. See the [Scoping using metadata](/essentials/v2/attributes#step-1a-declare-the-schema-at-database-creation) guide for detailed schema parameters. Formerly `tenant_metadata_schema`; the `tenant_metadata_schema` alias is still accepted (deprecated). (default=`null`) |
| <Field name="database_metadata_schema" type="array" /> | Defines database-level metadata fields, the declared attributes you can filter on. Each entry is a schema field (below). See [Declare the schema](/essentials/v2/attributes#2-declare-the-schema) for detailed schema parameters. Formerly `tenant_metadata_schema`; the `tenant_metadata_schema` alias is still accepted (deprecated). (default=`null`) |

### Schema field

| Name | Description |
| --- | --- |
| <Field name="name" type="string" required /> | Field name. Must start with a letter, contain only letters, numbers and underscores, and not be a reserved system name. Immutable after creation. |
| <Field name="data_type" type="string" /> | `VARCHAR`, `BOOL`, `INT8`, `INT16`, `INT32`, `INT64`, `FLOAT`, `DOUBLE`, `JSON`, or the friendly aliases `string`, `integer`, `float`, `boolean`, `object`. `ARRAY` is rejected with `400`; for a multi-value field declare `VARCHAR` and store the values comma-joined. (default=`"VARCHAR"`) |
| <Field name="max_length" type="integer" /> | Maximum length for a `VARCHAR` field, up to `65535`. (default=`1024`) |
| <Field name="enable_match" type="boolean" /> | Enables exact-match filtering on this field. (default=`false`) |
| <Field name="enable_dense_embedding" type="boolean" /> | Adds dense semantic search over a `VARCHAR` field. (default=`false`) |
| <Field name="enable_sparse_embedding" type="boolean" /> | Adds sparse (BM25) search over a `VARCHAR` field. (default=`false`) |

## Successful response

Always check if a database is ready before using it. Use [Database Status](/api-reference/v2/endpoint/tenant-status) to check.
Creation is asynchronous: the call returns as soon as provisioning starts. Always check if a database is ready before using it. Use [Database Status](/api-reference/v2/endpoint/tenant-status) to check.

| Name | Description |
| --- | --- |
| <Field name="status" type="string" /> | `accepted`: provisioning has started in the background. |
| <Field name="database" type="string" /> | The database being created. |
| <Field name="message" type="string" /> | Human-readable result message. |
| <Field name="tenant_id" type="string" /> | Deprecated alias for `database`, carrying the same value. |

<ResponseExample>

Expand Down
6 changes: 3 additions & 3 deletions api-reference/v2/endpoint/delete-collection.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ openapi: "api-reference/v2/openapi.json DELETE /databases/collections"

import { Field } from "/snippets/field.jsx";

This action is irreversible. Deleting a collection removes all knowledge, memories, embeddings, and graph data stored under that collection. The parent database and its other collections are not affected. There is no soft-delete and no recovery window.
This action is irreversible. Deleting a collection removes all context items, embeddings, and graph data stored under that collection. The parent database and its other collections are not affected. There is no soft-delete and no recovery window.

<RequestExample>
```python Python SDK
Expand Down Expand Up @@ -85,7 +85,7 @@ You do not need one to reuse the name safely. Ingestion creates a missing collec
## Behavior notes

<Warning>
**Irreversible action.** Ingested documents, memories, embeddings, graph nodes, and storage objects for this collection are permanently removed. Other collections in the same database are not touched. There is no recovery window.
**Irreversible action.** Ingested context items, embeddings, graph nodes, and storage objects for this collection are permanently removed. Other collections in the same database are not touched. There is no recovery window.
</Warning>

- **Async cleanup:** The endpoint returns immediately after accepting the request. Cleanup of vector stores, graphs, and storage objects runs in the background.
Expand All @@ -103,7 +103,7 @@ Common codes: `400 VALIDATION_ERROR`, `404 DATABASE_NOT_FOUND`, `401 UNAUTHORIZE
**Related Resources**

- **Before this:** [List Collections](/api-reference/v2/endpoint/list-sub-tenants) - find the collection ID
- **Alternative:** [Delete Context](/api-reference/v2/endpoint/delete-source) - remove specific knowledge or memories without deleting the collection
- **Alternative:** [Delete Context](/api-reference/v2/endpoint/delete-source): remove specific context items without deleting the collection
- **Larger scope:** [Delete Database](/api-reference/v2/endpoint/delete-tenant) - remove the entire database
- **Read more:** [Concepts → Multi tenancy](/essentials/v2/databases-and-collections)
</Tip>
2 changes: 1 addition & 1 deletion api-reference/v2/endpoint/delete-connector-resource.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ description: "Remove a resource from a connector and stop syncing it."
openapi: "api-reference/v2/openapi.json DELETE /connectors/{id}/resources/{resource_id}"
---

Removes a configured resource and stops syncing it. Objects already ingested into the knowledge store are not removed.
Removes a configured resource and stops syncing it. Objects already ingested into your database are not removed.

<RequestExample>

Expand Down
2 changes: 1 addition & 1 deletion api-reference/v2/endpoint/delete-connector.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ description: "Permanently remove a connector and stop all associated syncs."
openapi: "api-reference/v2/openapi.json DELETE /connectors/{id}"
---

Deletes the connector and all its configured resources. Synced objects already ingested into the knowledge store are not removed.
Deletes the connector and all its configured resources. Synced objects already ingested into your database are not removed.

<RequestExample>

Expand Down
Loading
Loading