Analyzed video

GET & POST requests to receive a link to an analyzed video

Retrieve Analyzed Video URL

get

Retrieves the analyzed video URL for a specific session, or attempts to create it if it does not exist.

Path Parameter

• session_id (string, required): The unique identifier of the session.

Query Parameters

These optional flags determine which kind of analysis to perform if the video doesn't exist:

• is_jump (boolean, optional): Indicates whether this session is for jump analysis.

• is_weight (boolean, optional): Indicates whether this session is for weightlifting analysis.

• download (boolean, optional): If true, returns a signed URL that forces the browser to download the video instead of displaying it.

Response (HTTP 200)

Returns a JSON object with an analyzed_video_url key if successful:

{
  "analyzed_video_url": "https://storage.googleapis.com/.../analyzed_video.mp4"
}

Error Handling

• 400 Bad Request: Invalid parameters (e.g., missing or invalid admin UID).

• 401 Unauthorized: Token is missing or invalid.

• 403 Forbidden: The user does not have the right privileges or plan.

• 404 Not Found: The session data or resources could not be found.

• 500 Internal Server Error: An unexpected error occurred on the server.

Security

A valid API-KEY token must be provided in the Authorization header.

Authorizations

BearerApiKeyAuth

AuthorizationstringRequired

Enter your bearer token (Firebase auth) in the format: Bearer

Path parameters

session_idanyRequired

Query parameters

is_jumpbooleanOptional

Indicates whether this session is for jump analysis.

is_weightbooleanOptional

Indicates whether this session is for weightlifting analysis.

downloadbooleanOptional

If true, returns a signed URL that forces download of the video.

Responses

200

Analyzed video URL retrieved successfully.

application/json

400

Bad Request - Possibly invalid parameters.

application/json

401

Unauthorized - Token is invalid or missing.

application/json

403

Forbidden - User lacks privileges or plan.

application/json

404

Not Found - Session data or resource not found.

application/json

500

Internal Server Error - A server-side error occurred.

application/json

get

/session-management/sessions/{session_id}/analyzed-video/

HTTPcURLJavaScriptPython

GET /session-management/sessions/{session_id}/analyzed-video/ HTTP/1.1
Host: api.aikynetix.app
Authorization: YOUR_API_KEY
Accept: */*

{
  "analyzed_video_url": "https://example.com"
}

Upload/Generate Analyzed Video

post

Uploads or generates an analyzed video for a specific session, returning its URL.

Path Parameter

• session_id (string, required): The unique identifier of the session.

Request Body (JSON)

{
  "is_jump": true,
  "is_weight": false
}

• is_jump (boolean, optional): If true, treat this as a jump session.

• is_weight (boolean, optional): If true, treat this as a weightlifting session.

Response Structure (HTTP 200)

On success, returns a JSON object with the analyzed_video_url:

{
  "analyzed_video_url": "https://storage.googleapis.com/.../analyzed_video.mp4"
}

Error Handling

• 400 Bad Request: Invalid parameters or session already analyzed.

• 401 Unauthorized: Token is missing or invalid.

• 403 Forbidden: The user does not have a valid plan.

• 404 Not Found: Session data not found.

• 500 Internal Server Error: An unexpected error occurred on the server.

Security

A valid API-KEY token must be provided in the Authorization header.

Authorizations

BearerApiKeyAuth

AuthorizationstringRequired

Enter your bearer token (Firebase auth) in the format: Bearer

Path parameters

session_idanyRequired

Body

application/json

is_jumpbooleanOptional

Whether this session is jump-related.

is_weightbooleanOptional

Whether this session is weightlifting-related.

Responses

200

Analyzed video URL generated or updated successfully.

application/json

400

Bad Request - Possibly invalid session data or video already analyzed.

application/json

401

Unauthorized - The token is missing or invalid.

application/json

403

Forbidden - The user does not have a valid payment plan.

application/json

404

Not Found - Session not found or creation failed.

application/json

500

Internal Server Error - A server-side error occurred.

application/json

post

/session-management/sessions/{session_id}/analyzed-video/

HTTPcURLJavaScriptPython

POST /session-management/sessions/{session_id}/analyzed-video/ HTTP/1.1
Host: api.aikynetix.app
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 34

{
  "is_jump": true,
  "is_weight": false
}

{
  "analyzed_video_url": "https://example.com"
}