You can use this endpoint to get status of videos.

Response

FieldTypeDescription
id
stringUnique identifier for the object.
errorjsonOptional, the error detail of the video.
statusstringVideo status, one of
- processing (The video is rendering)
- completed (The video render success)
- failed (An error occurred when rendering video).
video_urlstringThe URL of the video after completed. The URL will be expired in a few days.

If your video is processing, you'll get a response like this:

{
    "code": 100,
    "data": {
        "error": null,
        "id": "1234567890",
        "status": "processing"
    },
    "message": "Success"
}

If an error occurred in the rendering process, the status would change to "failed", and errors details may include in the "error" field:

{
    "code": 100,
    "data": {
        "error": {
            "code": "400009",
            "detail": "download resource failed, url: httttttps://surreal-public.oss-cn-beijing.aliyuncs.com/tmp/Business.jpg",
            "message": "Resource download failed"
        },
        "id": "b3262814004f4a2f99bc9773cb847af3",
        "status": "failed"
    },
    "message": "Success"
}

After the video rendering is finished, you'll get a response like this:

{
    "code": 100,
    "data": {
        "error": null,
        "id": "f89cbde71a6a44439b50e1e78e033163",
        "status": "completed",
        "video_url": "https://static.movio.la/api-docs/videos/sample_video-2022102501.mp4"
    },
    "message": "Success"
}

Errors

Returns a 404 HTTP response if the video doesn't exist, or if doesn't have access to the page.

Returns a 400 HTTP response if the request exceeds the request limits.

Returns a 424 HTTP response if parameters are invalid.

{
    "code": 100,
    "data": {
        "error": {
            "code": "400009",
            "detail": "download resource failed, url: httttp://static.movio.la/api-docs/videos/sample_video-2022102501.mp4",
            "message": "Resource download failed"
        },
        "id": "224865e466cb426e8a8c90d5fd8edbb7",
        "status": "failed"
    },
    "message": "Success"
}

Language
Authentication
Header
Click Try It! to start a request and see the response here!