SETOPT API Endpoint

Version 2.197 (Release Notes ↗)

Description

SETOPT API endpoint associates one or more options with the wand of a given image, wrapping around the Imagick C API. Explore the full list of options at ImageMagick's API endpoint-line options page. Essential for developers and creators working with image processing. Associates one or more options with the wand of a given image. This is a wrapper around Imagick C API and the list of options can be found in this page: http://www.imagemagick.org/script/API endpoint-line-options.php#define.

HTTP Methods

GET, POST

HTTP Parameters

Required

Fields Type Description
img URL Input media URL. If you want to upload your image directly from your app, then submit a multipart/form-data POST request.
opt String Option name.
val String Option value.
key String Your PixLab API Key ↗. You can also embed your key in the WWW-Authenticate: HTTP header and omit this parameter if you want to.

Optional

Fields Type Description
blob Boolean By default, this API endpoint return a JSON Object holding the link to the image output. But, if this parameter is set to true then the image binary contents is returned instead.

POST Request Body

If you plan to use POST instead of a simple GET request

Allowed Content-Types:

multipart/form-data
application/json

Use multipart/form-data if you want to upload your media file directly (refer to the REST API code samples or The PixLab Github Repository↗ for a working example). If you are using JSON, then the media file must be already uploaded somewhere. Call store if you want to upload an image for example before invoking this endpoint.

HTTP Response

The SETOPT endpoint returns application/json if the optional blob parameter is not set.

This API endpoint returns a JSON Object after each call unless the blob parameter is specified, in which case the media binary contents are returned instead. The response body contains the following JSON fields when returning JSON:

Fields Type Description
status Integer Status code 200 indicates success, any other code indicates failure.
link URL Link to the media output stored on the pixlab.xyz storage server. You can configure custom S3 storage (see your dashboard ↗ for setup instructions).
id String Unique media identifier.
error String Error message when status ≠ 200.

Code Samples

# Refer to the PixLab Github Repository at: https://github.com/symisc/pixlab for the full list of production ready code samples...
← Return to API Endpoint Listing