Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.whop.com/llms.txt

Use this file to discover all available pages before exploring further.

A file that has been uploaded or is pending upload.

​
id
string
required

The unique identifier for the file.

Example:

"file_xxxxxxxxxxxxx"

​
upload_status
enum<string>
required

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

Available options:
pending,
processing,
ready,
failed
​
filename
string | null
required

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

Example:

"document.pdf"

​
content_type
string | null
required

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

Example:

"image/jpeg"

​
size
string | null
required

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

Example:

"123.45"

​
url
string | null
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
enum<string>
required

Whether the file is publicly accessible or requires authentication.

Available options:
public,
private