Skip to main content
POST
Upload an image

Authorizations

Authorization
string
header
required

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

cloudchat-instance
integer
required

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.

Example:

1

Path Parameters

accountId
integer
required

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.

Example:

1

Body

application/json

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

external_url
string

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.

Example:

"https://cdn.acme.com/screenshots/reset.png"

attachment_base64
string

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.

file_url
string
required

What you embed in the article Markdown: ![alt](file_url).

Example:

"https://cloudchat.cloudhumans.com/rails/active_storage/blobs/redirect/abc123/upload-9f2c41d0.png"

blob_id
integer
required

Internal id of the stored file — keep it in case a later endpoint asks for a blob reference.

Example:

5120