Skip to main content
POST
Prepare file upload(s)

Authorizations

x-api-key
string
header
required

WorkOS API key for authentication

Body

application/json
file_name
string

Optional file name. If not provided, a random UUID will be used.

Required string length: 1 - 255
Example:

"my-file.pdf"

Example:

Response

Upload preparation successful

key
string
required

File key/path in storage

Example:

"org-id/filename.pdf"

signed_url
string<uri>
required

Proxy URL for uploading files through the API (PUT request to /v1/files/{key})

Example:

"https://core-api.filejar-dev.workers.dev/v1/files/org-id/filename.pdf"

upload_id
string<uuid>
required

Unique identifier for this upload

Example: