Get Generation Status by ID

Endpoint:
GET /api/v1/generations/:id/status

Retrieve the status and metadata of a specific generation by its unique ID. Use this endpoint to check if your 3D rotating product video is still processing, completed, or if there was an error.

Authentication

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

Authorization: Bearer YOUR_API_KEY

URL Parameters

• id (string, required): The unique identifier of the generation you want to retrieve.

Example:
GET /api/v1/generations/123/status

Response

• 200 OK: Returns the status and metadata of the generation.
• 404 Not Found: If the generation does not exist.

Response Body

{
  "id": 270,
  "external_id": "your-external-id",
  "status": "succeeded",
  "created_at": "2025-05-08T11:58:24.070589",
  "updated_at": "2025-05-08T12:01:27.539"
}

Status Values

• processing: The video is being generated.
• succeeded: The video generation is finished and ready.
• failed: There was an error during generation.

Example Request

cURL

curl -H "Authorization: Bearer YOUR_API_KEY" \
  https://rotateproduct.com/api/v1/generations/123/status

Error Responses

Not Found

{
  "success": false,
  "error": {
    "code": 4006,
    "message": "generation not found",
    "meta": {
        "friendlyMessage": "generation not found",
        "type": "error",
        "title": "Generation Not Found",
        "resource": "generation",
        "id": "999"
    }
  }
}

Best Practices

• Poll this endpoint to check the status of your generation after submitting a bulk or single generation request.
• Handle all status values in your application logic to provide a smooth user experience.
• Store the id and external_id for tracking and mapping results in your system.

FAQ

Q: How often should I poll for status?
A: Poll every few seconds (e.g., every 5–10 seconds) until the status is completed or failed.

Q: What should I do if the status is failed?
A: You may retry the generation or contact support for further assistance.

Q: Can I use the same endpoint to get the video?
A: No, this endpoint only returns status and metadata. Use the Get Generation by ID endpoint to retrieve the video file.

For more help, contact info@rotateproduct.com.