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

# Get Queue Progress

> Endpoint to check the progress of a specific video generation request in the queue.

<Note type="info">**Note:** This operation does not consume any account credits.</Note>

## Get Queue Progress

This endpoint allows you to check the progress of a specific video generation request in the queue.

### Request

* **Endpoint**: `GET /v1/queue/progress/{queueId}`
* **Authorization**: Bearer token required

#### Path Parameters

| Parameter | Type     | Required | Description                        |
| --------- | -------- | -------- | ---------------------------------- |
| `queueId` | `string` | Yes      | The ID of the queue item to check. |

#### Example Request

```bash theme={null}
curl -X GET https://api.videnly.com/v1/queue/progress/xxxxxxxxxxxxxxxxxxxxxxxx \
-H "Authorization: Bearer YOUR_API_KEY"
```

### Response

A successful response will return the current status and progress of the specified queue item.

#### Example Response

```json theme={null}
{
   "status": "success",
   "message": "Queue item progress retrieved successfully",
   "details": {
      "status": "pending",
      "generationProgress": 50,
      "renderProgress": 0
   }
}
```

* **status**: Overall status of the request.
* **message**: Descriptive message of the result.
* **details**: Object containing the current status of the queue item and its progress.

### Possible Error Responses

* **400**: Invalid `queueId` format.
* **404**: Queue item not found.
* **500**: Server error.


## OpenAPI

````yaml GET /v1/queue/progress/{queueId}
openapi: 3.0.0
info:
  title: Videnly API
  version: 1.0.0
  description: API for managing video generation, queue, and user account details.
servers: []
security: []
paths:
  /v1/queue/progress/{queueId}:
    get:
      tags:
        - Queue
      summary: Get progress of a video generation request
      description: >-
        Retrieves the current progress of a video generation request in the
        queue.
      operationId: getQueueProgress
      parameters:
        - name: queueId
          in: path
          required: true
          schema:
            type: string
          description: The unique ID of the queue item to retrieve progress for
      responses:
        '200':
          description: Queue item progress retrieved successfully
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: string
                  message:
                    type: string
                  details:
                    type: object
                    properties:
                      status:
                        type: string
                      generationProgress:
                        type: integer
                      renderProgress:
                        type: integer
        '400':
          description: Invalid queue ID format
        '404':
          description: Queue item not found
        '500':
          description: Server error
      security:
        - ApiKeyAuth: []
components:
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: Authorization
      description: Use format `Bearer YOUR_API_KEY`.

````