Get Undeploy Status
Check the un-deployment status of an aligned model.
This endpoint retrieves the current un-deployment status of a model, including progress and completion information.
Path Parameters:
model_id: Unique identifier of the model to check un-deployment status for
Returns:
model_id: The model identifierstatus: Un-deployment statusPENDING: Undeployment in progressCOMPLETED: Successfully undeployedFAILED: Undeployment failed
result: Task result details (if completed or failed)start_time: Timestamp when undeployment startedend_time: Timestamp when undeployment completed (null if still pending)
Raises:
404: If model not found or doesn’t belong to user
Example Request:
GET /api/v3/models/undeploy-model/alignment-xyz789/status
Headers: {"Authorization": "Bearer <api_key>"}
Example Response (Completed):
{
"model_id": "alignment-xyz789",
"status": "COMPLETED",
"result": {
"message": "Model successfully undeployed"
},
"start_time": "2024-02-24T10:00:00Z",
"end_time": "2024-02-24T10:02:30Z"
}
Notes:
- Poll this endpoint to track un-deployment progress
- Un-deployment typically completes within a few minutes
- Status
COMPLETEDmeans the model has been successfully removed from inference
Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Path Parameters
Response
Returns the current un-deployment status of an aligned model. This endpoint retrieves the status of a running un-deployment with detailed progress information, allowing users to track the un-deployment process and determine when their model has been successfully removed from inference. The response includes the current un-deployment state (pending, completed, failed), any relevant result details from the un-deployment task, and timestamps for when the un-deployment started and completed.
Response schema for undeploy status check
User-facing model ID
Celery task status: PENDING (in progress) or COMPLETED (finished)
"pending"
Task result if completed
start time
"2024-02-24T10:00:00Z"
end time
"2024-02-24T10:05:00Z"