Skip to main content
GET
/
captures
/
{captureId}
Get capture
curl --request GET \
  --url https://api.uplift.ai/v1/captures/{captureId} \
  --header 'Authorization: Bearer <token>'
{
  "session_id": "<string>",
  "athlete_id": "<string>",
  "activity": "<string>",
  "movement": "<string>",
  "status": "awaiting_upload",
  "error": "<string>",
  "capture_time": "2023-11-07T05:31:56Z",
  "fps_detected": 123
}

Documentation Index

Fetch the complete documentation index at: https://docs.uplift.ai/llms.txt

Use this file to discover all available pages before exploring further.

​
Path parameter

captureId is the session entity id (sessions.entity_id). The capture must belong to your organization and not be soft-deleted.

Authorizations

​
Authorization
string
header
required

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

Path Parameters

​
captureId
string
required

Session entity id (sessions.entity_id); trimmed string 1–255 characters.

Required string length: 1 - 255

Response

Single capture object.

Capture (session) record. Published movement dimension fields may appear as additional top-level properties.

​
session_id
string

Session entity id.

​
athlete_id
string | null

Athlete id when linked via athletes_sessions.

​
activity
string | null

From presets.activity.

​
movement
string | null

From presets.movement.

​
status
enum<string>

API status derived from session analysis_status.

Available options:
awaiting_upload,
processing,
completed,
error
​
error
string | null

Error or QA failure summary when applicable.

​
capture_time
string<date-time> | null

ISO 8601 from created_at when present.

​
fps_detected
number | null

From session metadata (e.g. primary_frameRate or frameRate) when available.