Skip to main content
POST
Start analysis

Authorizations

Authorization
string
header
required

Recommended. Pass your API key as a Bearer token in the Authorization header: Authorization: Bearer YOUR_API_KEY.

Body

multipart/form-data
video
file
required

Video file to analyze (max 30 MB, 10 seconds).

analysis_type
enum<string>
default:side_view
required

Type of analysis to perform.

Available options:
side_view,
back_view
Example:

"side_view"

subject_id
string

Optional subject ID to link this analysis to. See subject management to create subjects.

height
number
default:1.7

Runner height in meters.

Example:

1.75

weight
number
default:70

Runner weight in kilograms.

Example:

68

pace
string

Running pace in MM:SS format. Required when treadmill=true. Optional when treadmill=false (pace is calculated automatically for overground running).

Pattern: ^[0-9]{2}:[0-9]{2}$
Example:

"05:30"

language
enum<string>
default:en

Language for analysis results and recommendations.

Available options:
en,
fr,
de,
zh,
ko,
pt,
es,
it,
ja
Example:

"en"

treadmill
boolean
default:false

Whether the runner is on a treadmill (true) or running outdoors (false).

Example:

false

notify_via_webhook
boolean
default:false

When true, send progress and completion events for this analysis to the partner webhook URL configured via PUT /webhook. Requires a valid, enabled webhook. When false or omitted, no webhook events are sent for this analysis.

Example:

false

Response

Analysis started.

message
string
Example:

"Analysis started for ID: 3dde3402-94d7-462e-a784-9306207108dd"

video_id
string

Unique identifier for the analysis. Use this to poll for results.

Example:

"3dde3402-94d7-462e-a784-9306207108dd"