v25

latestOpenAPI 3.1.0raw.githubusercontent.com2025-11-204973358.2 KB

Files

Get File Status

Check processing status for a file. Use this to poll video processing progress.

Args: file_uuid (str): UUID of the file to check status for.

Returns: FileStatusResponse: Contains: - processing_status: "pending", "processing", "completed", or "failed" - error_message: If status is "failed", contains error details - remote_file_path: Available when status is "completed"

Use this endpoint to poll until processing_status == "completed" before calling GET /files/{file_uuid}/frames for video files.

Example: GET /api/v2/files/{file_uuid}/status

get/v2/files/{file_uuid}/status

Path parameters

file_uuidstring required

Response

file_uuidstring required

Unique identifier for the file.

processing_statusstring required

Current processing status: pending, processing, completed, or failed.

error_messagestring nullable

Error message if processing failed.

remote_file_pathstring nullable

S3 path to the file (available when completed).

created_atstring date-time required

Timestamp when the file was created.

updated_atstring date-time required

Timestamp when the file was last updated.