List Databases

List the databases your API key can see, including any that failed to provision.

GET /databases

Python SDK

response = client.databases.list()

Success

{
  "success": true,
  "data": {
    "databases": ["acme_corp", "my_first_database"],
    "failed_databases": [],
    "message": "Successfully retrieved database IDs"
  },
  "error": null,
  "meta": {
    "request_id": "9d13aef4-02f4-4e73-8c62-4c2601d04f9d",
    "latency_ms": 12.3
  }
}

The response separates active or provisioning databases (in data.databases) from databases whose provisioning failed (in data.failed_databases). Use Database Status to confirm readiness before ingestion.

Python SDK

response = client.databases.list()

Success

{
  "success": true,
  "data": {
    "databases": ["acme_corp", "my_first_database"],
    "failed_databases": [],
    "message": "Successfully retrieved database IDs"
  },
  "error": null,
  "meta": {
    "request_id": "9d13aef4-02f4-4e73-8c62-4c2601d04f9d",
    "latency_ms": 12.3
  }
}

Retrying a failed database

A database in data.failed_databases carries diagnostic entries (see the Provisioning issue tab). Fix the reported issue, re-create it with POST /databases, and poll status again before ingesting.

Related Resources

• Create: Create Database
• Inspect: Database Status
• Inspect: Database Stats
• Delete: Delete Database
• Read more: Multi-tenancy

Authorizations

Authorization · string · header · required

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

Response

200

application/json

OK

data · object

Show child attributes

Example:

{
  "databases": ["acme_corp", "research_kb"],
  "failed_databases": [
    {
      "database": "acme_corp",
      "error": "",
      "tenant_id": "tenant_1234"
    }
  ],
  "failed_tenant_ids": [
    {
      "database": "acme_corp",
      "error": "",
      "tenant_id": "tenant_1234"
    }
  ],
  "message": "Success",
  "tenant_ids": ["tenant_1234", "tenant_5678"]
}

error · object | null

Null on success; an object with code and message on failure.

Show child attributes

Example:

null

meta · object

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": "team_docs",
  "tenant_id": "acme_corp"
}

success · boolean

Whether the request succeeded.

Example:

true