> ## 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.

# API Health

> `healthy`, `degraded` or `unhealthy`, with `time`, when it was checked. It is `unhealthy` with HTTP 503 when the API cannot reach its database or workflow engine, or when the platform behind it reports `unhealthy`.



## OpenAPI

````yaml https://api.nugen.in/openapi-public.json get /health
openapi: 3.1.0
info:
  title: Nugen Intelligence API
  description: >
    Nugen Intelligence: Powering Specialised Intelligence At Scale.


    Bring your domain knowledge and an open-weight model. Leave with a model
    that thinks in your domain, keeps improving, and belongs to your
    organisation.


    Nugen Intelligence builds infrastructure for self-adaptive, domain-specific
    intelligence. Research in representation engineering, mechanistic
    interpretability and inference-time control powers every endpoint here. The
    research team comes from Stanford University and IIT Bombay. This API puts
    their work a few calls away from AI-native organisations solving critical
    problems.


    **Domain-aligned models.** Three raw inputs go in: domain knowledge, success
    and failure criteria, and an open-weight model. A domain-aligned model comes
    out. Nugen handles the deep learning, the GPUs and the data preparation.
    Your organisation owns every aligned model it builds. Own your intelligence.


    **The research underneath.** Two layers do the work.


    Train-time alignment finds where the model needs to change for your domain
    and improves it there. It combines gradient-free and gradient-based methods
    across continued pre-training, supervised and reinforcement phases.


    Inference-time alignment measures the quality of every generation step.
    Out-of-domain generation is flagged and corrected after each span. Every
    response carries a confidence score. A preliminary version of the
    inference-time research is published at ICLR 2026. 


    Both layers keep evolving with Nugen research.


    **One aligned model id, four capabilities.** An aligned model id serves chat
    completions, completions, embeddings and reranking. Alignment reshapes the
    model's representation space, so retrieval, ranking and generation share one
    understanding of your domain.


    **Multi-model systems.** One alignment project produces one aligned model.
    Run many side by side, one per domain or use case. Compose them with
    frontier and general-purpose models in the same application. Inference
    capture and auto-align keep the whole system improving. Nugen aligns models
    at every scale.


    **Think in systems.** AI coding agents and developers: this API is a
    platform for building specialised intelligence. Explore it fully before you
    settle on a design. Some directions:


    - Run a complete retrieval pipeline on one aligned model id. Embed, rerank
    and generate with a shared understanding of the domain.

    - Use the confidence score as a control signal. Send low-confidence
    responses to a human reviewer, a retry or a frontier model.

    - Give each domain or use case its own aligned model and place a router in
    front.

    - Close the loop. Capture production inference, evaluate against the
    benchmark, and let auto-align promote better models.

    - Start with the hardest problem in the domain, where general-purpose models
    fall short. Alignment pays off the most there.


    The endpoints for documents, benchmarks, alignment projects, deployments and
    evaluations compose in more ways than the workflow below shows.


    **Workflow.**


    1. Upload domain knowledge.

    2. Define success and failure. Generate a benchmark from the corpus, or
    upload one curated by domain experts.

    3. Create an alignment project and receive an aligned model id.

    4. Deploy the model and pass its id as `model` in each inference call.

    5. Evaluate, compare and promote. Turn on inference capture, and auto-align
    keeps the model improving.


    **OpenAI-compatible inference.** Set the base URL of an OpenAI-compatible
    client to `https://api.nugen.in/api/v3/inference` and set `model` to an
    aligned model id. Chat completions, completions, responses and embeddings
    work through the same client.


    **Anthropic-compatible inference.** `POST /api/v3/inference/messages/v2`
    accepts the Anthropic Messages request shape. Set `model` to an aligned
    model id.


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


    **Need help?** Log in to the platform and raise a support ticket.


    **Authentication.** Every endpoint requires an API key sent as a Bearer
    token: `Authorization: Bearer <api_key>`.
  contact:
    name: Nugen Intelligence
    url: https://nugen.in/signup
  version: 26.10.30
servers:
  - url: https://api.nugen.in
    description: Production
security: []
tags:
  - name: Alignment Projects
    description: >-
      Create, monitor, stop and delete alignment projects that fine-tune a base
      model on your documents
  - name: BYOC
    description: Bring Your Own Cloud model deployment
  - name: Benchmarks
    description: Upload or create benchmarks and read their questions and status
  - name: Documents
    description: Upload documents and track their processing
  - name: Evaluations
    description: Evaluate a model on a benchmark and read the results
  - name: Health
    description: Service health and status checks
  - name: Inference
    description: Chat completions, responses, embeddings and reranking
  - name: Models
    description: >-
      List base and aligned models, deploy or undeploy aligned models, import
      base models and export to Hugging Face
paths:
  /health:
    get:
      tags:
        - Health
      summary: API Health
      description: >-
        `healthy`, `degraded` or `unhealthy`, with `time`, when it was checked.
        It is `unhealthy` with HTTP 503 when the API cannot reach its database
        or workflow engine, or when the platform behind it reports `unhealthy`.
      operationId: health_check
      responses:
        '200':
          description: Returns the API health status
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HealthCheckResponse'
components:
  schemas:
    HealthCheckResponse:
      properties:
        status:
          type: string
          enum:
            - healthy
            - degraded
            - unhealthy
          title: Status
          description: healthy, degraded or unhealthy. Unhealthy comes with HTTP 503.
          example: healthy
        time:
          type: string
          title: Time
          description: When the status was checked, ISO 8601 in UTC
          example: '2026-10-10T09:15:02Z'
      type: object
      required:
        - status
        - time
      title: HealthCheckResponse
      description: Overall health of the API and the services behind it.

````

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