Skip to main content
GET
Get Highlights Task

GET /api/v1/sports/highlights/

Poll the status of a highlight generation task and retrieve results when complete.

Path Parameters

Response

Example Request

Example Response (Processing)

Example Response (Completed)

Example Response (Failed)

Result Fields

Polling Strategy

Highlight generation typically takes 5-10 minutes for a 2-hour video. Recommended polling intervals:
  • First 2 minutes: every 10 seconds
  • After 2 minutes: every 30 seconds
  • After 10 minutes: every 60 seconds

Notes

  • Processing time varies based on video length
  • Output video URL is valid for 24 hours
  • Typical reduction: ~85% (2 hours → 15 minutes of highlights)

Path Parameters

task_id
string
required

The task ID returned from the create request

Response

Task status retrieved

task_id
string
required

Task identifier

Example:

"task_abc123xyz"

status
enum<string>
required

Current task status

Available options:
pending,
processing,
completed,
failed
Example:

"completed"

progress
integer
required

Progress percentage (0-100)

Required range: 0 <= x <= 100
Example:

100

created_at
string<date-time>
required

When the task was created

completed_at
string<date-time>

When the task completed (if finished)

result
object
error
object