Skip to main content
POST
Upload media

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

X-Client-Id
string

Optional. Files belong to your API account, not a practice, and work at every practice you can send to.

Body

file
file
required

A jpeg, png, gif or mp4 file, at most 5 MB.

reference_id
string

Optional, unique per API account. Uploading again with the same reference_id returns the existing file instead of storing a copy, even if the file is different, so a retry is safe. You can also use it in place of media_id in the media endpoints' URLs.

Response

An existing file returned for a repeated reference_id

success
boolean
required
data
object
required
message
string | null