Vertopal
Tools
CONVERTERS
API Menu

Convert Status

POST /v1/convert/status

Get the status of the conversion file at any time.
The output of this task only gives the converting status. If the converting status is successful or failed, it does not mean that the convert task is completed. The convert task for some reason may be complete with a few seconds delay. If you want to start the download task for the converted file, don't rely on the output of this task, and use Monitor Response of Task for this purpose.

Request

The example code of this section shows the structure of the Convert Status request. You may see the other request structure keys such as data keys and see how the request is authenticated.
HTTP
cURL
CLI
Python
PHP
POST https://api.vertopal.com/v1/convert/status
Authorization: Bearer [APP_TOKEN]

data={
    "app": "[APP_ID]",
    "connector": "[CONNECTOR]"
}

curl -L -X POST 'https://api.vertopal.com/v1/convert/status' \
-H 'Authorization: Bearer [APP_TOKEN]' \
-F 'data={
    "app": "[APP_ID]",
    "connector": "[CONNECTOR]"
}'

vertopal api -v 1 convert/status \
--app "[APP_ID]" \
--token "[APP_TOKEN]" \
-F data='{
    "app": "%app-id%",
    "connector": "[CONNECTOR]"
}'

from vertopal.api.v1 import API

API.status(
    app="[APP_ID]",
    token="[APP_TOKEN]",
    connector="[CONNECTOR]",
)

use Vertopal\API\Credential;
use Vertopal\API\V1;

require "vendor/autoload.php";

$credential = new Credential("[APP_ID]", "[APP_TOKEN]");

V1::status($credential, "[CONNECTOR]")

Response

Output Keys

status string

The status of the conversion.

Values
waiting|pending|successful|failed

HTTP Status Codes

OK 200

The task has been executed successfully without any errors.

The example code of this section shows the structure of the Convert Status response. You may see the other response structure keys such as entity keys.
JSON
{
    "result": {
        "output": {
            "status": "successful"
        },
        "error": {},
        "warning": {}
    }
}
Loading, Please Wait...