List videos

The workspace's most recent videos, newest first. Needs the videos:read permission.

GET

https://app.mosio.me/v1/videos

View as Markdown

Authorization

apiKeyAPI key in headerrequired

Query parameters

limitoptionalinteger
How many videos to return (1–100).

maximum: 100 · minimum: 1 · default: 20

Returns

200

The videos.

JSON

videosarray ofobjectrequired
- idstringrequired
- statusqueuedorrenderingordoneorfailedorcanceledrequired
- templatestringrequired
  The template id, composition for a rendered composition, or studio for a Studio project.
- created_atstringrequired
  format: date-time
- finished_atstring | nullrequired
  format: date-time
- duration_secondsnumber | nullrequired
  Length of the finished video.
- output_urlstring | nullrequired
  Short-lived link to the MP4 once status is done.
- errorobject | nullrequired
  Why the render failed, when status is failed. Failed videos spend no credits.
  
  codeoptionalstring
  messageoptionalstring
}

401

The API key is missing or not valid.

JSON

errorunauthorizedorinvalid_api_keyorinsufficient_scopeorforbiddenorinvalid_inputorunknown_template+9 morerequired
A stable error code.
messagestringrequired
A message for people, in Indonesian.
detailsoptionalunknown
More about the error, such as the fields to fix.

List videos

curl --request GET \
  --url https://app.mosio.me/v1/videos \
  --header 'x-api-key: <x-api-key>'

const url = 'https://app.mosio.me/v1/videos';
const options = {method: 'GET', headers: {'x-api-key': '<x-api-key>'}};

fetch(url, options)
  .then(res => res.json())
  .then(json => console.log(json))
  .catch(err => console.error(err));

Response example

{
  "videos": [
    {
      "id": "vid_6f1c2b9e-0c1a-4b7e-9d0e-2f3a4b5c6d7e",
      "status": "queued",
      "template": "string",
      "created_at": "2019-08-24T14:15:22Z",
      "finished_at": "2019-08-24T14:15:22Z",
      "duration_seconds": 0,
      "output_url": "string",
      "error": {
        "code": "string",
        "message": "string"
      }
    }
  ]
}