Image

Request

Fields when send to the api inside a request.

Field Type Description
resolutions [Resolution] Array of Resolution
white_background Bool Optional. A boolean value

Response

Fields when returned by the api in a response.

Field Type Description
resolutions [Resolution] Array of Resolution
file_id Int? Nullable. An integer value
white_background Bool Optional. A boolean value

Examples

Request

When used inside a request.

Example 1 

{
    "resolutions": [
        {
            "src": "https://example.com",
            "width": 600,
            "height": 350
        },
        {
            "src": "https://example.com",
            "width": 600,
            "height": 350
        },
        {
            "src": "https://example.com",
            "width": 600,
            "height": 350
        }
    ],
    "white_background": true
}

Response

When returned in a response.

Example 1 

{
    "resolutions": [
        {
            "src": "https://example.com",
            "width": 600,
            "height": 350
        },
        {
            "src": "https://example.com",
            "width": 600,
            "height": 350
        },
        {
            "src": "https://example.com",
            "width": 600,
            "height": 350
        }
    ],
    "file_id": 14,
    "white_background": true
}
This is a development version Do not use this version in production
1.10.0 development