Upload asset

Upload asset

curl --request POST \
  --url https://macaly.com/api/client-app/assets/upload \
  --header 'Authorization: Bearer <token>'

const options = {method: 'POST', headers: {Authorization: 'Bearer <token>'}};

fetch('https://macaly.com/api/client-app/assets/upload', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://macaly.com/api/client-app/assets/upload",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://macaly.com/api/client-app/assets/upload"

	req, _ := http.NewRequest("POST", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://macaly.com/api/client-app/assets/upload")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

POST

api

client-app

assets

upload

Upload asset

curl --request POST \
  --url https://macaly.com/api/client-app/assets/upload \
  --header 'Authorization: Bearer <token>'

const options = {method: 'POST', headers: {Authorization: 'Bearer <token>'}};

fetch('https://macaly.com/api/client-app/assets/upload', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://macaly.com/api/client-app/assets/upload",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://macaly.com/api/client-app/assets/upload"

	req, _ := http.NewRequest("POST", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://macaly.com/api/client-app/assets/upload")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

Envia um arquivo para os Recursos de um chat e retorna uma URL permanente na CDN. Use este endpoint para imagens, documentos, áudio, vídeo ou qualquer outro arquivo que seu app ou workflow deva referenciar por URL.

Requisição

POST /api/client-app/assets/upload

Cabeçalhos

Cabeçalho	Obrigatório	Descrição
`Authorization`	Sim	`Bearer macaly_...`
`Content-Type`	Sim	`multipart/form-data`

Parâmetros do formulário

Campo	Tipo	Obrigatório	Padrão	Descrição
`chatId`	string	Sim	-	O chat que receberá o recurso
`file`	file	Sim	-	O arquivo a ser enviado. Tamanho máximo de 20 MB
`folderPath`	string	Não	-	Caminho da pasta separado por barras, por exemplo `images/products`
`createFolders`	string	Não	`false`	`"true"`, `"1"` ou `"yes"` cria as pastas que faltarem em `folderPath`
`folderId`	string	Não	-	ID de uma pasta existente. Não envie `folderId` e `folderPath` juntos
`title`	string	Não	Nome original do arquivo	Título de exibição do recurso
`metadata`	string (JSON)	Não	-	Objeto JSON armazenado junto com o recurso

Informe folderId ou folderPath, nunca os dois. Enviar os dois retorna o erro 400.

Exemplo de requisição

curl -X POST https://www.macaly.com/api/client-app/assets/upload \
  -H "Authorization: Bearer macaly_abc123..." \
  -F "chatId=abc123def456" \
  -F "file=@./logo.png;type=image/png"

const form = new FormData();
form.append('chatId', 'abc123def456');
form.append('file', fileBlob, 'logo.png');

const response = await fetch('https://www.macaly.com/api/client-app/assets/upload', {
  method: 'POST',
  headers: {
    'Authorization': 'Bearer macaly_abc123...',
  },
  body: form,
});

const data = await response.json();
console.log(data.asset.url);

import requests

response = requests.post(
    'https://www.macaly.com/api/client-app/assets/upload',
    headers={'Authorization': 'Bearer macaly_abc123...'},
    data={'chatId': 'abc123def456'},
    files={'file': ('logo.png', open('logo.png', 'rb'), 'image/png')},
)

data = response.json()
print(data['asset']['url'])

Enviando para uma pasta

Use folderPath para uma estrutura de pastas legível e defina createFolders=true para criar as pastas que faltarem ao longo do caminho:

cURL

curl -X POST https://www.macaly.com/api/client-app/assets/upload \
  -H "Authorization: Bearer macaly_abc123..." \
  -F "chatId=abc123def456" \
  -F "folderPath=images/products" \
  -F "createFolders=true" \
  -F "title=Product hero image" \
  -F "file=@./hero.png;type=image/png"

Resposta

{
  "success": true,
  "asset": {
    "assetId": "asset_123",
    "url": "https://cdn.macaly.app/user/chat/key/logo.png",
    "storageKey": "user/chat/key/logo.png",
    "contentType": "image/png",
    "fileSize": 12345,
    "type": "image",
    "folderId": "folder_123"
  }
}

Campo	Tipo	Descrição
`asset.assetId`	string	Identificador único do recurso
`asset.url`	string	URL permanente na CDN do arquivo enviado
`asset.storageKey`	string	Caminho interno no armazenamento
`asset.contentType`	string	Tipo MIME do arquivo enviado
`asset.fileSize`	number	Tamanho do arquivo em bytes
`asset.type`	string	Tipo de recurso inferido, por exemplo `image`, `document`
`asset.folderId`	string \| null	Pasta onde o recurso foi colocado, se houver

Códigos de status

Código	Descrição
200	Sucesso: recurso enviado
400	`chatId` ou `file` ausente, JSON de `metadata` inválido, ou `folderId` e `folderPath` enviados juntos
401	Chave de API inválida ou ausente
403	A chave de API não tem acesso a este chat
404	Pasta não encontrada
413	O arquivo excede o limite de envio de 20 MB
500	Erro no servidor

Regras de pastas

Os caminhos de pasta são divididos por /, os espaços nas pontas são removidos e os segmentos vazios são ignorados.
A profundidade máxima é de 8 pastas.
O nome de cada pasta pode ter até 255 caracteres.
A correspondência de nomes de pasta não diferencia maiúsculas de minúsculas dentro da mesma pasta pai.
Se folderPath não existir e createFolders não for true, o envio falha com o erro 404.

Bom saber

Este endpoint usa a mesma chave de API macaly_... do restante da API, mesmo que a URL comece com /api/client-app/. Não é necessário um token separado.
O chat indicado em chatId precisa pertencer ao mesmo workspace da sua chave de API.
Os recursos enviados recebem uma URL permanente na CDN, que você pode referenciar como anexo em Create chat ou Publish message, ou usar em qualquer lugar fora do Macaly.

Primeiros passos

Endpoints

Requisição

Cabeçalhos

Parâmetros do formulário

Exemplo de requisição

Enviando para uma pasta

Resposta

Códigos de status

Regras de pastas

Bom saber

​Requisição

​Cabeçalhos

​Parâmetros do formulário

​Exemplo de requisição

​Enviando para uma pasta

​Resposta

​Códigos de status

​Regras de pastas

​Bom saber

Requisição

Cabeçalhos

Parâmetros do formulário

Exemplo de requisição

Enviando para uma pasta

Resposta

Códigos de status

Regras de pastas

Bom saber