Skip to main content
POST
Submit a video
Send the file as multipart/form-data, in a field named video. Growi reads the duration from the file itself, so a video whose duration can’t be read is refused with 422 video_duration_unreadable. Export it again as a standard (not fragmented) MP4 or MOV and retry.
Send an Idempotency-Key so a retry after a timeout can’t start a second analysis. See idempotency.

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

Idempotency-Key
string

Optional, up to 255 characters. Sending the same key again returns the original analysis, with the Idempotent-Replayed: true header, instead of starting another. Keys are scoped to the user who created the API key.

Body

multipart/form-data
video
file
required

The video file, MP4 or MOV, at most 200 MB and 3 minutes long

notify
string

Who to notify when the analysis finishes, as JSON: {"channels": ["email", "slack", "discord"]}, any of the three. Leave it out to follow your AI media analysis notification settings. Your organization's webhooks always get the events, except for submission_interrupted failures from uploads that never complete

external_id
string

Your own reference, up to 255 characters. Returned with the analysis and in its webhook events

Response

Accepted. The analysis is queued. Also the answer to a repeated Idempotency-Key, with the Idempotent-Replayed: true header and that analysis's current status. While it's unfinished, the repeat carries the same live status and estimate as GET /video_analyses/{id}; the estimate is null only when there's none right now or the start isn't confirmed yet

data
object
required