Media

Faz upload antecipado de mídia

POSThttp://localhost:8084/instance/{instance}/media/uploads

Autenticação

InstanceBearerobrigatório

JWT HS256 da própria instância.

Header: Authorization
Exemplo: Bearer <INSTANCE_TOKEN>

Parâmetros

instancepathobrigatório

string

Nome público da instância

minLength 1

Request body

obrigatório

bodyobject

filestringobrigatórioformat: binary

mediaTypeenum<image | video | audio | document>obrigatório

externalIdstringmaxLength: 255

externalAttributesstring

Objeto JSON serializado, máximo 16 KB

Exemplo JSONgerado do schema

{
  "file": "string",
  "mediaType": "image",
  "externalId": "string",
  "externalAttributes": "string"
}

Respostas

application/json

201

Upload criado

response 201object

idintegerobrigatório

instanceIdintegerobrigatório

externalIdstring | null

mediaTypeenum<image | video | audio | document>obrigatório

mimeTypestring | null

originalFileNamestring | null

originalFileSizeintegerobrigatório

originalFileSHA256string

jpegThumbnailstring

uploadobjectobrigatório

urlstringobrigatório

directPathstringobrigatório

handlestring

objectIdstring

mediaKeystringobrigatório

fileEncSHA256stringobrigatório

fileSHA256stringobrigatório

fileLengthintegerobrigatóriomín: 0

externalAttributesobject

createdAtstringobrigatórioformat: date-time

updatedAtstringobrigatórioformat: date-time

expiresAtstringobrigatórioformat: date-time

expiredbooleanobrigatório

Exemplo 201gerado do schema

{
  "id": 1,
  "instanceId": 1,
  "externalId": "string",
  "mediaType": "image",
  "mimeType": "string",
  "originalFileName": "CodeChat",
  "originalFileSize": 1,
  "originalFileSHA256": "string",
  "jpegThumbnail": "string",
  "upload": {
    "url": "https://api.example.com/webhooks/codechat",
    "directPath": "string",
    "handle": "string",
    "objectId": "string",
    "mediaKey": "string",
    "fileEncSHA256": "string",
    "fileSHA256": "string",
    "fileLength": 1
  },
  "externalAttributes": {},
  "createdAt": "2026-07-13T15:10:00Z",
  "updatedAt": "2026-07-13T15:10:00Z",
  "expiresAt": "2026-07-13T15:10:00Z",
  "expired": true
}

curl --request POST \

--url 'http://localhost:8084/instance/minha-instancia/media/uploads' \

--header 'Authorization: Bearer <INSTANCE_TOKEN>' \

--header 'Content-Type: application/json' \

--data '{"file":"string","mediaType":"image","externalId":"string","externalAttributes":"string"}'

{

"id": 1,

"instanceId": 1,

"externalId": "string",

"mediaType": "image",

"mimeType": "string",

"originalFileName": "CodeChat",

"originalFileSize": 1,

"originalFileSHA256": "string",

"jpegThumbnail": "string",

"upload": {

"url": "https://api.example.com/webhooks/codechat",

"directPath": "string",

"handle": "string",

"objectId": "string",

"mediaKey": "string",

"fileEncSHA256": "string",

"fileSHA256": "string",

"fileLength": 1

"externalAttributes": {},

"createdAt": "2026-07-13T15:10:00Z",

"updatedAt": "2026-07-13T15:10:00Z",

"expiresAt": "2026-07-13T15:10:00Z",

"expired": true

}