Skip to main content
POST
/
api
/
v1
/
files
/
upload
Upload a file
curl --request POST \
  --url http://localhost:3001/api/v1/files/upload \
  --header 'x-api-key: <api-key>'
{
  "id": "clxyz789",
  "messageId": "clxyz123",
  "pluginType": "file",
  "filename": "report.pdf",
  "mimeType": "application/pdf",
  "size": 1024,
  "storageKey": "uploads/clxyz123/report.pdf",
  "createdAt": "2025-01-01T00:00:00.000Z"
}

Authorizations

​
x-api-key
string
header
required

Placet API key (hp_...)

Response

Uploaded attachment

​
id
string
required
Example:

"clxyz789"

​
messageId
string
required
Example:

"clxyz123"

​
pluginType
string
required
Example:

"file"

​
filename
string
required
Example:

"report.pdf"

​
mimeType
string
required
Example:

"application/pdf"

​
size
number
required
Example:

1024

​
storageKey
string
required
Example:

"uploads/clxyz123/report.pdf"

​
createdAt
string
required
Example:

"2025-01-01T00:00:00.000Z"