Skip to main content
GET
Get Story Status
Track the progression of your story creation process through systematic status checks. This endpoint provides granular visibility into each processing stage, enabling precise workflow management for time-sensitive applications. This endpoint works in conjunction with the main /story endpoint, which initiates the dubbing process and provides the task_id needed for status checks.

Checking Your Story Status

Let’s explore how to effectively monitor your generation task using Python:

Best Practices for Status Monitoring

To efficiently track your dubbing tasks, consider these professional recommendations:
  1. Implement Exponential Backoff: Start with frequent checks that gradually increase in interval to avoid overloading the API.
  2. Handle Terminal States: Always implement proper handling for both successful completion and failure cases.
By properly integrating status checking into your application, you can create a seamless dubbing experience that keeps your users informed throughout the entire process.

Authorizations

x-api-key
string
header
required

The x-api-key is a custom header required for authenticating requests to our API. Include this header in your request with the appropriate API key value to securely access our endpoints. You can find your API key(s) in the 'API' section of our studio website.

Path Parameters

task_id
string
required

A unique identifier for the task. This is used to query the status of the story task that is running. It is returned when a create request is made for a story.

Response

Successful Response

status
enum<string>
Available options:
SUCCESS,
PENDING,
TIMEOUT,
ERROR,
PAYMENT_REQUIRED
run_id
integer | null