Skip to main content
GET
Database creation is asynchronous, check if your database is ready before executing ingestion or any queries. The response includes infra.ready_for_ingestion, a convenience flag derived from the vectorstore fields below. For a single check, read that field. The underlying signals are:
  • infra.ready_for_ingestion === true (derived - true once both vectorstores are provisioned)
  • infra.scheduler_status === true (the background indexing scheduler)
  • infra.graph_status === true (the graph layer)
  • infra.vectorstore_status.knowledge === true
  • infra.vectorstore_status.memories === true
Stale database IDs: If database does not exist, the call returns 404 DATABASE_NOT_FOUND. Always verify that the database was created successfully before polling.
Common mistake: row_count from Database Stats counts individual chunks, not documents. For distinct source or memory counts, use List Documents and read pagination.total from the response.
Related Resources

Authorizations

Authorization
string
header
required

API key sent as a Bearer token: "Bearer prefix.secret"

Query Parameters

database
string
required

Database identifier

Example:

"acme_corp"

Response

OK

data
object
Example:
error
object

Error message, empty string on success.

Example:
meta
object
Example:
success
boolean

Whether the request succeeded.

Example:

true