Flipp REST API (1.0.0)
Download OpenAPI specification:Download
E-mail: contact@useflipp.com Terms of Service
Flipp is a marketing image automation tool that lets you to generate unique social media visuals using simple REST API.
How does it work?
Flipp helps you to save time on making repeating design. Once you made a template with our advanced editor, you can integrate it with your app and make unique social media banners for every single page on your website.
Create Image
Authorizations:
Bearer
Request Body schema: application/json
| template_id | string |
Array of objects (DynamicValue) |
Responses
Request samples
- Payload
Content type
application/json
{- "template_id": "agds9fnm0",
- "values": [
- {
- "name": "title",
- "value": "Here goes dynamic value",
- "color": "#ff00aa",
- "backgroundColor": "#ff00aa"
}
]
}Response samples
- 200
Content type
application/json
{- "width": 1200,
- "height": 630,
- "type": "twitter",
- "created_at": "2019-08-24T14:15:22Z"
}
Take Screenshot
Authorizations:
Bearer
Request Body schema: application/json
| url required | string Destination URL |
| format | string Enum: "jpeg" "png" Output image format |
| container | string DOM element selector |
| full_page | boolean Capture full page from top to bottom |
| mobile | boolean Emulate mobile viewport and User Agent |
| width | integer <int32> Viewport width |
| height | integer <int32> Page height. Ignored when capturing full page |
| agent | string Browser User-Agent header |
| dark | boolean Force dark mode preference |
| adblock | boolean Block advertisement on the page |
object Extra browser headers | |
| cookies | object Extra browser cookies |
Responses
Request samples
- Payload
Content type
application/json
{- "format": "png",
- "container": "#hero",
- "full_page": false,
- "mobile": false,
- "width": 1440,
- "height": 1440,
- "agent": null,
- "dark": false,
- "adblock": true,
- "headers": {
- "X-API-Key": "Xmasj380am"
}, - "cookies": {
- "flipp_session": "cm39iar09i3rica039rimc39air9a3c"
}
}Response samples
- 200
Content type
application/json
{
}Create Link
Authorizations:
Bearer
Request Body schema: application/json
| template_id | string |
| url | string |
Array of objects (DynamicValue) |
Responses
Request samples
- Payload
Content type
application/json
{- "template_id": "agds9fnm0",
- "values": [
- {
- "name": "title",
- "value": "Here goes dynamic value",
- "color": "#ff00aa",
- "backgroundColor": "#ff00aa"
}
]
}Response samples
- 200
Content type
application/json
{
}