API Documentation For Featherify

You will find the documentation below handy if you wish to use the API for Featherify.

BASE URL

https://dtam87cvk4.execute-api.us-east-2.amazonaws.com/production

URL

/api/manipulate

Method:

POST

Headers

{ 'content-type': 'multipart/form-data' }

URL Params

None

Data Params

`images`

type: array

items: [File]

`urls`

type: array

items: [string]

`config`

type: string ( css or base64 )

`width`

type: integer (between 5 and 100)

`height`

type: integer (between 5 and 100)

Success Response:

Code: 200

If config was base64

Content:

[
    {
        base64: string, // the base64 generated data
        name: string, // name of the image
        uuid: string // random uuid that can be used as a key
    }
]

If config was css

Content

[
    {
        styles: { // the generated css styles
            backgroundImage: string,
            backgroundPosition: string,
            backgroundSize: string
        },
        name: string, // name of the image
        uuid: string, // random uuid which can be used as a key
    }
]

IMPORTANT: If config is css, you need to add backgroundRepeat: 'no-repeat and filter:blur(8px). This should be done to avoid seeing big pixel boxes.

Error Response:
- Code: 400 BAD REQUEST
  Content: { <error-field> : string }

Notes:

If the featherify server could fail to process the image or the failed to get the url data, you would get the 200 response, but the corresponding image for that file would not be generated.

You would get a response like this:

[
    .
    .
    {
        error:  string
    }
    .
    .
]

adityamitra