Vertopal
Tools
CONVERTERS
API Menu

Supported Convert Formats

POST /v1/convert/formats

Lists supported input or output formats for file conversion.

Request

Parameter Keys

sublist string required

Selects supported formats based on whether they are inputs or outputs.

Values
inputs|outputs
format string

The specific format that you want to get input or output formats of it. If the format also has a type, separate it with a hyphen.

Example
txt-markdown
The example code of this section shows the structure of the Supported Convert Formats request. You may see the other request structure keys such as data keys and see how the request is authenticated.
HTTP
cURL
CLI
POST https://api.vertopal.com/v1/convert/formats
Authorization: Bearer [APP_TOKEN]

data={
    "app": "[APP_ID]",
    "parameters": {
        "sublist": "inputs"
    }
}

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

vertopal api -v 1 convert/formats \
--app "[APP_ID]" \
--token "[APP_TOKEN]" \
-F data='{
    "app": "%app-id%",
    "parameters": {
        "sublist": "inputs"
    }
}'

Response

Output Keys

formats array

The supported input or output formats. If the format parameter key has been sent, the supported input or output formats of that.
Read the Get Format to know what keys each format contains.

HTTP Status Codes

OK 200

The task has been executed successfully without any errors.

INVALID_FORMAT 200

The [FORMAT] format is not found in the valid formats.

WRONG_FORMAT_STRUCTURE 200

The format has the wrong structure.

The example code of this section shows the structure of the Supported Convert Formats response. You may see the other response structure keys such as entity keys.
JSON
{
    "result": {
        "output": {
            "formats": [
                {
                    "format": "aai",
                    "extension": "aai",
                    "type": null,
                    "name": "AAI Dune Image",
                    "title": "AAI",
                    "categories": [
                        "picture"
                    ]
                },
                // ...
                // other input formats
                // ...
                {
                    "format": "bib",
                    "extension": "bib",
                    "type": "biblatex",
                    "name": "Bibliography Document",
                    "title": "BIB",
                    "categories": [
                        "document",
                        "markup"
                    ]
                },
                {
                    "format": "db",
                    "extension": "db",
                    "type": "docbook",
                    "name": "DocBook Markup Language",
                    "title": "DB",
                    "categories": [
                        "document",
                        "markup"
                    ]
                }
            ]
        },
        "error": {},
        "warning": {}
    }
}
Loading, Please Wait...