v8

OpenAPI 3.1.02026-08-033623795.0 MB

Files

Retrieve file

Retrieves the details of an existing file.

get/files/{id}

Path parameters

idstring required

Example:file_xxxxxxxxxxxxx

The unique identifier of the file to retrieve.

Response

A successful response

content_typestring nullable required

The MIME type of the uploaded file (e.g., image/jpeg, video/mp4, audio/mpeg).

filenamestring nullable required

The original filename of the uploaded file, including its file extension.

idstring required

The unique identifier for the file.

sizestring nullable required

The file size in bytes. Null if the file has not finished uploading.

upload_status'pending' | 'processing' | 'ready' | 'failed' required

The upload status of a file

urlstring nullable required

The URL for accessing the file. For public files, this is a permanent CDN URL. For private files, this is a signed URL that expires. Null if the file has not finished uploading.

visibility'public' | 'private' required

Controls whether an uploaded file is publicly accessible or requires authentication to access.

Example response

{
  "content_type": "image/jpeg",
  "filename": "document.pdf",
  "id": "file_xxxxxxxxxxxxx",
  "size": "123.45"
}