File Upload

POST

https://api-platform.digitpulse.ai/v1/files/upload

Last modified:2025-03-03 03:39:16

Upload a file (currently only images are supported) for use when sending messages, enabling multimodal understanding of images and text. Supports png, jpg, jpeg, webp, gif formats. Uploaded files are for use by the current end-user only.

Request

Authorization

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

Header Params

Body Params multipart/form-data

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST 'https://api-platform.digitpulse.ai/v1/files/upload' \
--header 'X-Timestamp: 1739933362' \
--header 'X-Signature: 1739933362' \
--header 'Authorization: Bearer <token>' \
--form 'file=@""' \
--form 'user=""'

Responses

🟢200Success

application/json

Errors

400, no_file_uploaded, a file must be provided

400, too_many_files, currently only one file is accepted

400, unsupported_preview, the file does not support preview

400, unsupported_estimate, the file does not support estimation

413, file_too_large, the file is too large

415, unsupported_file_type, unsupported extension, currently only document files are accepted

503, s3_connection_failed, unable to connect to S3 service

503, s3_permission_denied, no permission to upload files to S3

503, s3_file_too_large, file exceeds S3 size limit

500, internal server error

Body

Example

{
  "id": "72fa9618-8f89-4a37-9b33-7e1178a24a67",
  "name": "example.png",
  "size": 1024,
  "extension": "png",
  "mime_type": "image/png",
  "created_by": 123,
  "created_at": 1577836800
}

Modified at 2025-03-03 03:39:16

Send Chat Message

Stop Generate