Vertopal
Tools
CONVERTERS
API Menu

Generate Download URL

POST /v1/download/url

Generates the downloadable URL, and gives access to your service for downloading the converted file from it.

Request

The example code of this section shows the structure of the Generate Download URL 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/download/url
Authorization: Bearer [APP_TOKEN]

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

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

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

from vertopal.api.v1 import API

API.download(
    app="[APP_ID]",
    token="[APP_TOKEN]",
    connector="[CONNECTOR]",
    url=True,
)

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

require "vendor/autoload.php";

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

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

Response

Output Keys

connector string<uuid>

The connector for connecting to another task as the data key.

name string

The original name of the converted file.

size number<integer>

The original size of the converted file in bytes.

expires_at string<datetime>

When the converted file will be deleted from the Vertopal.

url string<url>

The generated URL to download the converted file.

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 Generate Download URL response. You may see the other response structure keys such as entity keys.
JSON
{
    "result": {
        "output": {
            "connector": "[CONNECTOR]",
            "name": "sample.jpg",
            "size": 182311,
            "expires_at": "2023-03-24 08:15:36",
            "url": "https://api.vertopal.com/v1/download/url/get"
        },
        "error": {},
        "warning": {}
    }
}
Loading, Please Wait...