Retrieve File
Retrieves a file you uploaded — poll it after uploading the bytes to see upload_status become ready. Only the creator can retrieve a file this way; a file attached to another resource is read through that resource.
Authorizations
An Account API key, an App API key, an account access token, an account-scoped user token, or a user OAuth token. Prepend the key or token with Bearer, for example Bearer ***************************. See Auth & API keys for how to get each one.
Headers
Pins the request to a dated API version.
"2026-10-24"
Path Parameters
The unique identifier of the file, prefixed file_.
Response
file retrieved
BlurHash placeholder for an image or video. Null when unavailable or removed by moderation.
null
The original file's MIME type, preserved when removed by moderation, e.g. application/pdf.
"application/pdf"
When the file was created, as an ISO 8601 timestamp.
"2026-01-01T12:00:00.000Z"
Audio or video duration in seconds. Null when unavailable or removed by moderation.
null
The original filename, including its extension.
"evidence.pdf"
Image or video height in pixels. Null when unavailable or removed by moderation.
null
The file's ID, prefixed file_.
"file_xxxxxxxxxxxxxx"
The type of this object, always file.
"file"
Whether moderation removed the file. When true, url serves a replacement image; filename, size, and content type still describe the original file.
false
The file size in bytes. null until the upload has finished.
9670
Where the file is in its upload lifecycle.
pending, processing, ready, failed "pending"
A URL to download the file: a permanent CDN URL for public files, a signed expiring URL for private ones. Null until the upload has finished; a replacement image URL when removed by moderation.
"https://whop-assets-example.s3.amazonaws.com/uploads/audio/2026-01-01/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
public files are served via an unsigned CDN URL; private files via a signed, expiring URL.
public, private "private"
Audio waveform URL. Null when unavailable or removed by moderation.
null
Image or video width in pixels. Null when unavailable or removed by moderation.
null
The byte size each part (except the last) must be. Present only on create, and only for multipart uploads.
5242880
The ID of the multipart upload, passed back to complete. Present only on create, and only for multipart uploads.
"upload-id"
Headers to send with the upload PUT. Present only on create.
Presigned URL to PUT the file's bytes to. Present only on create, and only for single-part uploads.
"https://whop-assets-example.s3.amazonaws.com/uploads/2026-01-01/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/application.pdf"

