> ## 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 Status

> Get the status of a benchmark generation task.


This endpoint retrieves the current status and details of a benchmark generation task. Use this to track the progress of benchmark generation initiated by the create endpoint.


**Path Parameters:**

- `id`: Unique identifier returned from the create endpoint


**Returns:**

- `id`: unique identifier
- `benchmark_name`: Generated name for the benchmark
- `status`: status (`PROCESSING` while running, `READY` when finished)
- `start_time`: Timestamp when task was created
- `end_time`: Timestamp when task completed (null if still pending)


**Raises:**

- `404`: If benchmark task not found or documents not found for the task


**Example Request:**

```json
GET /api/v3/benchmark/status/task-abc123
Headers: {"Authorization": "Bearer <api_key>"}
```


**Example Response:**

```json
{
  "id": "task-abc123",
  "benchmark_name": "Benchmark_doc-123",
  "status": "READY",
  "start_time": "2024-01-15T10:30:00Z",
  "end_time": "2024-01-15T10:32:45Z"
}
```


**Notes:**

- Status remains `PROCESSING` while the generation process is running
- Status changes to `READY` once all questions are generated



## OpenAPI

````yaml https://api.nugen.in/openapi-public.json get /api/v3/benchmark/status/{id}
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/status/{id}:
    get:
      tags:
        - Benchmark
      summary: Get Benchmark Status
      description: >-
        Get the status of a benchmark generation task.



        This endpoint retrieves the current status and details of a benchmark
        generation task. Use this to track the progress of benchmark generation
        initiated by the create endpoint.



        **Path Parameters:**


        - `id`: Unique identifier returned from the create endpoint



        **Returns:**


        - `id`: unique identifier

        - `benchmark_name`: Generated name for the benchmark

        - `status`: status (`PROCESSING` while running, `READY` when finished)

        - `start_time`: Timestamp when task was created

        - `end_time`: Timestamp when task completed (null if still pending)



        **Raises:**


        - `404`: If benchmark task not found or documents not found for the task



        **Example Request:**


        ```json

        GET /api/v3/benchmark/status/task-abc123

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

        ```



        **Example Response:**


        ```json

        {
          "id": "task-abc123",
          "benchmark_name": "Benchmark_doc-123",
          "status": "READY",
          "start_time": "2024-01-15T10:30:00Z",
          "end_time": "2024-01-15T10:32:45Z"
        }

        ```



        **Notes:**


        - Status remains `PROCESSING` while the generation process is running

        - Status changes to `READY` once all questions are generated
      operationId: get_benchmark_status
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: string
            title: Id
      responses:
        '200':
          description: >-
            Get the status of a benchmark generation task, including current
            progress, associated documents, and timestamps for task creation and
            completion
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BenchmarkResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      security:
        - HTTPBearer: []
components:
  schemas:
    BenchmarkResponse:
      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
          example: PROCESSING
        start_time:
          anyOf:
            - type: string
              format: date-time
            - type: 'null'
          title: Start Time
          description: Benchmark generation start time
          example: '2024-01-15T10:30:00Z'
        end_time:
          anyOf:
            - type: string
              format: date-time
            - type: 'null'
          title: End Time
          description: Benchmark generation end time
          example: '2024-01-15T12:30:00Z'
      type: object
      required:
        - benchmark_id
        - benchmark_name
        - status
      title: BenchmarkResponse
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    TaskStatus:
      type: string
      enum:
        - PROCESSING
        - READY
        - FAILED
        - DEPLOYING
        - EVALUATING
        - UNDEPLOYED
        - EVALUATED
        - STOPPED
      title: TaskStatus
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
              - type: string
              - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
      type: object
      required:
        - loc
        - msg
        - type
      title: ValidationError
  securitySchemes:
    HTTPBearer:
      type: http
      scheme: bearer

````