Benchmarks
Get Benchmark Status
Get the status of a benchmark generation run.
This endpoint retrieves the current status of a benchmark generation run. Use this to track the progress of benchmark generation initiated by the create endpoint.
Path Parameters:
- benchmark_id: Unique identifier returned from the create endpoint
Returns:
- benchmark_id: unique identifier
- status: status (QUEUED until a worker starts, PROCESSING while running, READY when finished)
- created_at, completed_at, updated_at: timestamps
- progress, eta_seconds: not wired up yet, always null
Raises:
- 404: If the benchmark or its documents are not found
Example Request:
GET /api/v3/benchmarks/benchmark_01k4x9m2p7q3r6a1/status
Headers: {"Authorization": "Bearer <api_key>"}
Example Response:
{
"benchmark_id": "benchmark_01k4x9m2p7q3r6a1",
"status": "READY",
"created_at": "2024-01-15T10:30:00Z",
"completed_at": "2024-01-15T10:32:45Z",
"updated_at": "2024-01-15T10:32:45Z",
"progress": null,
"eta_seconds": null
}
Notes:
- Status is QUEUED until a worker starts and PROCESSING while the generation process is running
- Status changes to READY once all samples are generated
get/api/v3/benchmarks/{benchmark_id}/status
Request
- Base URLhttps://api.nugen.in
- AuthHTTP bearer
Path parameters
benchmark_idstring required
ID of the benchmark, returned when it was created
Response
Get the status of a benchmark generation run, including current progress and timestamps for creation and completion
Example response
{
"benchmark_id": "benchmark_01k4x9m2p7q3r6a1",
"created_at": "2024-01-15T10:30:00Z",
"completed_at": "2024-01-15T12:30:00Z",
"updated_at": "2024-01-15T10:32:45Z"
}Changes
No recorded changes to this operation across all 1 revision of this API.