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

Bir sohbetin Varlıklar bölümüne dosya yükler ve kalıcı bir CDN URL’si döndürür. Görseller, belgeler, ses, video veya uygulamanızın ya da sürecinizin URL üzerinden referans vermesini istediğiniz diğer dosyalar için bunu kullanın.

İstek

POST /api/client-app/assets/upload

Başlıklar

Header	Zorunlu	Açıklama
`Authorization`	Evet	`Bearer macaly_...`
`Content-Type`	Evet	`multipart/form-data`

Form verisi parametreleri

Alan	Tür	Zorunlu	Varsayılan	Açıklama
`chatId`	string	Evet	-	Varlığın yükleneceği sohbet
`file`	file	Evet	-	Yüklenecek dosya. En fazla 20 MB
`folderPath`	string	Hayır	-	Eğik çizgiyle ayrılmış klasör yolu, örneğin `images/products`
`createFolders`	string	Hayır	`false`	`"true"`, `"1"` veya `"yes"` değeri, `folderPath` içindeki eksik klasörleri oluşturur
`folderId`	string	Hayır	-	Mevcut klasör kimliği. `folderId` ve `folderPath` alanlarını birlikte göndermeyin
`title`	string	Hayır	Orijinal dosya adı	Varlık için görüntülenecek başlık
`metadata`	string (JSON)	Hayır	-	Varlıkla birlikte saklanan JSON nesnesi

folderId veya folderPath alanlarından yalnızca birini gönderin, ikisini birden değil. İkisini birden göndermek 400 hatası döndürür.

Örnek istek

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

Klasöre yükleme

Okunabilir bir klasör yapısı için folderPath kullanın ve yol üzerindeki eksik klasörlerin oluşturulması için createFolders=true ayarlayın:

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"

Yanıt

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

Alan	Tür	Açıklama
`asset.assetId`	string	Varlığın benzersiz kimliği
`asset.url`	string	Yüklenen dosyanın kalıcı CDN URL’si
`asset.storageKey`	string	Dahili depolama yolu
`asset.contentType`	string	Yüklenen dosyanın MIME türü
`asset.fileSize`	number	Dosya boyutu (bayt cinsinden)
`asset.type`	string	Çıkarsanan varlık türü, örneğin `image`, `document`
`asset.folderId`	string \| null	Varsa, varlığın yerleştirildiği klasör

Durum kodları

Durum	Açıklama
200	Başarılı - Varlık yüklendi
400	`chatId` veya `file` eksik, `metadata` JSON’ı geçersiz ya da `folderId` ve `folderPath` birlikte gönderilmiş
401	Geçersiz veya eksik API anahtarı
403	API anahtarının bu sohbete erişimi yok
404	Klasör bulunamadı
413	Dosya 20 MB yükleme sınırını aşıyor
500	Sunucu hatası

Klasör kuralları

Klasör yolları / karakterinden bölünür, baştaki ve sondaki boşluklar kırpılır ve boş bölümler yok sayılır.
En fazla 8 klasör derinliği desteklenir.
Her klasör adı en fazla 255 karakter olabilir.
Aynı üst klasör içinde klasör eşleştirmesi büyük/küçük harfe duyarsızdır.
folderPath mevcut değilse ve createFolders true değilse, yükleme 404 hatasıyla başarısız olur.

Bilmeniz gerekenler

URL /api/client-app/ ile başlasa da bu endpoint, API’nin geri kalanıyla aynı macaly_... API anahtarını kullanır. Ayrı bir token gerekmez.
chatId ile belirtilen sohbet, API anahtarınızla aynı ekibe ait olmalıdır.
Yüklenen varlıklar kalıcı bir CDN URL’si alır; bu URL’yi Create chat veya Publish message isteklerinde ek olarak kullanabilir ya da Macaly dışında herhangi bir yerde kullanabilirsiniz.

Başlarken

Endpoint'ler

İstek

Başlıklar

Form verisi parametreleri

Örnek istek

Klasöre yükleme

Yanıt

Durum kodları

Klasör kuralları

Bilmeniz gerekenler

​İstek

​Başlıklar

​Form verisi parametreleri

​Örnek istek

​Klasöre yükleme

​Yanıt

​Durum kodları

​Klasör kuralları

​Bilmeniz gerekenler

İstek

Başlıklar

Form verisi parametreleri

Örnek istek

Klasöre yükleme

Yanıt

Durum kodları

Klasör kuralları

Bilmeniz gerekenler