Check Generation Status

Check the status of a video generation job

Overview

This endpoint allows you to check the current status of a video generation job. Use this to monitor progress and retrieve the final video when generation is complete.

Authentication

This endpoint requires API key authentication. Include your API key in the Authorization header.

Path Parameters

jobId · string · required

The job ID returned from the /generation/start endpoint.

Response

job_id · string

The unique identifier for the generation job.

status · string

Current job status:

• pending: Job is queued and waiting to start
• processing: Generation is in progress
• completed: Generation finished successfully
• failed: Generation failed

progress_step · number

Progress percentage (0-100).

current_step · string

Description of the current processing step.

result · object

Available when status is completed:

Show properties

video_id · string

Unique identifier for the generated video.

duration · number

Actual video duration in seconds.

cost · number

Actual credits consumed for generation.

created_at · string

ISO timestamp when generation completed.

error · object

Available when status is failed:

Show properties

code · string

Error code describing the failure reason.

message · string

Human-readable error message.

Example

cURL

curl -X GET "https://app.hoox.video/api/public/v1/generation/status/run_abcd1234" \
  -H "Authorization: Bearer your_api_key"

Pending

{
  "job_id": "run_abcd1234",
  "status": "pending",
  "progress_step": 0,
  "current_step": "QUEUE"
}

Polling Best Practices

Recommended polling strategy:

1. Start with a 5-second interval for the first minute
2. Increase to 10-second intervals after 1 minute
3. Increase to 30-second intervals after 5 minutes
4. Use webhooks for more efficient status updates

Next Steps

Once your video generation is complete (status: "completed"):

1. Note the video_id from the result
2. Use the /export/start endpoint to export your video in the desired format
3. Monitor the export progress with /export/status/{job_id}

Error Codes

Common error codes you might encounter:

• JOB_NOT_FOUND: Job ID doesn’t exist
• UNAUTHORIZED_JOB: Job doesn’t belong to your space
• GENERATION_FAILED: General generation failure
• SCRIPT_GENERATION_FAILED: Failed to generate script from prompt
• VOICE_GENERATION_FAILED: Voice processing failed
• AVATAR_PROCESSING_FAILED: Avatar preparation failed
• MEDIA_PROCESSING_FAILED: Media file processing failed
• ASSEMBLY_FAILED: Final video assembly failed