Skip to main content
POST
Send media, or get a presigned URL to upload it

Authorizations

Authorization
string
header
required

OAuth 2.1 with PKCE

Path Parameters

id
string
required

Consultation/conversation ID

Body

application/json
type
enum<string>
required

Media type

Available options:
photo,
video
contentType
string
required

MIME type (e.g. image/jpeg, video/mp4)

data
string

Base64-encoded file bytes (no data: URI prefix). Max 8 MB decoded.

url
string<uri>

Alternative to data: a public HTTPS URL Arlo downloads the file from. Must need no credentials, must not resolve to a private or reserved address, and must be under 8 MB. Ignored when data is set.

Response

Media sent, or a presigned upload URL when neither data nor url was provided

sent
boolean

True when data or url was provided and the media was delivered

mediaSent
enum<string>
Available options:
photo,
video
messageId
string

The media message id (pre-assigned on the presign fallback)

uploadUrl
string<uri>

Presign fallback only. Presigned S3 PUT URL, expires in about 60 seconds

uploadRef
string | null

Presign fallback only. Short-lived opaque ref for the consultation widget's upload relay

mediaType
enum<string>
Available options:
photo,
video
contentType
string
expiresIn
integer

Presign fallback only. Seconds until uploadUrl expires

instructions
string