Custom User Presets

We offer the possibility to save a set of options for a certain target as a preset, so it can be easily used in later conversions. These presets are only visible for the user that saved them.

The following request creates a preset for a PNG conversion with the options color and rotate, and sets the name to "my preset".

POST /presets HTTP/1.1
Host: api2.online-convert.com
x-oc-api-key: <your API key here>
Content-Type: application/json
Cache-Control: no-cache

{
    "name": "my preset",
    "target": "png",
    "options": {
        "color": "1980",
        "rotate": 180
    }
}
curl -X POST \
  https://api2.online-convert.com/presets \
  -H 'cache-control: no-cache' \
  -H 'content-type: application/json' \
  -H 'x-oc-api-key: <your API key here>' \
  -d '{
    "name": "my preset",
        "target": "png",
        "options": {
            "color": "1980",
            "rotate": 180
        }
}'

To find out how to use your preset proceed to create a job with the options that we need to make use of your preset.

To get all information for one preset, send the following request:

GET /presets/<preset id here> HTTP/1.1
Host: api2.online-convert.com
x-oc-api-key: <your API key here>
Content-Type: application/json
Cache-Control: no-cache

{
    "name": "my new preset name"
}

To find out how to use your preset, proceed to create a job with the options that we need to make use of your preset.

To get all information for one preset, send the following request:

curl -X GET \
  https://api2.online-convert.com/presets/<you preset id here> \
  -H 'cache-control: no-cache' \
  -H 'content-type: application/json' \
  -H 'x-oc-api-key: <your API key here>' \
  -d '{
    "name": "my new preset name"
    }'

If you want to modify a preset e.g. to set other options or a different name, you can send a patch request for the preset id you want to modify.

PATCH /presets/<preset id here> HTTP/1.1
Host: api2.online-convert.com
x-oc-api-key: <your API key here>
Content-Type: application/json
Cache-Control: no-cache

{
    "name": "my new preset name"
}

If you want to modify a preset, e.g. to set other options or a different name, you can send a patch request for the preset id you want to modify.

curl -X PATCH \
  https://api2.online-convert.com/presets/<you preset id here> \
  -H 'cache-control: no-cache' \
  -H 'content-type: application/json' \
  -H 'x-oc-api-key: <your API key here>' \
  -d '{
    "name": "my new preset name"
    }'

To delete a preset, simply send a delete request for the preset id you want to delete.

DELTE /presets/<preset id here> HTTP/1.1
Host: api2.online-convert.com
x-oc-api-key: <your API key here>
Content-Type: application/json
Cache-Control: no-cache

To delete a preset, simply send a delete request for the preset id you want to delete.

curl -X DELTE \
  https://api2.online-convert.com/presets/<you preset id here> \
  -H 'cache-control: no-cache' \
  -H 'content-type: application/json' \
  -H 'x-oc-api-key: <your API key here>'


results matching ""

    No results matching ""