Skip to main content
POST
/
files_upload
Error
A valid request URL is required to generate request examples
{
  "status": "ok",
  "data": {
    "temporary_download_url": "http://acme.com/somefile.png",
    "uid": "90d353e6-44c1-48ff-b15b-69b7721e5450",
    "filename": "somefile.png",
    "size": 10000,
    "mimetype": "image/png",
    "uploaded_by_email": "john.doe@acme.com",
    "uploaded_at": "2023-06-18 15:19:23 +0300"
  }
}
{
  "message": "<string>",
  "status": "error",
  "error_code": "validation_error",
  "errors": [
    {
      "fields": [
        "url"
      ],
      "msg": "must be a valid http(s) URL"
    }
  ]
}
{
  "message": "<string>",
  "status": "error",
  "error_code": "validation_error",
  "errors": [
    {
      "fields": [
        "url"
      ],
      "msg": "must be a valid http(s) URL"
    }
  ]
}
{
  "message": "<string>",
  "status": "error",
  "error_code": "validation_error",
  "errors": [
    {
      "fields": [
        "url"
      ],
      "msg": "must be a valid http(s) URL"
    }
  ]
}
{
  "message": "<string>",
  "status": "error",
  "error_code": "validation_error",
  "errors": [
    {
      "fields": [
        "url"
      ],
      "msg": "must be a valid http(s) URL"
    }
  ]
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

multipart/form-data

The body of request in multipart/form-data format, containing the file content, file name and mime-type.

​
file
file
required

A file content in binary format.

​
filename
string

Explicit filename override. If omitted, use multipart filename.

Maximum string length: 1024
Example:

"document.pdf"

​
content_type
string

Optional MIME type of the uploaded file.

Maximum string length: 140
​
caption
string

Optional caption text to send together with the file.

Maximum string length: 2000
Example:

"Here is the document you requested."

Response

Success

​
status
enum<string>
required
Available options:
ok,
error
Example:

"ok"

​
data
object
required