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.
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