Skip to main content
GET
/
files
/
{id}
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.retrieve('file_xxxxxxxxxxxxx');

console.log(file.id);
{
  "id": "file_xxxxxxxxxxxxx",
  "upload_status": "pending",
  "filename": "<string>",
  "content_type": "<string>",
  "size": "123.45",
  "url": "<string>"
}

Authorizations

​
Authorization
string
header
required

The app API key from an app from the /dashboard/developer page

Path Parameters

​
id
string
required

The ID of the file (e.g., file_xxxxx)

Example:

"file_xxxxxxxxxxxxx"

Response

A successful response

A file that has been uploaded or is pending upload

​
id
string
required

The ID of the file

Example:

"file_xxxxxxxxxxxxx"

​
upload_status
enum<string>
required

The upload status of the file

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

The name of the file

​
content_type
string | null
required

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

​
size
string | null
required

The size of the file in bytes

Example:

"123.45"

​
url
string | null
required

The URL to access the file