Vortex

Ingest a scouting video from a URL

Pulls a video from the provided presigned URL, stores it on the video bucket, creates the Video record and queues the MediaConvert transcode. Returns as soon as the transcode is queued, so job_status is null in this response — a scheduled sweep checks the transcode every minute and records PROGRESSING, then COMPLETE together with output_url and thumbnail_url, or ERROR or CANCELED, as MediaConvert reports them. A job_status of ERROR means MediaConvert refused the job; the Video id is still valid. The returned id can be attached to a scouting session via media_type=video on POST /api/vortex/user-event-uploads. Repeating the call for the same source object returns the existing record instead of ingesting it twice. Callers must allow at least 300 seconds for this request: the 120 second budget bounds the download alone, and the mediainfo probe, the copy of up to 500 MB to S3, the checksum and the insert all follow it unbounded. Callers must also generate the presigned URL at call time rather than in advance, and send a URL whose path ends with the file extension. Authenticated via X-API-Key.

post/api/vortex/upload-video-from-url

Request

Request body

urlstring url required

A presigned S3 GET URL for the video. The path must end with the file extension (mp4, mov, m4v, mpg or qt); the extension is what names the stored object and makes repeated calls for the same clip idempotent.

Example request

{
  "url": "https://bucket.s3.amazonaws.com/sessions/abc/clip.mp4?X-Amz-Signature=..."
}

Response

Video ingested and transcode queued

idinteger
original_namestring
stored_namestring
hash_codestring nullable
input_urlstring
output_urlstring nullable

HLS playlist URL. Null until job_status is COMPLETE, and stays null when the transcode fails (job_status ERROR or CANCELED).

thumbnail_urlstring nullable

Poster image URL. Null until job_status is COMPLETE, and stays null when the transcode fails (job_status ERROR or CANCELED).

widthinteger
heightinteger
durationinteger
original_file_sizeinteger
job_idstring nullable
job_status'SUBMITTED' | 'PROGRESSING' | 'COMPLETE' | 'CANCELED' | 'ERROR' nullable

MediaConvert transcode status. Pending: null (job queued, no status reported yet), SUBMITTED or PROGRESSING; output_url and thumbnail_url are null. Complete: COMPLETE; output_url and thumbnail_url are set. Failed: ERROR (MediaConvert rejected or failed the job) or CANCELED; output_url and thumbnail_url stay null permanently.

created_atstring date-time
updated_atstring date-time
deleted_atstring date-time nullable
media_typestring

Changes

No recorded changes to this operation across all 2 revisions of this API.