NUnugen
Models

Deploy Aligned Model

Deploy an aligned model for inference use.

This endpoint deploys a domain-aligned model, making it available for inference.

Path Parameters:

  • model_id: Unique identifier of the aligned model to deploy

Returns:

  • model_id: The aligned model being deployed

Raises:

  • 400: If the model is already deployed, or all 10 deployment slots of your organisation are in use; undeploy a model first
  • 404: If the model or its alignment project is not found
  • 409: If the model is still in train-time alignment; pass early=true to deploy its newest checkpoint

Example Request:

POST /api/v3/models/{model_id}/deployment
Headers: {"Authorization": "Bearer <api_key>"}

Example Response:

{"model_id": "model_01kmqm4nrn9fw6r"}

Notes:

  • Deployment is asynchronous and may take 5-15 minutes to complete
  • Poll GET /api/v3/models/{model_id}/deployment/status; on FAILED the failure reason is in result.error
  • Once deployed, the model will be available at its inference endpoint
  • Model must be in UNDEPLOYED state before deployment
post/api/v3/models/{model_id}/deployment

Request

  • Base URL
    https://api.nugen.in
  • Auth
    HTTP bearer

Path parameters

model_idstring required

ID of the model, as listed by GET /models/aligned or GET /models/base

Query parameters

earlyboolean

Deploy the newest checkpoint of a run still in train-time alignment. The inference GPU serves the latest checkpoint it has written and refreshes on its own, so answers change as train-time alignment continues. Evaluation is unaffected and still runs on the finished model.

Response

Successfully initiated model deployment

model_idstring required

Model ID of the aligned model being deployed

Example response

{
  "model_id": "alignment_01k4x9m2p7q3r8c1-deployed"
}

Changes

No recorded changes to this operation across all 1 revision of this API.