NUnugen
Benchmarks

Get Benchmark

Get one benchmark by ID.

Returns:

  • benchmark_id, benchmark_name, status (PROCESSING, READY, FAILED)
  • n_samples, source (generated or uploaded)
  • created_at, completed_at, updated_at
  • progress, eta_seconds: not wired up yet, always null
get/api/v3/benchmarks/{benchmark_id}

Request

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

Path parameters

benchmark_idstring required

ID of the benchmark, returned when it was created

Response

Returns the benchmark's own record: status, sample count, source and timestamps. Samples themselves are served by the data endpoint.

benchmark_idstring required

Unique identifier of the benchmark.

benchmark_namestring nullable

Display name of the benchmark.

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
n_samplesinteger nullable

Number of samples in the benchmark.

sourcestring nullable

How the benchmark was made: generated or uploaded.

created_atstring nullable

Creation timestamp.

completed_atstring nullable

Timestamp when generation completed; null while still running.

updated_atstring nullable

Last update timestamp.

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.

Changes

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