Evaluations

Get Evaluation Status

Get the current status of an evaluation.

This endpoint retrieves the status of a running or completed evaluation. Use this to determine when results are ready; fetch the full record once from GET /evaluations/{evaluation_id}.

Path Parameters:

  • evaluation_id: Unique evaluation identifier

Returns:

  • evaluation_id: The evaluation identifier
  • status: Current status (QUEUED, PROCESSING, READY, FAILED)
  • created_at, completed_at, updated_at: timestamps
  • progress, eta_seconds: not wired up yet, always null
  • error: why the evaluation failed, set only when status is FAILED

Raises:

  • 404: If evaluation not found or doesn't belong to the authenticated user

Example Request:

GET /api/v3/evaluations/evaluation_01k4x9m2p7q3r7b1/status
Headers: {"Authorization": "Bearer <api_key>"}

Example Response:

{
  "evaluation_id": "evaluation_01k4x9m2p7q3r7b1",
  "status": "READY",
  "created_at": "2024-02-24T10:00:00Z",
  "completed_at": "2024-02-24T10:05:00Z",
  "updated_at": "2024-02-24T10:05:00Z",
  "progress": null,
  "eta_seconds": null
}

Notes:

  • Once status is READY, use /evaluations/{evaluation_id}/results to get full results
  • Status FAILED indicates an error occurred during evaluation
get/api/v3/evaluations/{evaluation_id}/status

Request

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

Path parameters

evaluation_idstring required

ID of the evaluation, returned when it was created

Response

Returns the current status and progress of an evaluation. This endpoint retrieves the status of a running or completed evaluation with detailed progress metrics, allowing users to track the evaluation process and determine when results are ready.

evaluation_idstring required

Unique identifier for the evaluation

status'QUEUED' | 'PROCESSING' | 'READY' | 'FAILED' | 'STOPPED' required

Lifecycle status of a resource that runs asynchronously. Stored as is and returned as is, with no translation in between.

  • QUEUED: accepted and waiting for its workflow to start
  • PROCESSING: running
  • READY: finished successfully
  • FAILED: failed at any stage
  • STOPPED: stopped by the user before completion
created_atstring date-time nullable

Timestamp when the evaluation was created

completed_atstring date-time nullable

Timestamp when the evaluation completed; null while still running

updated_atstring date-time nullable

Timestamp of the last status change

progressnumber nullable

Completion progress, 0.0 to 100.0. Not wired up yet, always null.

eta_secondsinteger nullable

Estimated time remaining in seconds. Not wired up yet, always null.

errorstring nullable

Why the evaluation failed, set only when status is FAILED

Example response

{
  "evaluation_id": "evaluation_01k4x9m2p7q3r7b1",
  "created_at": "2024-02-24T10:00:00Z",
  "completed_at": "2024-02-24T10:05:00Z",
  "error": "Inference server rejected the batch: model not found"
}

Changes

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