Content Services API Reference

The Content Services API Reference provides a comprehensive guide to utilizing the Content Services API, which leverages the REST architecture and HTTP protocol for making API calls. This reference document outlines the available collections, including /message, /page, /popup, /amp, /template, and /ai, detailing the resources for each collection. For every resource, this document includes its description, parameters, and example responses and requests.

API Key

To use the Content Services API you will first need to obtain a your API Key from the Beefree SDK Console.

To obtain an API Key, take the following steps:

1. Log into the Beefree SDK Console

2. Locate the application that you wish to work with, and click on Details

3. Locate the Content Services API section and click Create New API Key

4. Acknowledge the message that reminds you that if you exceed the number of API calls included in your plan, you may be charged for overages and click Create Key

Your API key will appear under the Content services API section of your application details.

The Content Services API uses API Keys to authenticate requests for resources. You can manage your API Keys within the Beefree SDK Console. All requests must be made over HTTPS and contain the following HTTP Header:

Authorization: Bearer {token}

Rate Limits

API requests rate limits exist independently of API key’s monthly usage allowance.

By default, the API has the following rate limits:

• Per minute: 500 requests

• Per second: 100 requests

• X-Rate-Limit: An integer representing the total number of requests available per cycle. Exceeding the limit per cycle results in a 429 error. (e.g. 500)

• X-Rate-Limit-Remaining: An integer representing the number of remaining requests before the next cycle begins, and the count resets. (e.g. 100)

• X-Rate-Limit-Reset: A Unix timestamp representing the time the next cycle will begin, and the count will reset.

• Retry-After: A Unix timestamp representing the time the application may resume submitting requests.

API Root

All API access is over HTTPS, and accessed from the following URL:

https://api.getbee.io/v1/{collection}/{resource}

Collections

The following table lists the available collection option and corresponding resources for each collection.

Collection	Available Resources
/message	html, pdf, images, merge, index, plain-text
/page	html, pdf, images, merge, index
/popup	html
/amp	html
/template	brand
/ai	metadata, sms, summary

Example URLs

The following table provides a few examples of URLs you can use to make specific types of requests.

Type	Action	Example URL
Email	Request HTML for email	https://api.getbee.io/v1/message/html
Landing Page	Request HTML for a landing page	https://api.getbee.io/v1/page/html
Popup	Request HTML for a popup	https://api.getbee.io/v1/popup/html
AMP	Request HTML for AMP	https://api.getbee.io/v1/amp/html

Resources

The following section provides detailed information for each of the resources associated with each collection mentioned in the previous section.

HTML

URL: https://api.getbee.io/v1/{collection}/html

Transform JSON Template to HTML

Transform a JSON template into an HTML response.

POSThttps://api.getbee.io/v1/{collection}/html

Authorization

bearerAuth

Path parameters

collection*string

The collection ID or name

Body

application/json

JSON payload with the template

beautifyHtmlEnabledboolean

Flag to return beautified HTML

languagestring

For multi-language templates, sets the output language using a valid language code

page*object

A BeeFree template in JSON format

Response

200

The HTML response

Body

text/html

string

Request

JavaScriptCurlPython

const response = await fetch('https://api.getbee.io/v1/{collection}/html', {
    method: 'POST',
    headers: {
      "Authorization": "Bearer Enter Dev Console API Key as Bearer token",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "page": {}
    }),
});
const data = await response.json();

Response

200

text

Plain Text

Endpoint: /message/plain-text

Generate Plain Text

This endpoint accepts a JSON template to create a plain text version of an email.

POSThttps://api.getbee.io/v1/message/plain-text

Authorization

bearerAuth

Body

application/json

Parameters required to generate plain text from a template.

languagestring

Optional. The output language for multi-language templates.

page*object

The template's JSON used to create the plain text document.

Response

200400

A successful response with the plain text document.

Body

text/plain

string

Request

JavaScriptCurlPython

const response = await fetch('https://api.getbee.io/v1/message/plain-text', {
    method: 'POST',
    headers: {
      "Authorization": "Bearer Enter Dev Console API Key as Bearer token",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "language": "it-IT",
      "page": {
        "body": {
          "container": {
            "style": {
              "background-color": "#fff",
              "background-image": "none",
              "background-position": "top left",
              "background-repeat": "no-repeat",
              "background-size": "auto"
            }
          },
          "content": {
            "computedStyle": {
              "linkColor": "#8a3b8f",
              "messageBackgroundColor": "transparent",
              "messageWidth": "650px"
            },
            "style": {
              "color": "#000000",
              "font-family": "Lato, Tahoma, Verdana, Segoe, sans-serif"
            }
          }
        },
        "rows": [
          {
            "columns": [
              {
                "grid-columns": 12,
                "modules": [
                  {
                    "descriptor": {
                      "computedStyle": {
                        "align": "center",
                        "hideContentOnMobile": false
                      },
                      "divider": {
                        "style": {
                          "border-top": "0px solid transparent",
                          "height": "10px",
                          "width": "100%"
                        }
                      },
                      "style": {
                        "padding-bottom": "0px",
                        "padding-left": "0px",
                        "padding-right": "0px",
                        "padding-top": "0px"
                      }
                    },
                    "locked": false,
                    "type": "mailup-bee-newsletter-modules-divider",
                    "uuid": "b89c3d25-dbec-439a-8ad1-4939a28678e9"
                  }
                ],
                "style": {
                  "background-color": "transparent",
                  "border-bottom": "0px solid transparent",
                  "border-left": "0px solid transparent",
                  "border-right": "0px solid transparent",
                  "border-top": "0px solid transparent",
                  "padding-bottom": "0px",
                  "padding-left": "0px",
                  "padding-right": "0px",
                  "padding-top": "0px"
                },
                "uuid": "3bd72010-5175-4326-b848-8beacea852d6"
              }
            ]
          }
        ],
        "template": {
          "name": "template-base",
          "type": "basic",
          "version": "2.0.0"
        },
        "title": ""
      }
    }),
});
const data = await response.json();

Response

200

text

PDF

URL: https://api.getbee.io/v1/{collection}/pdf

Generate PDF

This endpoint accepts HTML and settings to generate a PDF document and provides a URL for the PDF.

POSThttps://api.getbee.io/v1/{collection}/pdf

Authorization

bearerAuth

Body

application/json

Parameters required to generate a PDF from HTML.

file_type*enum

The file type for the output.

PDF

html*string

A full HTML document to be transformed into a PDF.

page_orientation*enum

The orientation of the PDF page.

landscapeportrait

page_size*enum

The size of the PDF page.

letterA4A3Full

Response

200400

A successful response with the PDF document URL.

Body

application/json

bodyobject

statusCodeinteger

The HTTP status code of the response.

Request

JavaScriptCurlPython

const response = await fetch('https://api.getbee.io/v1/{collection}/pdf', {
    method: 'POST',
    headers: {
      "Authorization": "Bearer Enter Dev Console API Key as Bearer token",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "html": "<!DOCTYPE html><html lang='en'><head><meta charset='UTF-8'><title>PDF Output</title></head><body style='font-family: Arial, sans-serif;'><header style='text-align: center; margin-top: 20px;'><h1 style='font-size: 36px; color: #4CAF50;'>The Incredible World of Cats</h1></header><main style='margin: 40px;'><p style='font-size: 18px; line-height: 1.6;'>Cats are truly fascinating creatures...</p></main></body></html>",
      "page_orientation": "landscape",
      "page_size": "Full"
    }),
});
const data = await response.json();

Response

200

{
  "body": {
    "content_type": "text",
    "filename": "text",
    "page_orientation": "text",
    "page_size": "text",
    "url": "text"
  },
  "statusCode": 0
}

Note: The response is a JSON string that will contain the URL of the temporary location of the PDF document. The file is available for 24 hours.

Image

URL: https://api.getbee.io/v1/{collection}/image

Transform HTML to Image

Transform HTML and image settings into an image.

POSThttps://api.getbee.io/v1/{collection}/image

Authorization

bearerAuth

Path parameters

collection*string

The collection ID or name

Body

application/json

JSON payload with HTML message and image settings

file_type*string

Accepts jpg or png

heightinteger

The image height in pixels

html*string

A BeeFree HTML message

sizestring

Image size if width and height are not defined

widthinteger

The image width in pixels

Response

200

The image response as a binary data in PNG format

Body

image/png

any

Request

JavaScriptCurlPython

const response = await fetch('https://api.getbee.io/v1/{collection}/image', {
    method: 'POST',
    headers: {
      "Authorization": "Bearer Enter Dev Console API Key as Bearer token",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "file_type": "png",
      "html": "<!DOCTYPE html><html lang='en'><head><meta charset='utf-8'><title>Simple HTML</title></head><body><h1>Hello World!</h1><p>This is a simple HTML response.</p></body></html>",
      "size": "1000"
    }),
});
const data = await response.json();

Merge

URL: https://api.getbee.io/v1/{collection}/merge

Merge to replace content

Replace or update content in the template using a specific path and value.

POSThttps://api.getbee.io/v1/{collection}/merge

Authorization

bearerAuth

Body

application/json

replacearray of object

Response

200400

Successful operation

Body

application/json

htmlstring

The transformed HTML output.

jsonobject

The resulting updated JSON structure.

Request

JavaScriptCurlPython

const response = await fetch('https://api.getbee.io/v1/{collection}/merge', {
    method: 'POST',
    headers: {
      "Authorization": "Bearer Enter Dev Console API Key as Bearer token",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

200

{
  "html": "text",
  "json": {
    "page": {
      "rows": [],
      "title": "text"
    }
  }
}

Merge Rows

URL: https://api.getbee.io/v1/{collection}/merge-rows

Merge Rows

The Merge Rows endpoint enables you to integrate custom fonts and resized images into your designs. It saves custom fonts within the template's JSON, ensuring the correct font is displayed. It also handles image resizing, particularly when the image's initial template width is narrower than the saved row's destination template. To use this endpoint, send your template and rows in JSON format. You will receive a response with an updated template. The rows requiring an update are identified by their rowIdentifier values.

POSThttps://api.getbee.io/v1/{collection}/merge-rows

Authorization

bearerAuth

Path parameters

collection*string

The collection ID or name

Body

application/json

JSON payload with the template and rows

rowIdentifierLabelstring

Label for identifying rows, usually GUID

rows*array of object

An array of Beefree rows in JSON format

template*object

A Beefree template in JSON format

webFontsarray of object

List of available webfonts to rectify missing ones

Response

200

Updated template with merged rows

Body

application/json

any

Request

JavaScriptCurlPython

const response = await fetch('https://api.getbee.io/v1/{collection}/merge-rows', {
    method: 'POST',
    headers: {
      "Authorization": "Bearer Enter Dev Console API Key as Bearer token",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "rowIdentifierLabel": "guid",
      "rows": [
        {
          "columns": [
            {
              "grid-columns": 12,
              "modules": [
                {
                  "descriptor": {
                    "computedStyle": {
                      "hideContentOnAmp": false,
                      "hideContentOnDesktop": false,
                      "hideContentOnHtml": false,
                      "hideContentOnMobile": false
                    },
                    "paragraph": {
                      "computedStyle": {
                        "linkColor": "#7747FF",
                        "paragraphSpacing": "16px"
                      },
                      "html": "<p>Updated paragraph block.</p>",
                      "style": {
                        "color": "#101112",
                        "direction": "ltr",
                        "font-family": "'Alegreya', 'Trebuchet MS', Helvetica, sans-serif",
                        "font-size": "16px",
                        "font-weight": "400",
                        "letter-spacing": "0px",
                        "line-height": "120%",
                        "text-align": "left"
                      }
                    },
                    "style": {
                      "padding-bottom": "10px",
                      "padding-left": "10px",
                      "padding-right": "10px",
                      "padding-top": "10px"
                    }
                  },
                  "locked": false,
                  "type": "mailup-bee-newsletter-modules-paragraph",
                  "uuid": "29cd2a3d-fd76-4537-a91b-b8cb9872d8a3"
                }
              ],
              "style": {
                "background-color": "transparent",
                "border-bottom": "0px solid transparent",
                "border-left": "0px solid transparent",
                "border-right": "0px solid transparent",
                "border-top": "0px solid transparent",
                "padding-bottom": "5px",
                "padding-left": "0px",
                "padding-right": "0px",
                "padding-top": "5px"
              },
              "uuid": "56119ad2-574d-4122-8dd1-c1152b5f4879"
            }
          ]
        }
      ],
      "template": {
        "page": {
          "body": {
            "container": {
              "style": {
                "background-color": "#ffffff"
              }
            },
            "content": {
              "computedStyle": {
                "linkColor": "#7747FF",
                "messageBackgroundColor": "transparent",
                "messageWidth": "600px"
              },
              "style": {
                "color": "#000000",
                "font-family": "Arial, Helvetica, sans-serif"
              }
            },
            "webFonts": [
              {
                "fontFamily": "'Alegreya', 'Trebuchet MS', Helvetica, sans-serif",
                "name": "Alegreya",
                "url": "https://fonts.googleapis.com/css2?family=Alegreya:wght@100;200;300;400;500;600;700;800;900"
              },
              {
                "fontFamily": "'Arvo', 'Courier New', Courier, monospace",
                "name": "Arvo",
                "url": "https://fonts.googleapis.com/css2?family=Arvo:wght@100;200;300;400;500;600;700;800;900"
              }
            ]
          }
        },
        "title": ""
      }
    }),
});
const data = await response.json();

When utilizing this feature, it's important to consider adding a handle to the metadata. This handle serves a crucial role in functions such as onDeleteRow and onEditRow. In our provided example, we use a handle named guid. However, users have the flexibility to choose their own handle name according to their preferences and requirements. When selecting a handle name, we recommend you choose something descriptive and meaningful for ease of identification and management within your workflow.

Synced Rows

URL: https://api.getbee.io/v1/{collection}/synced-rows

Get Synced Rows

Retrieve a list of synced rows from a template.

POSThttps://api.getbee.io/v1/{collection}/synced-rows

Authorization

bearerAuth

Path parameters

collection*string

The collection name.

Body

application/json

Parameters for the synced rows request.

rowIdentifierLabel*string

The label used for identifying the rows added to the metadata key, usually GUID.

template*object

The JSON structure of the template.

Response

200400

A successful response with a list of synced rows.

Body

application/json

syncedRowsarray of object

Request

JavaScriptCurlPython

const response = await fetch('https://api.getbee.io/v1/{collection}/synced-rows', {
    method: 'POST',
    headers: {
      "Authorization": "Bearer Enter Dev Console API Key as Bearer token",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "rowIdentifierLabel": "guid",
      "template": {
        "page": {
          "body": {
            "container": {
              "style": {
                "background-color": "#ffffff"
              }
            },
            "content": {
              "computedStyle": {
                "linkColor": "#7747FF",
                "messageBackgroundColor": "transparent",
                "messageWidth": "600px"
              },
              "style": {
                "color": "#000000",
                "font-family": "Arial, Helvetica, sans-serif"
              }
            }
          },
          "rows": [
            {
              "columns": [
                {
                  "grid-columns": 12,
                  "modules": [
                    {
                      "descriptor": {
                        "paragraph": {
                          "html": "<p>I'm a new paragraph block.</p>",
                          "style": {
                            "color": "#101112",
                            "font-family": "'Alegreya', 'Trebuchet MS', Helvetica, sans-serif",
                            "font-size": "16px"
                          }
                        }
                      }
                    }
                  ],
                  "metadata": {
                    "guid": "0922fb70-f97e-4ae8-bcfe-0be9fd09a0d5"
                  },
                  "synced": true
                }
              ]
            }
          ]
        },
        "webFonts": [
          {
            "fontFamily": "'Alegreya', 'Trebuchet MS', Helvetica, sans-serif",
            "name": "Alegreya",
            "url": "https://fonts.googleapis.com/css2?family=Alegreya:wght@100;200;300;400;500;600;700;800;900"
          }
        ]
      }
    }),
});
const data = await response.json();

Response

200

{
  "syncedRows": [
    {
      "rowIdentifier": "0922fb70-f97e-4ae8-bcfe-0be9fd09a0d5",
      "rowIndex": 0
    }
  ]
}

Index

URL: https://api.getbee.io/v1/{collection}/merge/index

Index Rows

Reference an array of metadata objects from a Beefree template in JSON format.

POSThttps://api.getbee.io/v1/{collection}/merge/index

Authorization

bearerAuth

Path parameters

collection*string

The collection ID or name

Body

application/json

JSON payload containing the Beefree template

source*object

A Beefree template in JSON format

Response

200

An array of metadata objects containing row details

Body

application/json

any

Request

JavaScriptCurlPython

const response = await fetch('https://api.getbee.io/v1/{collection}/merge/index', {
    method: 'POST',
    headers: {
      "Authorization": "Bearer Enter Dev Console API Key as Bearer token",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "source": {
        "page": {
          "body": {
            "container": {
              "style": {
                "background-color": "#FFFFFF"
              }
            },
            "content": {
              "computedStyle": {
                "linkColor": "#FF819C",
                "messageBackgroundColor": "transparent",
                "messageWidth": "675px"
              },
              "style": {
                "color": "#000000",
                "font-family": "Arial, 'Helvetica Neue', Helvetica, sans-serif"
              }
            },
            "type": "mailup-bee-page-properties",
            "webFonts": [
              {
                "fontFamily": "'Montserrat', 'Trebuchet MS', 'Lucida Grande', 'Lucida Sans Unicode', 'Lucida Sans', Tahoma, sans-serif",
                "name": "Montserrat",
                "url": "https://fonts.googleapis.com/css?family=Montserrat"
              }
            ]
          },
          "description": "<p>BF-ecommerce-template</p>",
          "rows": [
            {
              "columns": [
                {
                  "grid-columns": 6,
                  "modules": [
                    {
                      "descriptor": {
                        "computedStyle": {
                          "class": "center fixedwidth",
                          "width": 338
                        },
                        "image": {
                          "alt": "Image",
                          "href": "https://beefree.io",
                          "src": "https://d1oco4z2z1fhwp.cloudfront.net/templates/default/113/logo_1.png"
                        },
                        "style": {
                          "padding-bottom": "0px",
                          "padding-left": "15px",
                          "padding-right": "15px",
                          "padding-top": "5px",
                          "width": "100%"
                        }
                      },
                      "locked": false,
                      "type": "mailup-bee-newsletter-modules-image"
                    },
                    {
                      "descriptor": {
                        "computedStyle": {
                          "align": "center",
                          "hideContentOnMobile": true
                        },
                        "divider": {
                          "style": {
                            "border-top": "0px solid transparent",
                            "height": "20px",
                            "width": "100%"
                          }
                        },
                        "style": {
                          "padding-bottom": "10px",
                          "padding-left": "10px",
                          "padding-right": "10px",
                          "padding-top": "10px"
                        }
                      },
                      "locked": false,
                      "type": "mailup-bee-newsletter-modules-divider"
                    }
                  ],
                  "style": {
                    "background-color": "transparent",
                    "padding-bottom": "0px",
                    "padding-left": "0px",
                    "padding-right": "0px",
                    "padding-top": "30px"
                  }
                }
              ],
              "container": {
                "style": {
                  "background-color": "#FF819C",
                  "background-image": "none",
                  "background-position": "top left",
                  "background-repeat": "no-repeat"
                }
              },
              "content": {
                "computedStyle": {
                  "hideContentOnDesktop": false,
                  "hideContentOnMobile": false,
                  "rowColStackOnMobile": true
                },
                "style": {
                  "background-color": "transparent",
                  "color": "#333",
                  "width": "675px"
                }
              },
              "locked": false,
              "metadata": {
                "guid": "test3",
                "name": "demo3"
              },
              "type": "two-columns-empty"
            }
          ],
          "template": {
            "name": "template-base",
            "type": "basic",
            "version": "2.0.0"
          },
          "title": "BF-ecommerce-template",
          "__$markdownParsed": true
        }
      }
    }),
});
const data = await response.json();

AI Collection

The resources in the AI collection accept your template JSON and use generative AI to return text within a JSON object to you.

Prerequisites

Prior to getting started with the resources in this collection, ensure you have the following:

• Superpowers subscription or higher

• OpenAI AddOn installed and configured in your Beefree Developer Console

• Content Services API key

Note: OpenAI billing costs apply in addition to the Content Services API billing.

Metadata (Preheader and Subject)

v1/ai/metadata

Generate Metadata (Preheader and Subject)

The endpoint accepts a JSON template and returns a JSON object with metadata.

POSThttps://api.getbee.io/v1/ai/metadata

Authorization

bearerAuth

Body

application/json

JSON template and options to generate metadata

optionsobject

Optional settings that provide additional instructions to the AI for metadata generation.

templateobject

A JSON object representing the template structure.

Response

200

A JSON object with metadata (preheader and subject).

Body

application/json

preheaderstring

Preheader text for the email.

Example: "Ready to Bee a part of our user research project? Schedule your interview now!"

subjectstring

Subject line for the email.

Example: "BEE Pro: Let's Bee-gin! Join our user research project 🐝"

usageobject

Information about the token usage in the AI request.

Request

JavaScriptCurlPython

const response = await fetch('https://api.getbee.io/v1/ai/metadata', {
    method: 'POST',
    headers: {
      "Authorization": "Bearer Enter Dev Console API Key as Bearer token",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

200

{
  "preheader": "Ready to Bee a part of our user research project? Schedule your interview now!",
  "subject": "BEE Pro: Let's Bee-gin! Join our user research project 🐝",
  "usage": {
    "prompt_tokens": 424,
    "completion_tokens": 48,
    "total_tokens": 472,
    "completion_tokens_details": {
      "reasoning_tokens": 0
    }
  }
}

SMS

v1/ai/sms

Generate SMS from Template

This endpoint accepts a JSON template and options to generate a custom SMS.

POSThttps://api.getbee.io/v1/ai/sms

Authorization

bearerAuth

Body

application/json

optionsobject

templateobject

Response

200

Successful response with SMS.

Body

application/json

smsstring

Example: "Ciao! Ti interessa partecipare a un progetto di ricerca utente con noi? Sarà una videochiamata di 30-45 minuti."

usageobject

Request

JavaScriptCurlPython

const response = await fetch('https://api.getbee.io/v1/ai/sms', {
    method: 'POST',
    headers: {
      "Authorization": "Bearer Enter Dev Console API Key as Bearer token",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

200

{
  "sms": "Ciao! Ti interessa partecipare a un progetto di ricerca utente con noi? Sarà una videochiamata di 30-45 minuti.",
  "usage": {
    "prompt_tokens": 475,
    "completion_tokens": 87,
    "total_tokens": 562
  }
}

Summary

v1/ai/summary

Generate Summary from Template

This endpoint accepts a JSON template and options to generate a concise summary.

POSThttps://api.getbee.io/v1/ai/summary

Authorization

bearerAuth

Body

application/json

optionsobject

templateobject

Response

200

Successful response with summary.

Body

application/json

summarystring

Example: "Vuoi partecipare a un progetto di ricerca utente con BEE Pro? Rispondi a Dalila per prenotare un colloquio video."

usageobject

Request

JavaScriptCurlPython

const response = await fetch('https://api.getbee.io/v1/ai/summary', {
    method: 'POST',
    headers: {
      "Authorization": "Bearer Enter Dev Console API Key as Bearer token",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

200

{
  "summary": "Vuoi partecipare a un progetto di ricerca utente con BEE Pro? Rispondi a Dalila per prenotare un colloquio video.",
  "usage": {
    "prompt_tokens": 425,
    "completion_tokens": 39,
    "total_tokens": 464
  }
}