> ## Documentation Index
> Fetch the complete documentation index at: https://docs.hydradb.com/llms.txt
> Use this file to discover all available pages before exploring further.

> ## Agent Instructions
> AGENTS.md is HydraDB's maintained agent guide. Read https://docs.hydradb.com/AGENTS.md once, then use its content. /llms.txt and /llms-full.txt redirect to the same guide; they are not separate documentation indexes. If the guide is already loaded, continue with it instead of fetching either alias or reloading the guide.

# Database Status

> Check the readiness of a database's infrastructure.

Reports whether a database has finished provisioning. Database creation is asynchronous, so poll this endpoint until `infra.ready_for_ingestion` is `true` before you ingest or query.

```python Python SDK theme={"dark"}
response = client.databases.status(database="my_first_database")

if response.data.infra.ready_for_ingestion:
    print("Database is ready.")
```

```typescript TypeScript SDK theme={"dark"}
const response = await client.databases.status({
  database: "my_first_database",
});

if (response.data?.infra?.readyForIngestion) {
  console.log("Database is ready.");
}
```

```bash cURL theme={"dark"}
curl -X GET 'https://api.hydradb.com/databases/status?database=my_first_database' \
  -H "Authorization: Bearer <your_api_key>" \
  -H "API-Version: 2"
```

```json Success theme={"dark"}
{
  "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
  }
}
```

```json Failure theme={"dark"}
{
  "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
  }
}
```

**Readiness signals:** `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 is `false` while 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.

**Stale database IDs:** If `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](https://docs.hydradb.com/api-reference/v2/endpoint/create-database.md): starts provisioning
* **After this:** [Ingest Context](https://docs.hydradb.com/api-reference/v2/endpoint/ingest-context.md): ingest once the database is ready


## OpenAPI

````yaml api-reference/v2/openapi.json GET /databases/status
openapi: 3.1.0
info:
  contact:
    email: support@hydradb.com
    name: HydraDB Support
  description: >-
    The HydraDB API: ingest context, query it, and manage databases, connectors
    and webhooks.
  license:
    name: Proprietary
  title: HydraDB Application API
  version: 0.1.0
servers:
  - description: Production server
    url: https://api.hydradb.com
security: []
externalDocs:
  description: ''
  url: ''
paths:
  /databases/status:
    get:
      tags:
        - database-management
      summary: Get infrastructure status
      description: Check the infrastructure provisioning status for a database
      parameters:
        - description: Database identifier
          in: query
          name: database
          required: true
          schema:
            example: acme_corp
            type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/handler.Envelope-tenants_InfraStatusResponseV2
          description: OK
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/handler.ErrorResponse'
          description: Bad Request
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/handler.ErrorResponse'
          description: Not Found
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/handler.ErrorResponse'
          description: Internal Server Error
      security:
        - BearerAuth: []
components:
  schemas:
    handler.Envelope-tenants_InfraStatusResponseV2:
      properties:
        data:
          $ref: '#/components/schemas/tenants.InfraStatusResponseV2'
          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:
          anyOf:
            - $ref: '#/components/schemas/handler.apiError'
              title: HandlerApiError
            - title: No error
              type: 'null'
          description: Error details on failure, or null on success.
          example: null
        meta:
          $ref: '#/components/schemas/handler.responseMeta'
          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.
        success:
          description: Whether the request succeeded.
          example: true
          type: boolean
      title: HandlerEnvelopeTenantsInfraStatusResponseV2
      type: object
    handler.ErrorResponse:
      properties:
        data:
          description: Always `null` on this error response.
          type: 'null'
        detail:
          $ref: '#/components/schemas/handler.ErrorDetail'
          description: Structured error detail with code, message, and deprecation hints.
          example:
            deprecated: true
            deprecated_field: tenant_id
            deprecated_since: 2.0.1
            error_code: VALIDATION_ERROR
            message: Request validation failed
            preferred_field: database
            retry_after_seconds: 1
            retryable: true
        error:
          $ref: '#/components/schemas/handler.apiError'
          description: Error message, empty string on success.
          example:
            code: DATABASE_NOT_FOUND
            message: Database not found
        meta:
          $ref: '#/components/schemas/handler.ErrorMeta'
          example:
            latency_ms: 12.3
            request_id: 9d13aef4-02f4-4e73-8c62-4c2601d04f9d
        success:
          description: Whether the request succeeded.
          example: false
          type: boolean
      title: HandlerErrorResponse
      type: object
    tenants.InfraStatusResponseV2:
      properties:
        database:
          description: >-
            Owning database. Formerly `tenant_id`; the `tenant_id` alias is
            still accepted (deprecated).
          example: acme_corp
          type: string
        infra:
          $ref: '#/components/schemas/tenants.InfraV2'
          example:
            graph_status: true
            ready_for_ingestion: true
            scheduler_status: true
            vectorstore_status:
              knowledge: true
              memories: true
        message:
          description: Human-readable result message.
          example: Success
          type: string
        org_id:
          description: Organization that owns this resource.
          example: org_1a2b3c
          type: string
        tenant_id:
          deprecated: true
          description: 'Deprecated: use `database`.'
          example: tenant_1234
          type: string
          x-deprecated: 'true'
      title: TenantsInfraStatusResponseV2
      type: object
    handler.apiError:
      properties:
        code:
          description: Machine-readable error code (e.g. `DATABASE_NOT_FOUND`).
          example: DATABASE_NOT_FOUND
          type: string
        details:
          additionalProperties:
            type: string
          description: >-
            Extra facts about the error, as string pairs. Omitted when there are
            none.
          type: object
        message:
          description: Human-readable description of the error.
          example: Database not found
          type: string
        param:
          description: >-
            The request field that caused the error. Omitted when no single
            field is at fault.
          type: string
      title: HandlerApiError
      type: object
    handler.responseMeta:
      properties:
        api_version:
          description: >-
            Version of the API that served the request, for example `2.0.1`.
            Always present.
          type: string
        collection:
          description: >-
            Collection scope. Defaults to the default collection when omitted.
            Formerly `sub_tenant_id`; the `sub_tenant_id` alias is still
            accepted (deprecated).
          example: team_docs
          type: string
        database:
          description: >-
            Owning database. Formerly `tenant_id`; the `tenant_id` alias is
            still accepted (deprecated).
          example: acme_corp
          type: string
        deprecation:
          description: >-
            Migration notices for this request, present only when it used a
            deprecated route, field or selector. The status code is unaffected.
          items:
            $ref: '#/components/schemas/handler.deprecationNotice'
          type: array
          uniqueItems: false
        latency_ms:
          description: Server-side processing time in milliseconds.
          example: 12.3
          type:
            - number
            - 'null'
        request_id:
          description: Unique identifier for this request, useful for support and tracing.
          example: 9d13aef4-02f4-4e73-8c62-4c2601d04f9d
          type: string
        source_type:
          description: Type of the parent source (e.g. `file`, `slack`, `notion`).
          example: file
          type: string
        sub_tenant_id:
          deprecated: true
          description: 'Deprecated: use `collection`.'
          example: sub_tenant_4567
          type: string
          x-deprecated: 'true'
        tenant_id:
          deprecated: true
          description: 'Deprecated: use `database`.'
          example: tenant_1234
          type: string
          x-deprecated: 'true'
        warnings:
          description: >-
            Warnings contains non-fatal notices; enforced reads may include
            acl_ignored_by_connector_enforcement when a request ACL is replaced.
          example:
            - code: acl_ignored_by_connector_enforcement
              message: This connector enforces ACL, so the request's acl was ignored.
          items:
            $ref: '#/components/schemas/handler.ResponseWarning'
          type: array
          uniqueItems: false
      title: HandlerResponseMeta
      type: object
    handler.ErrorDetail:
      properties:
        deprecated:
          description: Whether this response concerns a deprecated field or route.
          example: true
          type: boolean
        deprecated_field:
          description: The deprecated field name.
          example: tenant_id
          type: string
        deprecated_since:
          description: API version that deprecated the conflicting selector.
          example: 2.0.1
          type: string
        error_code:
          description: Machine-readable error classification code.
          example: VALIDATION_ERROR
          type: string
        message:
          description: Human-readable description of the error.
          example: Request validation failed
          type: string
        preferred_field:
          description: The canonical replacement for the deprecated field.
          example: database
          type: string
        retry_after_seconds:
          description: >-
            Seconds to wait before retrying deletion of context that is still
            indexing.
          example: 1
          type: integer
        retryable:
          description: >-
            Whether retrying this failed query can succeed. Present for search
            workflow failures.
          example: true
          type: boolean
        success:
          deprecated: true
          description: >-
            Deprecated: always `false`. Read the HTTP status, then `error.code`
            and `error.message`.
          example: false
          type: boolean
          x-deprecated: 'true'
      title: HandlerErrorDetail
      type: object
    handler.ErrorMeta:
      properties:
        api_version:
          description: Version of the API that served the request, for example `2.0.1`.
          type: string
        latency_ms:
          description: Server-side processing time in milliseconds.
          example: 12.3
          type: number
        request_id:
          description: Unique identifier for this request, useful for support and tracing.
          example: 9d13aef4-02f4-4e73-8c62-4c2601d04f9d
          type: string
      title: HandlerErrorMeta
      type: object
    tenants.InfraV2:
      properties:
        graph_status:
          description: Whether the graph store is healthy for this database.
          example: true
          type: boolean
        ready_for_ingestion:
          description: >-
            True once the database is fully provisioned and can accept ingestion
            and queries. Creation is asynchronous: poll `GET /databases/status`
            until this is true.
          example: true
          type: boolean
        scheduler_status:
          description: >-
            `true` once provisioning of this database has finished; `false`
            while it is still being created, even if collections already exist.
          example: true
          type: boolean
        vectorstore_status:
          $ref: '#/components/schemas/tenants.VectorstoreStatusV2'
          example:
            knowledge: true
            memories: true
      title: TenantsInfraV2
      type: object
    handler.deprecationNotice:
      properties:
        deprecated:
          description: Whether this response concerns a deprecated field or route.
          example: true
          type: boolean
        deprecated_field:
          description: The deprecated field name.
          example: tenant_id
          type: string
        deprecated_since:
          description: API version when the field was deprecated.
          example: 2.0.1
          type: string
        message:
          description: Migration guidance message.
          example: tenant_id is deprecated; use database instead.
          type: string
        preferred_field:
          description: The canonical replacement for the deprecated field.
          example: database
          type: string
      title: HandlerDeprecationNotice
      type: object
    handler.ResponseWarning:
      properties:
        code:
          description: >-
            Code identifies the warning type, such as
            acl_ignored_by_connector_enforcement.
          example: acl_ignored_by_connector_enforcement
          type: string
        message:
          description: Human-readable explanation of the warning.
          example: This connector enforces ACL, so the request's acl was ignored.
          type: string
      title: HandlerResponseWarning
      type: object
    tenants.VectorstoreStatusV2:
      properties:
        knowledge:
          description: Whether the knowledge vector store is healthy.
          example: true
          type: boolean
        memories:
          description: Whether the memories vector store is healthy.
          example: true
          type: boolean
      title: TenantsVectorstoreStatusV2
      type: object
  securitySchemes:
    BearerAuth:
      bearerFormat: API key
      description: 'Send your API key as Authorization: Bearer <your_api_key>.'
      scheme: bearer
      type: http

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.