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

# Get provisioning progress and cluster health

> Provisioning progress and health for one environment.


**Path Parameters:**

- `cluster_id`: The environment to check


**Returns:**

- `cluster_id`, `cluster_name`, `mode`
- `status`: Provisioning status
- `message`: What the status means
- `created_at`: When the request was received


**Raises:**

- `404`: If the environment is not found or does not belong to you



## OpenAPI

````yaml https://api.nugen.in/openapi-public.json get /api/v3/byoc/clusters/{cluster_id}/status
openapi: 3.1.0
info:
  title: Nugen Intelligence API
  description: >+
    Nugen Intelligence: Powering Specialized Intelligence At Scale.


    **Need an API key?** Sign up, log in to the platform and generate an API
    key.


    **Need help?** Sign up, log in to the platform and raise a support ticket.


    **What this API does.** Align models to your domain corpus and run them with

    confidence. Train-time alignment builds domain-aligned adaptors through

    proprietary methods spanning pre-training, supervised and reinforcement

    stages. Inference-time alignment quantifies uncertainty across the full

    generation trajectory, producing confidence scores and keeping every

    response on domain.


    **Workflow.** Upload documents, create or generate a benchmark, create an

    alignment project, receive an aligned model id. That one id serves chat

    completions, completions, embeddings and reranking, and its embeddings carry

    your domain's representation space, making retrieval domain aware. You
    define the success

    criteria for your domain; the platform handles the deep learning, the GPUs

    and the data preparation.


    **Authentication.** Every endpoint requires an API key sent as a Bearer
    token:

    `Authorization: Bearer <api_key>`.

  contact:
    name: Nugen Intelligence - Customer Support
    url: https://nugen.in/signup
    email: support@nugen.in
  version: 25.4.20
servers:
  - url: https://api.nugen.in
    description: Production
security: []
paths:
  /api/v3/byoc/clusters/{cluster_id}/status:
    get:
      tags:
        - BYOC
      summary: Get provisioning progress and cluster health
      description: |-
        Provisioning progress and health for one environment.


        **Path Parameters:**

        - `cluster_id`: The environment to check


        **Returns:**

        - `cluster_id`, `cluster_name`, `mode`
        - `status`: Provisioning status
        - `message`: What the status means
        - `created_at`: When the request was received


        **Raises:**

        - `404`: If the environment is not found or does not belong to you
      operationId: get_byoc_cluster_status
      parameters:
        - name: cluster_id
          in: path
          required: true
          schema:
            type: string
            title: Cluster Id
      responses:
        '200':
          description: Current status of a bring your own cloud environment.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BYOCClusterStatusResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      security:
        - HTTPBearer: []
components:
  schemas:
    BYOCClusterStatusResponse:
      properties:
        cluster_id:
          type: string
          title: Cluster Id
          description: Identifier of this environment.
        cluster_name:
          type: string
          title: Cluster Name
          description: Name given to the environment.
        mode:
          type: string
          title: Mode
          description: managed_provisioning or cluster_import.
        status:
          type: string
          title: Status
          description: Provisioning status.
        message:
          type: string
          title: Message
          description: Human-readable status detail.
        created_at:
          anyOf:
            - type: string
            - type: 'null'
          title: Created At
          description: When the request was received.
      type: object
      required:
        - cluster_id
        - cluster_name
        - mode
        - status
        - message
      title: BYOCClusterStatusResponse
      description: Provisioning progress and cluster health.
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
              - type: string
              - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
      type: object
      required:
        - loc
        - msg
        - type
      title: ValidationError
  securitySchemes:
    HTTPBearer:
      type: http
      scheme: bearer

````