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

Lädt eine Datei in die Assets eines Chats hoch und gibt eine permanente CDN-URL zurück. Nutze das für Bilder, Dokumente, Audio, Video oder jede andere Datei, die deine App oder dein Prozess per URL referenzieren soll.

Anfrage

POST /api/client-app/assets/upload

Header	Erforderlich	Beschreibung
`Authorization`	Ja	`Bearer macaly_...`
`Content-Type`	Ja	`multipart/form-data`

Form-Data-Parameter

Feld	Typ	Erforderlich	Standardwert	Beschreibung
`chatId`	string	Ja	-	Der Chat, zu dem das Asset hochgeladen wird
`file`	file	Ja	-	Die hochzuladende Datei. Maximalgröße 20 MB
`folderPath`	string	Nein	-	Ordnerpfad mit Schrägstrichen getrennt, z. B. `images/products`
`createFolders`	string	Nein	`false`	`"true"`, `"1"` oder `"yes"` erstellt fehlende Ordner in `folderPath`
`folderId`	string	Nein	-	ID eines bestehenden Ordners. Sende nicht gleichzeitig `folderId` und `folderPath`
`title`	string	Nein	Ursprünglicher Dateiname	Anzeigetitel für das Asset
`metadata`	string (JSON)	Nein	-	JSON-Objekt, das zusammen mit dem Asset gespeichert wird

Gib entweder folderId oder folderPath an, nicht beides. Wenn beide gesendet werden, kommt ein 400-Fehler zurück.

Beispielanfrage

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'])

In einen Ordner hochladen

Nutze folderPath für eine lesbare Ordnerstruktur und setze createFolders=true, um fehlende Ordner im Pfad zu erstellen:

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"

Antwort

{
  "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"
  }
}

Feld	Typ	Beschreibung
`asset.assetId`	string	Eindeutige Kennung des Assets
`asset.url`	string	Permanente CDN-URL für die hochgeladene Datei
`asset.storageKey`	string	Interner Speicherpfad
`asset.contentType`	string	MIME-Typ der hochgeladenen Datei
`asset.fileSize`	number	Dateigröße in Bytes
`asset.type`	string	Ermittelter Asset-Typ, z. B. `image`, `document`
`asset.folderId`	string \| null	Ordner, in dem das Asset abgelegt wurde, falls vorhanden

Statuscodes

Status	Beschreibung
200	Erfolgreich - Asset hochgeladen
400	`chatId` oder `file` fehlt, ungültiges `metadata`-JSON, oder sowohl `folderId` als auch `folderPath` angegeben
401	Ungültiger oder fehlender API-Schlüssel
403	API-Schlüssel hat keinen Zugriff auf diesen Chat
404	Ordner nicht gefunden
413	Datei überschreitet das Upload-Limit von 20 MB
500	Serverfehler

Ordnerregeln

Ordnerpfade werden an / getrennt, getrimmt, und leere Segmente werden ignoriert.
Die maximale Tiefe beträgt 8 Ordner.
Jeder Ordnername darf bis zu 255 Zeichen lang sein.
Der Ordnerabgleich unterscheidet innerhalb desselben übergeordneten Ordners nicht zwischen Groß- und Kleinschreibung.
Existiert folderPath nicht und createFolders ist nicht true, schlägt der Upload mit 404 fehl.

Gut zu wissen

Dieser Endpoint verwendet denselben macaly_...-API-Schlüssel wie der Rest der API, auch wenn die URL mit /api/client-app/ beginnt. Es wird kein separates Token benötigt.
Der über chatId referenzierte Chat muss zum selben Team gehören wie dein API-Schlüssel.
Hochgeladene Assets erhalten eine permanente CDN-URL, die du in Create chat oder Publish message als Anhang referenzieren oder auch außerhalb von Macaly verwenden kannst.

Erste Schritte

Endpoints

Anfrage

Header

Form-Data-Parameter

Beispielanfrage

In einen Ordner hochladen

Antwort

Statuscodes

Ordnerregeln

Gut zu wissen

​Anfrage

​Header

​Form-Data-Parameter

​Beispielanfrage

​In einen Ordner hochladen

​Antwort

​Statuscodes

​Ordnerregeln

​Gut zu wissen

Anfrage

Header

Form-Data-Parameter

Beispielanfrage

In einen Ordner hochladen

Antwort

Statuscodes

Ordnerregeln

Gut zu wissen