curl --request POST \
--url https://api.cloudhumans.com/cloudchat/v1/accounts/{accountId}/uploads \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--header 'cloudchat-instance: <cloudchat-instance>' \
--data '
{
"external_url": "https://cdn.acme.com/screenshots/reset.png"
}
'import requests
url = "https://api.cloudhumans.com/cloudchat/v1/accounts/{accountId}/uploads"
payload = { "external_url": "https://cdn.acme.com/screenshots/reset.png" }
headers = {
"cloudchat-instance": "<cloudchat-instance>",
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
'cloudchat-instance': '<cloudchat-instance>',
Authorization: 'Bearer <token>',
'Content-Type': 'application/json'
},
body: JSON.stringify({external_url: 'https://cdn.acme.com/screenshots/reset.png'})
};
fetch('https://api.cloudhumans.com/cloudchat/v1/accounts/{accountId}/uploads', 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://api.cloudhumans.com/cloudchat/v1/accounts/{accountId}/uploads",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'external_url' => 'https://cdn.acme.com/screenshots/reset.png'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json",
"cloudchat-instance: <cloudchat-instance>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.cloudhumans.com/cloudchat/v1/accounts/{accountId}/uploads"
payload := strings.NewReader("{\n \"external_url\": \"https://cdn.acme.com/screenshots/reset.png\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("cloudchat-instance", "<cloudchat-instance>")
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.cloudhumans.com/cloudchat/v1/accounts/{accountId}/uploads")
.header("cloudchat-instance", "<cloudchat-instance>")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"external_url\": \"https://cdn.acme.com/screenshots/reset.png\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.cloudhumans.com/cloudchat/v1/accounts/{accountId}/uploads")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["cloudchat-instance"] = '<cloudchat-instance>'
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"external_url\": \"https://cdn.acme.com/screenshots/reset.png\"\n}"
response = http.request(request)
puts response.read_body{
"file_url": "https://cloudchat.cloudhumans.com/rails/active_storage/blobs/redirect/abc123/upload-9f2c41d0.png",
"blob_id": 5120
}{
"error": {
"code": "bad_request",
"message": "The request is malformed.",
"details": [
{
"field": "attachment_base64",
"code": "invalid",
"message": "Provide exactly one of attachment_base64 or external_url, as a string."
},
{
"field": "external_url",
"code": "invalid",
"message": "Provide exactly one of attachment_base64 or external_url, as a string."
}
]
}
}{
"error": {
"code": "unauthorized",
"message": "Authentication is required. Send a valid Bearer token in the Authorization header."
}
}{
"error": {
"code": "forbidden",
"message": "This account is suspended."
}
}{
"error": {
"code": "not_found",
"message": "Resource could not be found."
}
}{
"error": {
"code": "validation_failed",
"message": "The request payload is invalid.",
"details": [
{
"field": "external_url",
"code": "unsafe_url",
"message": "The URL is not allowed."
}
]
}
}{
"message": "API rate limit exceeded"
}{
"error": {
"code": "internal_error",
"message": "An unexpected error occurred. Please try again later."
}
}Upload an image
Store one image and get back the URL to embed in article Markdown ().
Exactly one input mode per call: external_url — the server fetches the image from a public URL — or attachment_base64 — the bytes travel in the request. Both share the same contract: PNG, JPEG or WEBP, up to 10 MB. The stored type is sniffed from the actual bytes, so a mislabeled file is still refused; SVG and GIF are rejected.
This is the whole upload surface of the public API — it exists for help center images. Other file types, larger files and multipart uploads are not part of the v1 contract.
curl --request POST \
--url https://api.cloudhumans.com/cloudchat/v1/accounts/{accountId}/uploads \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--header 'cloudchat-instance: <cloudchat-instance>' \
--data '
{
"external_url": "https://cdn.acme.com/screenshots/reset.png"
}
'import requests
url = "https://api.cloudhumans.com/cloudchat/v1/accounts/{accountId}/uploads"
payload = { "external_url": "https://cdn.acme.com/screenshots/reset.png" }
headers = {
"cloudchat-instance": "<cloudchat-instance>",
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
'cloudchat-instance': '<cloudchat-instance>',
Authorization: 'Bearer <token>',
'Content-Type': 'application/json'
},
body: JSON.stringify({external_url: 'https://cdn.acme.com/screenshots/reset.png'})
};
fetch('https://api.cloudhumans.com/cloudchat/v1/accounts/{accountId}/uploads', 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://api.cloudhumans.com/cloudchat/v1/accounts/{accountId}/uploads",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'external_url' => 'https://cdn.acme.com/screenshots/reset.png'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json",
"cloudchat-instance: <cloudchat-instance>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.cloudhumans.com/cloudchat/v1/accounts/{accountId}/uploads"
payload := strings.NewReader("{\n \"external_url\": \"https://cdn.acme.com/screenshots/reset.png\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("cloudchat-instance", "<cloudchat-instance>")
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.cloudhumans.com/cloudchat/v1/accounts/{accountId}/uploads")
.header("cloudchat-instance", "<cloudchat-instance>")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"external_url\": \"https://cdn.acme.com/screenshots/reset.png\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.cloudhumans.com/cloudchat/v1/accounts/{accountId}/uploads")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["cloudchat-instance"] = '<cloudchat-instance>'
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"external_url\": \"https://cdn.acme.com/screenshots/reset.png\"\n}"
response = http.request(request)
puts response.read_body{
"file_url": "https://cloudchat.cloudhumans.com/rails/active_storage/blobs/redirect/abc123/upload-9f2c41d0.png",
"blob_id": 5120
}{
"error": {
"code": "bad_request",
"message": "The request is malformed.",
"details": [
{
"field": "attachment_base64",
"code": "invalid",
"message": "Provide exactly one of attachment_base64 or external_url, as a string."
},
{
"field": "external_url",
"code": "invalid",
"message": "Provide exactly one of attachment_base64 or external_url, as a string."
}
]
}
}{
"error": {
"code": "unauthorized",
"message": "Authentication is required. Send a valid Bearer token in the Authorization header."
}
}{
"error": {
"code": "forbidden",
"message": "This account is suspended."
}
}{
"error": {
"code": "not_found",
"message": "Resource could not be found."
}
}{
"error": {
"code": "validation_failed",
"message": "The request payload is invalid.",
"details": [
{
"field": "external_url",
"code": "unsafe_url",
"message": "The URL is not allowed."
}
]
}
}{
"message": "API rate limit exceeded"
}{
"error": {
"code": "internal_error",
"message": "An unexpected error occurred. Please try again later."
}
}Authorizations
The id_token from POST /auth/v1/signin, sent as Authorization: Bearer <id_token>. Not the access_token — that one does not carry the identity Cloud Chat authorizes on.
Headers
Your Cloud Chat instance ID — an integer, fixed for your company, told at onboarding. The API overview explains how instances work, how to find yours, and the errors a wrong or missing value produces.
1
Path Parameters
Your Cloud Chat account. It has to be an account your token grants membership on, and it has to live on the instance in the cloudchat-instance header — the two travel together. Account numbers are only unique within an instance, so the same number is a different company on another instance. Usually a mismatched pair fails closed with a 401, because your user does not exist on the other instance — but if your identity happens to exist on both, the call succeeds against the other company's data, silently. Read it and you are looking at the wrong help center; write it and you have stored into the wrong account. Send the two values that were given to you together, and never try a number to see what answers.
1
Body
Exactly one of external_url and attachment_base64 — sending both, neither, or a non-string value is a 400. Both modes share the same constraints: PNG, JPEG or WEBP, up to 10 MB, with the type sniffed from the actual bytes (a mislabeled file is still refused; SVG and GIF are rejected).
Public HTTP(S) URL to fetch the image from. URLs that are malformed, are not HTTP(S), or resolve to private/internal addresses are refused.
"https://cdn.acme.com/screenshots/reset.png"
The image bytes, base64-encoded — raw base64 or a full data: URL. Mind the size: base64 inflates the payload by about a third.
Response
The stored image.
The stored image.
What you embed in the article Markdown: .
"https://cloudchat.cloudhumans.com/rails/active_storage/blobs/redirect/abc123/upload-9f2c41d0.png"
Internal id of the stored file — keep it in case a later endpoint asks for a blob reference.
5120