latestOpenAPI 3.1.02026-08-1711292200.6 KB

64853d21435b

Jobs

Submit Job

Submit a new video processing job.

When VIDEO_ENDPOINTS_LIVE is False, returns a preview response without any processing.

post/api/v1/jobs

Headers

x-api-keystring nullable

Leaguestring nullable

Request body

video_urlstring required

Single video URL (.mp4 or downloadable HTTP(S) source)

game_idstring uuid nullable

Optional. The game_id of an existing scheduled game to attach this video to. When provided, the uploaded video is linked to that game so the resulting stats appear under the same game. Returns 409 if the game already has a video uploaded. Omit to upload a standalone video with no schedule linkage.

home_team_namestring

Home team name

away_team_namestring

Away team name

home_team_colorstring required

Home team jersey color (hex, e.g. '#FF0000')

away_team_colorstring required

Away team jersey color (hex, e.g. '#0000FF')

game_datestring date-time nullable

Game date (ISO 8601 timestamp). Defaults to current time if omitted.

video_mode'instant' | 'accuracy'

Processing mode for the uploaded video. Use 'instant' for faster turnaround, or 'accuracy' for higher-quality results. Defaults to 'instant' when omitted. Only applicable to organizations that have been enabled for mode selection; otherwise the value is ignored.

Response

Successful Response

job_idstring required

statusstring required