Skip to main content
GET
/
captures
List captures
curl --request GET \
  --url https://api.uplift.ai/v1/captures \
  --header 'Authorization: Bearer <token>'
{
  "captures": [
    {
      "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
    }
  ],
  "total_count": 123,
  "offset": 123,
  "limit": 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.

​
Query parameters

All query parameters are optional. See the operation above for types and constraints.
ParameterPurpose
athlete_idUUID; restrict to sessions for that athlete in your organization.
sourceWhen set to api, only sessions with configdata.source equal to api are returned.
statusOne of awaiting_upload, processing, completed, error (mapped from session analysis_status).
activityCase-insensitive match on presets activity (trimmed and lowercased).
movementCase-insensitive match on presets movement (trimmed and lowercased).
limitPage size; default 100, clamped to 1–500.
offsetRows to skip; default 0.
Successful 200 responses include captures (array of Capture), total_count, offset, and limit as documented in the OpenAPI response schema.

Authorizations

​
Authorization
string
header
required

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

Query Parameters

​
athlete_id
string<uuid>

Restrict to sessions for this athlete. Must exist in the organization.

​
source
enum<string>

When api, only sessions whose configdata.source equals api are returned.

Available options:
api
​
status
enum<string>

Filter by API capture status (mapped from session analysis_status).

Available options:
awaiting_upload,
processing,
completed,
error
​
activity
string

Case-insensitive match on presets activity (trimmed and lowercased).

Maximum string length: 128
​
movement
string

Case-insensitive match on presets movement (trimmed and lowercased).

Maximum string length: 128
​
limit
integer
default:100

Page size; default 100, clamped to 1–500.

Required range: 1 <= x <= 500
​
offset
integer
default:0

Rows to skip; default 0.

Required range: x >= 0

Response

Page of captures matching filters.

​
captures
object[]
​
total_count
integer

Total rows matching filters (not just this page).

​
offset
integer

Effective offset after clamping.

​
limit
integer

Effective page size after clamping.