Flipp REST API (1.0.0)

Download OpenAPI specification:Download

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.

Authentication

Bearer

Create an account on the Flipp website and grab your private API Key from your profile settings.
Once you get the API Key you can perform requests to the Flipp's API.

Add the following header to all requests you make:
Authorization: Bearer API_KEY

Security Scheme Type API Key
Header parameter name: Authorization

Authentication

Get the info about the current user

Authorizations:

Responses

Response samples

Content type
application/json
{
  • "name": "John Doe",
  • "email": "user@example.com"
}

Templates

List all available templates

Authorizations:

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Images

Create Image

Authorizations:
Request Body schema: application/json
template_id
string
Array of objects (DynamicValue)

Responses

Request samples

Content type
application/json
{
  • "template_id": "agds9fnm0",
  • "values": [
    ]
}

Response samples

Content type
application/json
{}

Screenshots

Take Screenshot

Authorizations:
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

Content type
application/json
{
  • "format": "png",
  • "container": "#hero",
  • "full_page": false,
  • "mobile": false,
  • "width": 1440,
  • "height": 1440,
  • "agent": null,
  • "dark": false,
  • "adblock": true,
  • "headers": {
    },
  • "cookies": {
    }
}

Response samples

Content type
application/json