List Generations

Endpoint:
GET /api/v1/generations

Retrieve a paginated list of all your generation jobs (3D rotating product video generations). This endpoint allows you to browse your history, check statuses, and manage your generated videos.

Authentication

All requests require an API key.
Include your API key in the Authorization header as a Bearer token:

Authorization: Bearer YOUR_API_KEY

Query Parameters

Parameter	Type	Default	Description
page	number	1	The page number to retrieve
pageSize	number	20	The number of items per page (max: 100)

Example Request

curl -H "Authorization: Bearer YOUR_API_KEY" \
  "https://rotateproduct.com/api/v1/generations?page=1&pageSize=10"

Response

200 OK: Returns a paginated list of generations for the authenticated user.

Response Body

{
  "page": 1,
  "pageSize": 10,
  "total": 42,
  "generations": [
    {
      "id": 31,
      "external_id": "abc-123",
      "status": "completed",
      "created_at": "2024-05-08T12:34:56.789Z",
      "updated_at": "2024-05-08T12:35:56.789Z"
    }
    // ... up to pageSize items
  ]
}

Field Descriptions

page: The current page number.
pageSize: The number of items per page.
total: The total number of generations available.
generations: An array of generation objects, each containing:
- id: The unique identifier for the generation.
- external_id: Your provided external identifier (if any).
- status: The current status (rotating, completed, failed, etc.).
- created_at: When the generation was created.
- updated_at: When the generation was last updated.

Best Practices

Paginate through your generations to efficiently manage large histories.
Store the id and external_id for tracking and mapping results in your system.
Check the status to determine if a generation is ready for download or still processing.

FAQ

Q: What is the maximum page size?
A: The default is 20, and the maximum allowed is 100 per request.

Q: How are generations ordered?
A: Generations are returned in descending order by creation date (most recent first).

Q: Can I filter by status or date?
A: Filtering is not currently supported, but you can implement it client-side after fetching results.

For more help, contact info@rotateproduct.com.

Start automating your 3D product video creation with RotateProduct’s API today!