v25

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

Files

Get File

Retrieve file metadata and access URL.

Args: file_uuid (str): UUID of the file to retrieve.

Returns: FileDetail: File metadata including: - file_url: Use this URL to download/view the file (valid for 30 minutes) - file_type: "image", "video", "text", or "document" - processing_status: For videos, check if "completed" before accessing frames - video_metadata: Contains frame_count and other video-specific info

Note: For videos, use GET /files/{file_uuid}/frames to access individual frames.

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

get/v2/files/{file_uuid}

Path parameters

file_uuidstring required

Response

file_uuidstring required

Unique identifier for the file.

organization_uuidstring required

UUID of the organization that owns this file.

workspace_uuidstring nullable

UUID of the workspace this file belongs to, if any.

remote_file_pathstring required

S3 path to the file (or directory for videos).

content_typestring required

MIME type of the file.

file_typestring required

Type of file content (text, image, video, document).

file_size_bytesinteger nullable

Size of file in bytes, if known.

original_file_urlstring nullable

Original file URL or path from upload.

uploaded_by_uuidstring nullable

UUID of user who uploaded the file.

video_metadataobject nullable

Video metadata (fps, duration, etc.) for video files.

file_urlstring nullable

Presigned URL to access the file. For videos, points to raw video file. Use GET /api/v2/files/{file_uuid}/frames to get frame URLs. May be null in list responses for performance.

created_atstring date-time required

Timestamp when the file was created.

updated_atstring date-time required

Timestamp when the file was last updated.