> ## Documentation Index
> Fetch the complete documentation index at: https://docs.nugen.in/llms.txt
> Use this file to discover all available pages before exploring further.

# Get Benchmark List

> Retrieve all benchmarks for the user.


This endpoint returns a comprehensive list of all benchmarks created or uploaded by the user, including both generated and manually uploaded benchmarks.


**Returns:**

- `benchmarks`: List of benchmark objects, each containing:
  - `id`: Unique benchmark identifier
  - `benchmark_name`: Generated name (format: `Benchmark_{document_id}`)
  - `status`: Benchmark status (`PROCESSING`, `READY`, `UPLOADED`)
  - `documents`: List of document IDs used for this benchmark (array with one element for uploaded benchmarks, multiple elements for generated benchmarks)
  - `num_questions`: Number of questions in the benchmark
  - `created_at`: Timestamp when benchmark was created
  - `updated_at`: Timestamp when benchmark was last updated


**Example Request:**

```json
GET /api/v3/benchmark/list
Headers: {"Authorization": "Bearer <api_key>"}
```


**Example Response:**

```json
{
  "benchmarks": [
    {
      "id": "task-abc123",
      "benchmark_name": "Benchmark_doc-123",
      "status": "READY",
      "documents": ["doc-123", "doc-456"],
      "num_questions": 10,
      "created_at": "2024-01-15T10:30:00Z",
      "updated_at": "2024-01-15T10:32:45Z"
    },
    {
      "id": "benchmark-xyz789",
      "benchmark_name": "Benchmark_doc-789",
      "status": "uploaded",
      "documents": ["doc-789"],
      "num_questions": 15,
      "created_at": "2024-01-16T14:20:00Z",
      "updated_at": "2024-01-16T14:20:00Z"
    }
  ]
}
```



## OpenAPI

````yaml https://api.nugen.in/openapi-public.json get /api/v3/benchmark/list
openapi: 3.1.0
info:
  title: Nugen Intelligence API
  description: 'Nugen Intelligence : Powering Specialized Intelligence At Scale'
  version: 25.4.20
servers: []
security: []
paths:
  /api/v3/benchmark/list:
    get:
      tags:
        - Benchmark
      summary: Get Benchmark List
      description: >-
        Retrieve all benchmarks for the user.



        This endpoint returns a comprehensive list of all benchmarks created or
        uploaded by the user, including both generated and manually uploaded
        benchmarks.



        **Returns:**


        - `benchmarks`: List of benchmark objects, each containing:
          - `id`: Unique benchmark identifier
          - `benchmark_name`: Generated name (format: `Benchmark_{document_id}`)
          - `status`: Benchmark status (`PROCESSING`, `READY`, `UPLOADED`)
          - `documents`: List of document IDs used for this benchmark (array with one element for uploaded benchmarks, multiple elements for generated benchmarks)
          - `num_questions`: Number of questions in the benchmark
          - `created_at`: Timestamp when benchmark was created
          - `updated_at`: Timestamp when benchmark was last updated


        **Example Request:**


        ```json

        GET /api/v3/benchmark/list

        Headers: {"Authorization": "Bearer <api_key>"}

        ```



        **Example Response:**


        ```json

        {
          "benchmarks": [
            {
              "id": "task-abc123",
              "benchmark_name": "Benchmark_doc-123",
              "status": "READY",
              "documents": ["doc-123", "doc-456"],
              "num_questions": 10,
              "created_at": "2024-01-15T10:30:00Z",
              "updated_at": "2024-01-15T10:32:45Z"
            },
            {
              "id": "benchmark-xyz789",
              "benchmark_name": "Benchmark_doc-789",
              "status": "uploaded",
              "documents": ["doc-789"],
              "num_questions": 15,
              "created_at": "2024-01-16T14:20:00Z",
              "updated_at": "2024-01-16T14:20:00Z"
            }
          ]
        }

        ```
      operationId: get_benchmark_list
      responses:
        '200':
          description: >-
            Returns a list of all benchmarks created or uploaded by the user,
            including both generated and manually uploaded benchmarks
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BenchmarkListResponse'
      security:
        - HTTPBearer: []
components:
  schemas:
    BenchmarkListResponse:
      properties:
        benchmarks:
          items:
            $ref: '#/components/schemas/BenchmarkList'
          type: array
          title: Benchmarks
          description: List of benchmarks
          example:
            - benchmark-123
            - benchmark-456
      type: object
      required:
        - benchmarks
      title: BenchmarkListResponse
    BenchmarkList:
      properties:
        benchmark_id:
          type: string
          title: Benchmark Id
          description: Benchmark ID
          example: benchmark-123
        benchmark_name:
          type: string
          title: Benchmark Name
          description: Name of the benchmark
          example: Customer Support Q&A
        status:
          $ref: '#/components/schemas/TaskStatus'
          description: Benchmark status
        document_ids:
          items:
            type: string
          type: array
          title: Document Ids
          description: Document IDs
        num_questions:
          anyOf:
            - type: integer
            - type: 'null'
          title: Num Questions
          description: Number of questions
        created_at:
          type: string
          format: date-time
          title: Created At
          description: Creation timestamp
        updated_at:
          type: string
          format: date-time
          title: Updated At
          description: Last update timestamp
      type: object
      required:
        - benchmark_id
        - benchmark_name
        - status
        - created_at
        - updated_at
      title: BenchmarkList
    TaskStatus:
      type: string
      enum:
        - PROCESSING
        - READY
        - FAILED
        - DEPLOYING
        - EVALUATING
        - UNDEPLOYED
        - EVALUATED
        - STOPPED
      title: TaskStatus
  securitySchemes:
    HTTPBearer:
      type: http
      scheme: bearer

````