Create Capture

Create Capture in Organization

curl --request POST \
  --url https://api.uplift.ai/v1/captures \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "athlete_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "session_group_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "camera_configuration": {},
  "movement_attributes": {
    "activity": "<string>",
    "movement": "<string>"
  },
  "file_name": "<string>",
  "capture_time": "2023-11-07T05:31:56Z"
}
'

import requests

url = "https://api.uplift.ai/v1/captures"

payload = {
    "athlete_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "session_group_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "camera_configuration": {},
    "movement_attributes": {
        "activity": "<string>",
        "movement": "<string>"
    },
    "file_name": "<string>",
    "capture_time": "2023-11-07T05:31:56Z"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    athlete_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    session_group_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    camera_configuration: {},
    movement_attributes: {activity: '<string>', movement: '<string>'},
    file_name: '<string>',
    capture_time: '2023-11-07T05:31:56Z'
  })
};

fetch('https://api.uplift.ai/v1/captures', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.uplift.ai/v1/captures",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'athlete_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    'session_group_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    'camera_configuration' => [
        
    ],
    'movement_attributes' => [
        'activity' => '<string>',
        'movement' => '<string>'
    ],
    'file_name' => '<string>',
    'capture_time' => '2023-11-07T05:31:56Z'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.uplift.ai/v1/captures"

	payload := strings.NewReader("{\n  \"athlete_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"session_group_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"camera_configuration\": {},\n  \"movement_attributes\": {\n    \"activity\": \"<string>\",\n    \"movement\": \"<string>\"\n  },\n  \"file_name\": \"<string>\",\n  \"capture_time\": \"2023-11-07T05:31:56Z\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.uplift.ai/v1/captures")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"athlete_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"session_group_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"camera_configuration\": {},\n  \"movement_attributes\": {\n    \"activity\": \"<string>\",\n    \"movement\": \"<string>\"\n  },\n  \"file_name\": \"<string>\",\n  \"capture_time\": \"2023-11-07T05:31:56Z\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.uplift.ai/v1/captures")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"athlete_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"session_group_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"camera_configuration\": {},\n  \"movement_attributes\": {\n    \"activity\": \"<string>\",\n    \"movement\": \"<string>\"\n  },\n  \"file_name\": \"<string>\",\n  \"capture_time\": \"2023-11-07T05:31:56Z\"\n}"

response = http.request(request)
puts response.read_body

{
  "session_id": "<string>",
  "session_group_id": "<string>",
  "upload_url": "<string>",
  "upload_fields": {},
  "upload_expires_at": "2023-11-07T05:31:56Z",
  "status": "NEW"
}

POST

captures

Create Capture in Organization

curl --request POST \
  --url https://api.uplift.ai/v1/captures \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "athlete_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "session_group_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "camera_configuration": {},
  "movement_attributes": {
    "activity": "<string>",
    "movement": "<string>"
  },
  "file_name": "<string>",
  "capture_time": "2023-11-07T05:31:56Z"
}
'

import requests

url = "https://api.uplift.ai/v1/captures"

payload = {
    "athlete_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "session_group_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "camera_configuration": {},
    "movement_attributes": {
        "activity": "<string>",
        "movement": "<string>"
    },
    "file_name": "<string>",
    "capture_time": "2023-11-07T05:31:56Z"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    athlete_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    session_group_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    camera_configuration: {},
    movement_attributes: {activity: '<string>', movement: '<string>'},
    file_name: '<string>',
    capture_time: '2023-11-07T05:31:56Z'
  })
};

fetch('https://api.uplift.ai/v1/captures', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.uplift.ai/v1/captures",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'athlete_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    'session_group_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    'camera_configuration' => [
        
    ],
    'movement_attributes' => [
        'activity' => '<string>',
        'movement' => '<string>'
    ],
    'file_name' => '<string>',
    'capture_time' => '2023-11-07T05:31:56Z'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.uplift.ai/v1/captures"

	payload := strings.NewReader("{\n  \"athlete_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"session_group_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"camera_configuration\": {},\n  \"movement_attributes\": {\n    \"activity\": \"<string>\",\n    \"movement\": \"<string>\"\n  },\n  \"file_name\": \"<string>\",\n  \"capture_time\": \"2023-11-07T05:31:56Z\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.uplift.ai/v1/captures")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"athlete_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"session_group_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"camera_configuration\": {},\n  \"movement_attributes\": {\n    \"activity\": \"<string>\",\n    \"movement\": \"<string>\"\n  },\n  \"file_name\": \"<string>\",\n  \"capture_time\": \"2023-11-07T05:31:56Z\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.uplift.ai/v1/captures")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"athlete_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"session_group_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"camera_configuration\": {},\n  \"movement_attributes\": {\n    \"activity\": \"<string>\",\n    \"movement\": \"<string>\"\n  },\n  \"file_name\": \"<string>\",\n  \"capture_time\": \"2023-11-07T05:31:56Z\"\n}"

response = http.request(request)
puts response.read_body

{
  "session_id": "<string>",
  "session_group_id": "<string>",
  "upload_url": "<string>",
  "upload_fields": {},
  "upload_expires_at": "2023-11-07T05:31:56Z",
  "status": "NEW"
}

Capture creation is an Enterprise feature. Upload video directly through the API to run it through Uplift’s movement analysis pipeline. Contact Sales to enable it for your organization.

Example Request Body

{
  "athlete_id": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee",
  "session_group_id": "11111111-2222-3333-4444-555555555555",
  "file_name": "swing-001.mov",
  "capture_time": "2026-05-13T12:00:00.000Z",
  "camera_configuration": {
    "camera_setup_selection": "single.down_the_line",
    "camera_orientation": "landscape"
  },
  "movement_attributes": {
    "activity": "golf",
    "movement": "full_swing"
  }
}

Movement dimensions

Optional movement dimension keys for each activity / movement pair can be included in movement_attributes. Valid values are validated by the API.

Activity	Movement	Dimensions
`agility`	`cutting`	`direction`
`baseball`	`hitting`	`bat_length`, `handedness`
`baseball`	`pitching`	`handedness`
`basketball`	`free_throw`	`handedness`
`basketball`	`jump_shot`	`handedness`
`basketball`	`layup`	`handedness`
`golf`	`swing`	`handedness`
`jump`	`broad`	`arm_position`
`jump`	`countermovement`	`arm_position`
`jump`	`drop_vertical`	`arm_position`
`jump`	`single_leg`	`arm_position`, `footedness`
`jump`	`single_leg_broad`	`arm_position`, `footedness`
`jump`	`squat`	`arm_position`
`lunge`	`forward`	`footedness`
`lunge`	`side`	`footedness`
`range_of_motion`	`ankle_flexion`	`body_position`, `footedness`
`range_of_motion`	`cervical_rotation`	`direction`
`range_of_motion`	`sfma_shoulder_extension`	`handedness`
`range_of_motion`	`sfma_shoulder_flexion`	`handedness`
`range_of_motion`	`shoulder_9090`	`handedness`
`range_of_motion`	`shoulder_flexion`	`handedness`
`range_of_motion`	`t_spine_rotation`	`handedness`
`softball`	`hitting`	`bat_length`, `handedness`
`softball`	`pitching`	`handedness`
`squat`	`single_leg`	`footedness`
`stability`	`plank`	`plank_orientation`, `plank_position`
`stability`	`rotary`	`handedness`
`stability`	`single_leg_stance`	`eyes`, `footedness`
`stability`	`y_balance_lower_quarter`	`footedness`, `y_balance_lower_quarter_direction`
`stability`	`y_balance_upper_quarter`	`handedness`, `y_balance_upper_quarter_direction`
`tennis`	`backhand`	`handedness`
`tennis`	`forehand`	`handedness`
`tennis`	`overhand_serve`	`handedness`, `overhand_serve_type`
`tennis`	`underhand_serve`	`handedness`
`track_and_field`	`discus`	`handedness`
`track_and_field`	`shot_put`	`handedness`

Pairs with no published movement dimensions (for example gait/walking, squat/body_weight) accept only activity and movement in movement_attributes.

Authorizations

Authorization

string

header

required

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

Body

application/json

athlete_id

string<uuid>

required

UUID of an athlete that belongs to the same organization as the API key. Returns 400 with athlete_id not found when the athlete is missing or not in your organization.

session_group_id

string<uuid>

required

Identifies the capture group. If the group already exists, it must belong to the same organization and athlete.

camera_configuration

object

required

Additional keys are allowed and stored with the capture configuration.

Show child attributes

movement_attributes

object

required

Activity and movement labels plus optional movement dimension keys for that pair. Validated against the published catalog. See Movement dimensions for the per activity/movement field catalog.

Show child attributes

file_name

string

required

Video file name; must not contain / or \\. Must use a .mov or .mp4 extension (case-insensitive). If omitted or blank, the request fails with 400.

Maximum string length: 255

capture_time

string<date-time>

ISO 8601 capture time; must not be in the future. Defaults to current server time if omitted.

Response

Reservation succeeded. POST the file to upload_url with all upload_fields before upload_expires_at.

session_id

string

Capture identifier assigned for this reservation.

session_group_id

string

Echo of the request session_group_id.

upload_url

string

S3 endpoint URL for multipart/form-data POST.

upload_fields

object

Form fields that must be included in the POST body exactly as returned (policy, signature, key, Content-Type, etc.).

upload_expires_at

string<date-time>

When the pre-signed POST is no longer valid (30 minutes after issuance).

status

enum<string>

Literal NEW while the capture awaits upload.

Available options:

NEW

API Documentation

Data Export

Captures

Athletes

Create Capture

Example Request Body

Movement dimensions

Authorizations

Body

Response

​Example Request Body

​Movement dimensions

Authorizations

Body

Response

Example Request Body

Movement dimensions