Get Task Results

Single Task Result

With this endpoint, you can get a single task data. Status, uploaded files.

Request

info

GET https://vimqu.com/api/task/_your_task_id_

Response

tip

When you send single task request, you will get a "Common Task Result Object". Please check it.

Search in Tasks

With this endpoint, you can search in your tasks.

Request

info

GET https://vimqu.com/api/task/search?type=hls&type[]=video&type[]=video&status=completed&reference_id=1233243

Parameter	Required	Type	Available Values	Description
id	NO	uuid	-	Task ID
reference_id	NO	string	any	Your Reference ID
type	NO	array	thumbnail, hls, video, dash	Type of output
status	NO	string	active, processing, completed, canceled, failed	Status of output

warning

The type parameter must be array. You can use it in the query as follows:

• type[]=hls or
• type[]=hls&type[]=video&type[]=thumbnail

Response

Collection of <Common Task Result Object>

{
    "data": [
        {
            "id": "9b1abc5b-68fc-98af-4f9c-9b1abc5b",
            "created_at": "2023-01-16 07:48:35",
            "status": "completed",
            "outputs": [
                {
                    "id": "9b1abc5b-6c85-48a6-98af-9b1abc5b",
                    "reference_id": "1233243",
                    "storage": {
                        "id": "98af-c98a-4f9c-98af-9b1abc5b",
                        "name": "my_storage",
                        "driver": "gcs"
                    },
                    "target_path": "/outputs",
                    "type": "video",
                    "type_specific_config": {
                        "container": "mp4",
                        "codec": "h265",
                        "filters": [],
                        "audio": {
                            "codec": "aac",
                            "bitrate": 128
                        }
                    },
                    "files": [
                        {
                            "path": "/outputs/061023751685.mp4",
                            "uploaded_at": "2024-01-16 07:52:24"
                        }
                    ]
                }
            ]
        }

        // ...
        // ...
        // ...
    ],
    "links": {
        "first": "https://vimqu.com/api/task/search?type%5B0%5D=video&type%5B1%5D=video&status=completed&reference_id=1233243&page=1",
        "last": "https://vimqu.com/api/task/search?type%5B0%5D=video&type%5B1%5D=video&status=completed&reference_id=1233243&page=2",
        "prev": null,
        "next": "https://vimqu.com/api/task/search?type%5B0%5D=video&type%5B1%5D=video&status=completed&reference_id=1233243&page=2"
    },
    "meta": {
        "current_page": 1,
        "from": 1,
        "last_page": 2,
        "links": [
            {
                "url": "https://vimqu.com/api/task/search?type%5B0%5D=video&type%5B1%5D=video&status=completed&reference_id=1233243&page=1",
                "label": "1",
                "active": true
            },
            {
                "url": "https://vimqu.com/api/task/search?type%5B0%5D=video&type%5B1%5D=video&status=completed&reference_id=1233243&page=2",
                "label": "2",
                "active": false
            },
            {
                "url": "https://vimqu.com/api/task/search?type%5B0%5D=video&type%5B1%5D=video&status=completed&reference_id=1233243&page=2",
                "label": "Next »",
                "active": false
            }
        ],
        "path": "https://vimqu.com/api/task/search",
        "per_page": 30,
        "to": 30,
        "total": 35
    }
}