Skip to main content
POST
Upload a file

Authorizations

Authorization
string
header
required

Enter your API key. Example: Bearer poelis_api_...

Path Parameters

target_id
string
required

Body

multipart/form-data
file
string
required

File to upload.

userTitle
string | null

Optional editable display title for the uploaded file.

allow_duplicate
boolean
default:false

When true, bypass the duplicate-file check (same size and MIME in the workspace).

Response

The newly created file and its initial link usage.

Public representation of a stored file.

id
string
required

File ID

name
string
required

Original file name (legacy compatibility field)

originalFileName
string
required

Original file name

deleted
boolean
required

Whether the file is soft-deleted

userTitle
string | null

Optional editable file title

content_type
string | null

MIME type

description
string | null

File description

size_bytes
integer | null

File size in bytes

uploadedAt
string | null

ISO 8601 upload timestamp

uploadedBy
PublicUser · object | null

User who uploaded the file

Example:
used_in
PublicFileUsage · object[]

Current file link placements for this file