Skip to main content
POST
Create Benchmark

Authorizations

Authorization
string
header
required

Your Nugen API key, sent as a Bearer token

Body

application/json

Generate a benchmark from your documents.

document_ids
string[]
required

List of document IDs to generate benchmark from

Example:
benchmark_name
string | null

Display name for the benchmark. Defaults to the benchmark id if omitted.

Example:

"Contract Clause Review"

n_samples
integer | null
default:20

Number of samples to generate (if None, decided from the content)

Required range: 1 <= x <= 100
Example:

10

Response

Returns a unique identifier and initial status for the benchmark generation initiated from specified documents

Acknowledgement of a benchmark generation request.

benchmark_id
string
required

Created benchmark identifier

Example:

"benchmark_01k4x9m2p7q3r6a1"

benchmark_name
string
required

Display name of the benchmark

Example:

"Contract Clause Review"

status
enum<string>
default:QUEUED

Initial benchmark generation status

Available options:
QUEUED,
PROCESSING,
READY,
FAILED,
STOPPED
Example:

"QUEUED"