Skip to main content
POST
/
files
JavaScript
import Whop from '@whop/sdk';

const client = new Whop({
  apiKey: process.env['WHOP_API_KEY'], // This is the default and can be omitted
});

const file = await client.files.create({ filename: 'filename' });

console.log(file.id);
{
  "id": "file_xxxxxxxxxxxxx",
  "filename": "document.pdf",
  "content_type": "image/jpeg",
  "size": "123.45",
  "url": "<string>",
  "upload_url": "https://media.whop.com/uploads/presigned",
  "upload_headers": {}
}

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.

Authorizations

​
Authorization
string
header
required

A company API key, company scoped JWT, app API key, or user OAuth token. You must prepend your key/token with the word 'Bearer', which will look like Bearer ***************************

Body

application/json

Parameters for CreateFile

​
filename
string
required

The name of the file including its extension (e.g., "photo.png" or "document.pdf").

​
visibility
enum<string> | null

Controls whether the file is publicly accessible via CDN or requires authentication. Defaults to public.

Available options:
public,
private

Response

A successful response

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

The presigned URL to upload the file contents to. Only present in the response from the create mutation.

Example:

"https://media.whop.com/uploads/presigned"

​
upload_headers
object
required

Headers to include in the upload request. Only present in the response from the create mutation.