Skip to main content
GET
Retrieve file
This page documents the Legacy API. For new integrations, use Retrieve File in the Current API.

Autorisations

Authorization
string
header
requis

An Account API key, account-scoped JWT, App API key, or user OAuth token. Prepend the key or token with Bearer, for example Bearer ***************************.

Paramètres de chemin

id
string
requis

The unique identifier of the file to retrieve.

Exemple:

"file_xxxxxxxxxxxxx"

Réponse

A successful response

A file that has been uploaded or is pending upload.

content_type
string | null
requis

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

Exemple:

"image/jpeg"

filename
string | null
requis

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

Exemple:

"document.pdf"

id
string
requis

The unique identifier for the file.

Exemple:

"file_xxxxxxxxxxxxx"

size
string | null
requis

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

Exemple:

"123.45"

upload_status
enum<string>
requis

The current upload status of the file (e.g., pending, ready).

Options disponibles:
pending,
processing,
ready,
failed
url
string | null
requis

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
enum<string>
requis

Whether the file is publicly accessible or requires authentication.

Options disponibles:
public,
private