Free Credential

The public free credential is available for personal testing and evaluation, allowing you to access the API. This allows you to access all API features in production without consuming your vCredits.

However, the free credential may process requests with lower priority, reduced speed, and stricter rate limits compared to premium mode. For detailed information, please refer to the Rate Limit documentation.

To use the free app, set the app parameter to free and the Authorization header to FREE-TOKEN.

Request

The example code of this section shows the structure of the Free Credential request. You may see the other request structure keys such as data keys and see how the request is authenticated.

HTTP

cURL

CLI

Python

POST https://api.vertopal.com/v1/example/endpoint
Authorization: Bearer FREE-TOKEN

data={
    "app": "free"
}

curl -L -X POST 'https://api.vertopal.com/v1/example/endpoint' \
-H 'Authorization: Bearer FREE-TOKEN' \
-F 'data={
    "app": "free"
}'

vertopal api -v 1 vertopal/endpoint \
-F data='{
    "app": "%app-id%"
}'

from vertopal.api.v1 import API

client = API()

client.example_method()

Response

HTTP Status Codes

OK 200

The task has been executed successfully without any errors.

DISABLED_FOR_FREE_APP 403

The task is disabled for the free app.

FREE_APP_LIMITED 429

The free app has a daily limit. Please try again in the next [DELAY] hours.

The example code of this section shows the structure of the Free Credential response. You may see the other response structure keys such as entity keys.

JSON

{
    "result": {
        "output": {
            // sample output data
        },
        "error": {},
        "warning": {}
    }
}

Free Credential

Request

Response

HTTP Status Codes

Products

Resources

Miscellaneous