List all files in a channel

GET

api

files

curl --request GET \
  --url http://localhost:3001/api/v1/files \
  --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_...)

Query Parameters

channel

string

required

Channel (agent) ID

Response

List of attachments

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"

Upload a file

List all files in a channel

curl --request GET \
  --url http://localhost:3001/api/v1/files \
  --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"
  }
]