response = client.databases.status(database="my_first_database")
if response.data.infra.ready_for_ingestion:
print("Database is ready.")
const response = await client.databases.status({
database: "my_first_database",
});
if (response.data?.infra?.readyForIngestion) {
console.log("Database is ready.");
}
curl -X GET 'https://api.hydradb.com/databases/status?database=my_first_database' \
-H "Authorization: Bearer <your_api_key>" \
-H "API-Version: 2"
{
"success": true,
"data": {
"database": "my_first_database",
"org_id": "org_abc123",
"infra": {
"scheduler_status": true,
"graph_status": true,
"vectorstore_status": {
"knowledge": true,
"memories": true
},
"ready_for_ingestion": true
},
"message": "Deployed infrastructure status"
},
"error": null,
"meta": {
"request_id": "9d13aef4-02f4-4e73-8c62-4c2601d04f9d",
"latency_ms": 12.3
}
}
{
"success": false,
"data": null,
"error": {
"code": "DATABASE_NOT_FOUND",
"message": "database my_first_database does not exist"
},
"meta": {
"request_id": "9d13aef4-02f4-4e73-8c62-4c2601d04f9d",
"latency_ms": 4.8
}
}
Databases
Database Status
Check the readiness of a database’s infrastructure.
GET
/
databases
/
status
response = client.databases.status(database="my_first_database")
if response.data.infra.ready_for_ingestion:
print("Database is ready.")
const response = await client.databases.status({
database: "my_first_database",
});
if (response.data?.infra?.readyForIngestion) {
console.log("Database is ready.");
}
curl -X GET 'https://api.hydradb.com/databases/status?database=my_first_database' \
-H "Authorization: Bearer <your_api_key>" \
-H "API-Version: 2"
{
"success": true,
"data": {
"database": "my_first_database",
"org_id": "org_abc123",
"infra": {
"scheduler_status": true,
"graph_status": true,
"vectorstore_status": {
"knowledge": true,
"memories": true
},
"ready_for_ingestion": true
},
"message": "Deployed infrastructure status"
},
"error": null,
"meta": {
"request_id": "9d13aef4-02f4-4e73-8c62-4c2601d04f9d",
"latency_ms": 12.3
}
}
{
"success": false,
"data": null,
"error": {
"code": "DATABASE_NOT_FOUND",
"message": "database my_first_database does not exist"
},
"meta": {
"request_id": "9d13aef4-02f4-4e73-8c62-4c2601d04f9d",
"latency_ms": 4.8
}
}
Reports whether a database has finished provisioning. Database creation is asynchronous, so poll this endpoint until
Readiness signals:
infra.ready_for_ingestion is true before you ingest or query.
response = client.databases.status(database="my_first_database")
if response.data.infra.ready_for_ingestion:
print("Database is ready.")
const response = await client.databases.status({
database: "my_first_database",
});
if (response.data?.infra?.readyForIngestion) {
console.log("Database is ready.");
}
curl -X GET 'https://api.hydradb.com/databases/status?database=my_first_database' \
-H "Authorization: Bearer <your_api_key>" \
-H "API-Version: 2"
{
"success": true,
"data": {
"database": "my_first_database",
"org_id": "org_abc123",
"infra": {
"scheduler_status": true,
"graph_status": true,
"vectorstore_status": {
"knowledge": true,
"memories": true
},
"ready_for_ingestion": true
},
"message": "Deployed infrastructure status"
},
"error": null,
"meta": {
"request_id": "9d13aef4-02f4-4e73-8c62-4c2601d04f9d",
"latency_ms": 12.3
}
}
{
"success": false,
"data": null,
"error": {
"code": "DATABASE_NOT_FOUND",
"message": "database my_first_database does not exist"
},
"meta": {
"request_id": "9d13aef4-02f4-4e73-8c62-4c2601d04f9d",
"latency_ms": 4.8
}
}
infra.ready_for_ingestion is true only when all four underlying signals are true. For a single check, read that field.
infra.scheduler_status: lifecycle provisioning has finished. It isfalsewhile the database is still being created, even if some collections already exist.infra.graph_status: the graph layer is ready.infra.vectorstore_status.knowledge: the knowledge store is ready.infra.vectorstore_status.memories: the memory store is ready.
database does not exist, the call returns 404 DATABASE_NOT_FOUND. Confirm that the create call succeeded before you poll.
Querying too early: A POST /query sent before ready_for_ingestion is true returns 422 TENANT_INFRA_NOT_READY.
Related resources
- Before this: Create Database: starts provisioning
- After this: Ingest Context: ingest once the database is ready
Authorizations
Send your API key as Authorization: Bearer <your_api_key>.
Query Parameters
Database identifier
Example:
"acme_corp"
Response
OK
Show child attributes
Show child attributes
Example:
{
"database": "acme_corp",
"infra": {
"graph_status": true,
"ready_for_ingestion": true,
"scheduler_status": true,
"vectorstore_status": { "knowledge": true, "memories": true }
},
"message": "Success",
"org_id": "org_1a2b3c",
"tenant_id": "tenant_1234"
}
Error details on failure, or null on success.
Show child attributes
Show child attributes
Example:
null
Show child attributes
Show child attributes
Example:
{
"collection": "team_docs",
"database": "acme_corp",
"latency_ms": 12.3,
"request_id": "9d13aef4-02f4-4e73-8c62-4c2601d04f9d",
"source_type": "file",
"sub_tenant_id": "sub_tenant_4567",
"tenant_id": "tenant_1234",
"warnings": [
{
"code": "acl_ignored_by_connector_enforcement",
"message": "This connector enforces ACL, so the request's acl was ignored."
}
]
}
Whether the request succeeded.
Example:
true
Was this page helpful?