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

# Healthcheck Deep

> Full health check — pings every dependent service with aggressive per-service
timeouts (500ms) so total wall time stays under ~3s even when a service is slow.

Use the ``deep=true`` query parameter for additional data-plane verification
(e.g. reading from MongoDB collections, probing MVS namespaces, listing
the live work dispatchers).



## OpenAPI

````yaml get /v1/health/deep
openapi: 3.1.0
info:
  title: Mixpeek API
  description: >-
    This is the Mixpeek API, providing access to various endpoints for data
    processing and retrieval.
  termsOfService: https://mixpeek.com/terms
  contact:
    name: Mixpeek Support
    url: https://mixpeek.com/contact
    email: info@mixpeek.com
  version: '0.82'
servers:
  - url: https://api.mixpeek.com
    description: Production
security:
  - BearerAuth: []
paths:
  /v1/health/deep:
    get:
      tags:
        - Health
      summary: Healthcheck Deep
      description: >-
        Full health check — pings every dependent service with aggressive
        per-service

        timeouts (500ms) so total wall time stays under ~3s even when a service
        is slow.


        Use the ``deep=true`` query parameter for additional data-plane
        verification

        (e.g. reading from MongoDB collections, probing MVS namespaces, listing

        the live work dispatchers).
      operationId: healthcheck_deep_v1_health_deep_get
      parameters:
        - name: deep
          in: query
          required: false
          schema:
            type: boolean
            default: false
            title: Deep
        - name: metrics
          in: query
          required: false
          schema:
            type: boolean
            description: Include Layer 2 protection metrics
            default: false
            title: Metrics
          description: Include Layer 2 protection metrics
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HealthCheckResponse'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '422':
          description: Unprocessable Entity
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '429':
          description: Too Many Requests
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '503':
          description: Service Unavailable
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      security:
        - BearerAuth: []
components:
  schemas:
    HealthCheckResponse:
      properties:
        status:
          $ref: '#/components/schemas/HealthStatus-Output'
          description: Overall API health status
        data:
          $ref: '#/components/schemas/HealthServiceStatus'
          description: Per-service health status flags
        errors:
          anyOf:
            - $ref: '#/components/schemas/HealthServiceErrors'
            - type: 'null'
          description: Optional per-service error messages when a service check fails
        meta:
          anyOf:
            - additionalProperties: true
              type: object
            - type: 'null'
          title: Meta
          description: >-
            Optional metadata such as configured object storage
            bucket/region/endpoint, API URL, and deployment health details (when
            deep=True)
      type: object
      required:
        - status
        - data
      title: HealthCheckResponse
      description: Health check response model.
    ErrorResponse:
      properties:
        success:
          type: boolean
          title: Success
          description: Always false for error responses
          default: false
        status:
          type: integer
          title: Status
          description: HTTP status code for this error
        error:
          $ref: '#/components/schemas/ErrorDetail'
          description: Error details payload
      type: object
      required:
        - status
        - error
      title: ErrorResponse
      description: Error response model.
      examples:
        - error:
            details:
              id: ns_123
              resource: namespace
            message: Namespace not found
            type: NotFoundError
          status: 404
          success: false
    HealthStatus-Output:
      type: string
      enum:
        - OK
        - DEGRADED
      title: HealthStatus
      description: Overall health status.
    HealthServiceStatus:
      properties:
        cache:
          type: boolean
          title: Cache
          description: Cache layer connectivity successful
          examples:
            - true
        metadata:
          type: boolean
          title: Metadata
          description: Metadata store connectivity successful
          examples:
            - true
        vector_store:
          type: boolean
          title: Vector Store
          description: Vector database connectivity successful
          examples:
            - true
        object_storage:
          type: boolean
          title: Object Storage
          description: Object storage connectivity successful
          examples:
            - true
        task_queue:
          type: boolean
          title: Task Queue
          description: Task queue execution successful
          examples:
            - true
        inference:
          type: boolean
          title: Inference
          description: Inference engine health check successful
          examples:
            - true
        analytics:
          anyOf:
            - type: boolean
            - type: 'null'
          title: Analytics
          description: Analytics backend healthy (optional, None if disabled)
          examples:
            - true
            - null
      type: object
      required:
        - cache
        - metadata
        - vector_store
        - object_storage
        - task_queue
        - inference
      title: HealthServiceStatus
      description: Status flags for dependent services.
    HealthServiceErrors:
      properties:
        cache:
          anyOf:
            - type: string
            - type: 'null'
          title: Cache
          description: Cache layer error message, if any
        metadata:
          anyOf:
            - type: string
            - type: 'null'
          title: Metadata
          description: Metadata store error message, if any
        vector_store:
          anyOf:
            - type: string
            - type: 'null'
          title: Vector Store
          description: Vector database error message, if any
        object_storage:
          anyOf:
            - type: string
            - type: 'null'
          title: Object Storage
          description: Object storage error message, if any
        task_queue:
          anyOf:
            - type: string
            - type: 'null'
          title: Task Queue
          description: Task queue error message, if any
        inference:
          anyOf:
            - type: string
            - type: 'null'
          title: Inference
          description: Inference engine error message, if any
        analytics:
          anyOf:
            - type: string
            - type: 'null'
          title: Analytics
          description: Analytics backend error message, if any
      type: object
      title: HealthServiceErrors
      description: >-
        Optional error messages for dependent services (present when a check
        fails).
    ErrorDetail:
      properties:
        message:
          type: string
          title: Message
          description: Human-readable error message
        type:
          type: string
          title: Type
          description: Stable error type identifier (machine-readable)
        code:
          anyOf:
            - type: string
            - type: 'null'
          title: Code
          description: >-
            Fine-grained error code for programmatic handling (e.g.,
            namespace_name_taken, feature_extractor_not_found). Present only
            when consumers may need to branch on a specific error condition.
        details:
          anyOf:
            - additionalProperties: true
              type: object
            - type: 'null'
          title: Details
          description: >-
            Optional structured details to help debugging (validation errors,
            IDs, etc.)
      type: object
      required:
        - message
        - type
      title: ErrorDetail
      description: Error detail model.
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer
      description: >-
        Mixpeek API key, sent as `Authorization: Bearer mxp_sk_...`. Create one
        in Studio under Settings → API Keys, or with an admin key via `POST
        /v1/organizations/users/{user_email}/api-keys`. A missing, malformed,
        unknown, revoked, inactive or expired key returns 401; a key without the
        permission, scope or plan an operation needs returns 403.

````

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