Task Status
Retrieve the status of a specific task by its ID.
The Get Task Status endpoint allows you to check the current status of a task, such as content indexing or processing. This is particularly useful for long-running operations like video processing, where you might need to poll the status periodically to determine when the task is complete.
Request
The unique identifier of the task
Response
The ID of the file associated with the task
The unique identifier of the task
The current status of the task
Task Status Meanings
The status field can have one of the following values:
| Status | Meaning |
|---|---|
| INITIALIZING | The task has been created and is in the initial setup phase. |
| PROCESSING | The task is actively being worked on. |
| DONE | The task has completed successfully. |
| FAILED | The task encountered an error and could not be completed. |
Why Poll for Status?
Polling the task status is essential for operations that may take a significant amount of time to complete, such as:
- Video processing and indexing
- Large file uploads
- Complex data analysis tasks
- Batch operations on multiple items
By periodically checking the task status, you can:
- Provide progress updates to your users
- Trigger subsequent actions once a task is complete
- Handle errors or failures gracefully
- Manage resources efficiently by knowing when a task is finished
Remember to implement appropriate polling intervals and error handling in your application when using this endpoint.
Was this page helpful?