v25

latestOpenAPI 3.1.0raw.githubusercontent.com2025-11-204973358.2 KB
Files

Get File Frames

Get download URLs for all extracted frames from a video file.

Only available for video files after processing completes. Check processing status with GET /files/{file_uuid}/status first.

Args: file_uuid (str): UUID of the video file.

Returns: FileFramesResponse: Contains: - frame_urls: List of URLs to access each frame (sorted by frame number) - frame_count: Total number of frames available

Each frame URL is valid for 30 minutes. Use these URLs to download or display
individual video frames for analysis.

Raises: AymaraAPIError: - If file is not a video (use file_type field to check) - If processing not complete (check processing_status first)

Example: GET /api/v2/files/{file_uuid}/frames

get/v2/files/{file_uuid}/frames

Path parameters

file_uuidstring required

Response

OK

file_uuidstring required

Unique identifier for the file.

frame_urlsstring[] required

List of presigned URLs to video frames, sorted by frame number.

frame_countinteger required

Total number of frames available.