Upload a file

POSThttps://api.vidmoat.com/v1/media/uploads

Bearer tokenScope media.writeupload capTry it in the playground

Upload a file directly, as multipart form data, up to 32 MB per request and within your plan's upload and storage limits. For larger files, import from a URL.

Form fields#

filefilerequired
The video, image or audio file.

Response#

Returns 201.

Response fields#

mediaobject
The stored file.
Show 7 child fields
- urlstring
  Use as a clip src.
- filenamestring
  Stored name.
- bytesinteger
  Size.
- deduplicatedboolean
  true when you had already uploaded the same bytes; the existing file is returned.
- probeobject or null
  { width, height, fps, duration, hasAudio }.
- convertedobject
  Present when video the browser cannot play (HEVC, for example) was converted: { from, to }.
- warningstring
  Present when that conversion failed.
hintstring
What to do with it.

Errors#

Besides the errors any request can get (authentication, rate limits):

Status	Code	When
400	`invalid_request`	The body is not multipart, or `file` is missing or empty.
413	`payload_too_large`	Over 32 MB, or over the plan's upload cap.
413	`quota_exceeded`	Cloud storage on the plan is full.

curl

curl -X POST https://api.vidmoat.com/v1/media/uploads \
  -H "Authorization: Bearer $VIDMOAT_KEY" \
  -F "file=@clip.mp4"

Response 201

{
  "media": {
    "url": "https://api.vidmoat.com/uploads/1727950000000-clip.mp4",
    "filename": "1727950000000-clip.mp4",
    "bytes": 10485760,
    "deduplicated": false,
    "probe": { "width": 1080, "height": 1920, "fps": 30, "duration": 8.2, "hasAudio": true }
  },
  "hint": "Pass `url` as `src` to an addClip command on POST /v1/projects/{id}/commands."
}