Jobs

Submit Job

Changed on

Submit a new video processing job.

Processing is controlled by the customer's Admin settings: use_model starts PBP, include_player_bboxes starts tracking. The enable_scoreboard_clock setting adds quarter/game-clock reading to PBP when use_model is enabled. The enable_court_event_location setting adds shot location to PBP; enable_lineup adds an analyst-only lineup draft. These switches apply to internal test leagues too; missing settings keep all extra stages off. All settings default to off. PBP and tracking are independent. Clients do not select these flags in the request body. Bbox results are released only after the video's raw status is '4'.

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

post/api/v1/jobs

Request

  • Base URL
    https://developer.preciser.io
  • URL
    https://developer.preciser.io/api/v1/jobs
  • Auth
    none declared. Required headers: x-api-key, League

Headers

x-api-keystring required

Required API key issued by Preciser.

Leaguestring required

Required tenant/database selector, for example pitchbio-master.

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 'accuracy' 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
messagestring nullable

Submission guidance when processing acceptance needs verification.

Changes