files

Upload Overview Image

PUT

/api/files/{company_name}/{permission_object_type}/{permission_object_id}/{object_type}/{object_id}/overview

curl --request PUT \
  --url '/api/files/{company_name}/{permission_object_type}/{permission_object_id}/{object_type}/{object_id}/overview?convert_to=image%2Fwebp' \
  --header 'Authorization: Bearer <token>' \
  --form 'file=<string>'

{
  "detail": "<string>"
}

Authorizations

Authorizationstringheaderrequired

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

Path Parameters

company_namestringrequired

permission_object_typeenum<string>required

Available options: machines, templates, chat

permission_object_idstringrequired

Required string length: 24 - 24

Pattern: ^[0-9a-f]{24}$

Example: 5eb7cf5a86d9755df3a6c593

object_typeenum<string>required

object_idstringrequired

Required string length: 24 - 24

Pattern: ^[0-9a-f]{24}$

Example: 5eb7cf5a86d9755df3a6c593

Query Parameters

convert_toenum<string> | nullquery

Supported image formats

Available options: image/webp, image/png, image/jpeg

Body

filestringrequired

Response

Successful Response

detailstringrequired