1 of 1

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:

Log into the Beefree SDK Console
Locate the application that you wish to work with, and click on Details
Locate the Content Services API section and click Create New API Key
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.

Example URLs

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

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

Plain Text

Endpoint: /message/plain-text

PDF

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

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

Merge

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

Merge Rows

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

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

Index

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

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

SMS

v1/ai/sms

Summary

v1/ai/summary

Content Services API Reference

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:

Log into the Beefree SDK Console
Locate the application that you wish to work with, and click on Details
Locate the Content Services API section and click Create New API Key
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.

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

Example URLs

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

Type

Action

Example URL

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

Path parameters

collection*string

The collection ID or name

Body

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

bodyobject

The main structure of the template page

containerobject

Defines the style and structure of the container for the page.

styleobject

The CSS style attributes for the container.

backgroundColorstring

Background color in hexadecimal or other CSS color formats.

Example: "#FFFFFF"

contentobject

Content and styling for the page.

computedStyleobject

Contains computed styles for different elements on the page.

linkColorstring

Color of the link.

Example: "#FF819C"

messageBackgroundColorstring

Background color of the message.

Example: "transparent"

messageWidthstring

The width of the message area.

Example: "675px"

styleobject

General styling for text and fonts.

colorstring

Font color.

Example: "#000000"

fontFamilystring

Font family.

Example: "Arial, Helvetica Neue, Helvetica, sans-serif"

webFontsarray of object

List of external web fonts used in the template.

fontFamilystring

The font-family definition for the web font.

Example: "'Montserrat', 'Trebuchet MS', 'Lucida Grande', 'Lucida Sans Unicode', 'Lucida Sans', Tahoma, sans-serif"

namestring

Name of the web font.

Example: "Montserrat"

urlstring

The URL to the web font.

Example: "https://fonts.googleapis.com/css2?family=Montserrat:wght@400;700&display=swap"

descriptionstring

A description of the template.

Example: "BF-ecommerce-template"

rowsarray of object

Contains all the rows in the page layout.

columnsarray of object

Defines the columns in each row.

gridColumnsinteger

Number of grid columns in the row.

Example: 6

modulesarray of object

Content modules within the column.

moduleDescriptorobject

Descriptor for module styles and attributes.

computedStyleobject

Computed styles specific to this module.

cssClassstring

CSS class for the module.

Example: "left fixedwidth"

widthstring

Width of the module.

Example: "287px"

imageobject

Image properties.

altstring

Alternative text for the image.

Example: "Image"

heightstring

Height of the image.

Example: "142px"

hrefstring

Hyperlink for the image.

Example: "https://beefree.io"

srcstring

Source URL of the image.

Example: "https://ih1.redbubble.net/image.4902607927.7016/flat,750x,075,f-pad,750x1000,f8f8f8.jpg"

widthstring

Width of the image.

Example: "546px"

templateobject

namestring

Template name.

Example: "template-base"

typestring

Template type.

Example: "basic"

versionstring

Template version.

Example: "2.0.0"

titlestring

Title of the template.

Example: "BF-ecommerce-template"

Response

The HTML response

Body

string

Request

Response

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

Body

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.

body*object

containerobject

styleobject

background-colorstring

background-imagestring

background-positionstring

background-repeatstring

background-sizestring

contentobject

computedStyleobject

linkColorstring

messageBackgroundColorstring

messageWidthstring

styleobject

colorstring

font-familystring

rows*array

Array of row definitions inside the template.

template*object

Metadata for the template.

titlestring

Response

A successful response with the plain text document.

Body

string

Request

Response

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

Body

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

A successful response with the PDF document URL.

Body

bodyobject

content_typestring

The MIME type of the PDF file.

filenamestring

The filename of the generated PDF.

page_orientationstring

The orientation of the PDF.

page_sizestring

The size of the generated PDF.

urlstring

The URL where the generated PDF is temporarily hosted.

statusCodeinteger

The HTTP status code of the response.

Request

Response

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

Path parameters

collection*string

The collection ID or name

Body

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

The image response as a binary data in PNG format

Body

any

Request

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

Body

replacearray of object

pathstring

JSON path of the element to replace.

Example: "$..rows[?(@.metadata.uid=='508824c4-8d45-11ee-84be-aafd6b2aca16')]"

valueobject

The new value that will replace the current content.

columnsarray of object

grid-columnsinteger

Example: 4

modulesarray of object

descriptor*object

computedStyleobject

Computed style for the module.

imageobject

Image details and properties.

paragraphobject

Paragraph details and properties.

type*string

Example: "mailup-bee-newsletter-modules-paragraph"

styleobject

Style attributes for the column.

background-colorstring

Example: "transparent"

containerobject

Styling and metadata for the container.

displayConditionobject

Conditions for showing the content.

contentobject

Content metadata and styling.

metadataobject

Metadata for the updated content.

uidstring

Example: "508824c4-8d45-11ee-84be-aafd6b2aca16"

typestring

Example: ""

Response

Successful operation

Body

htmlstring

The transformed HTML output.

jsonobject

The resulting updated JSON structure.

pageobject

The page content and structure.

bodyobject

The body of the page.

rowsarray of object

templateobject

titlestring

commentsobject

Comments associated with the operation.

Request

Response

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

Path parameters

collection*string

The collection ID or name

Body

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

columnsarray of object

grid-columnsinteger

modulesarray of object

descriptor*object

computedStyleobject

paragraphobject

HTML and styling for paragraphs

styleobject

containerobject

contentobject

emptyboolean

lockedboolean

metadataobject

syncedboolean

typestring

uuidstring

template*object

A Beefree template in JSON format

webFontsarray of object

List of available webfonts to rectify missing ones

fontFamilystring

namestring

urlstring

Response

Updated template with merged rows

Body

any

Request

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

Path parameters

collection*string

The collection name.

Body

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.

pageobject

bodyobject

containerobject

styleobject

background-colorstring

Example: "#ffffff"

contentobject

computedStyleobject

linkColorstring

Example: "#7747FF"

messageBackgroundColorstring

Example: "transparent"

messageWidthstring

Example: "600px"

styleobject

colorstring

Example: "#000000"

font-familystring

Example: "Arial, Helvetica, sans-serif"

rowsarray of object

columnsarray of object

grid-columnsinteger

modulesarray of object

descriptorobject

paragraphobject

htmlstring

Example: "<p>I'm a new paragraph block.</p>"

styleobject

colorstring

Example: "#101112"

font-familystring

Example: "'Alegreya', 'Trebuchet MS', Helvetica, sans-serif"

font-sizestring

Example: "16px"

metadataobject

guidstring

Example: "0922fb70-f97e-4ae8-bcfe-0be9fd09a0d5"

syncedboolean

Example: true

webFontsarray of object

fontFamilystring

Example: "'Alegreya', 'Trebuchet MS', Helvetica, sans-serif"

namestring

Example: "Alegreya"

urlstring

Example: "https://fonts.googleapis.com/css2?family=Alegreya:wght@100;200;300;400;500;600;700;800;900"

Response

A successful response with a list of synced rows.

Body

syncedRowsarray of object

rowIdentifierstring

The unique identifier for the row, typically a GUID.

Example: "0922fb70-f97e-4ae8-bcfe-0be9fd09a0d5"

rowIndexinteger

The index of the row inside the template.

Example: 0

Request

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

{
  "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

Path parameters

collection*string

The collection ID or name

Body

JSON payload containing the Beefree template

source*object

A Beefree template in JSON format

Response

An array of metadata objects containing row details

Body

any

Request

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

Body

JSON template and options to generate metadata

optionsobject

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

modelstring

The model to be used for the AI, such as GPT-3.5-turbo.

Example: "gpt-3.5-turbo"

toneOfVoicestring

Defines the tone of voice for the generated metadata, e.g., 'Formal', 'Humorous'.

Example: ""

instructionsstring

Additional instructions to the AI for metadata generation.

Example: "Try to use a pun."

reportUsageboolean

Boolean flag to request usage data from the AI.

Example: true

languagestring

Specify the output language using a valid language code.

Example: ""

templateobject

A JSON object representing the template structure.

pageobject

The main content structure of the template.

bodyobject

The body of the template, including container and content styles.

containerobject

Contains style information for the main container of the template.

styleobject

CSS properties for the container.

background-colorstring (color)

Example: "#fff"

background-imagestring

Example: "none"

background-positionstring

Example: "top left"

background-repeatstring

Example: "no-repeat"

background-sizestring

Example: "auto"

contentobject

Contains computed styles and the main content styles.

computedStyleobject

Computed styles for elements within the content.

linkColorstring (color)

Example: "#8a3b8f"

messageBackgroundColorstring (color)

Example: "transparent"

messageWidthstring

Example: "650px"

styleobject

General style attributes for the content.

colorstring (color)

Example: "#000000"

font-familystring

Example: "Lato, Tahoma, Verdana, Segoe, sans-serif"

typestring

Template type used for identification.

Example: "mailup-bee-page-properties"

webFontsarray of object

List of web fonts used in the template.

fontFamilystring

Example: "'Lato', Tahoma, Verdana, Segoe, sans-serif"

namestring

Example: "Lato"

urlstring

URL to fetch the font.

Example: "https://fonts.googleapis.com/css?family=Lato"

templateobject

Basic information about the template.

namestring

Example: "template-base"

typestring

Example: "basic"

versionstring

Example: "2.0.0"

titlestring

Title of the template.

Example: ""

descriptionstring

Brief description of the template.

Example: ""

rowsarray of object

Array of row objects that define the layout of the template.

columnsarray of object

Defines the grid layout within the row.

grid-columnsinteger

Number of grid columns used.

Example: 12

modulesarray of object

Content modules within the column.

descriptorobject

Module descriptor including styles and attributes.

computedStyleobject

alignstring

Example: "center"

styleobject

padding-topstring

Example: "10px"

padding-bottomstring

Example: "5px"

Response

A JSON object with metadata (preheader and subject).

Body

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.

prompt_tokensinteger

Example: 424

completion_tokensinteger

Example: 48

total_tokensinteger

Example: 472

completion_tokens_detailsobject

Detailed information on completion token usage.

reasoning_tokensinteger

Example: 0

Request

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

{
  "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

Body

optionsobject

modelstring

Example: "gpt-3.5-turbo"

toneOfVoicestring

Specify the tone of voice for the SMS.

lengthenum

Example: "detailed"

concisestandarddetailed

instructionsstring

Extra instructions for the AI.

reportUsageboolean

Example: true

languagestring

Example: "it-IT"

templateobject

pageobject

bodyobject

containerobject

styleobject

background-colorstring

Example: "#fff"

background-imagestring

Example: "none"

background-positionstring

Example: "top left"

background-repeatstring

Example: "no-repeat"

background-sizestring

Example: "auto"

Response

Successful response with SMS.

Body

smsstring

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

usageobject

prompt_tokensinteger

Example: 475

completion_tokensinteger

Example: 87

total_tokensinteger

Example: 562

Request

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

{
  "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

Body

optionsobject

modelstring

Example: "gpt-3.5-turbo"

toneOfVoicestring

Specify the tone of voice for the summary.

lengthenum

Example: "concise"

concisestandarddetailed

instructionsstring

Extra instructions for the AI.

reportUsageboolean

Example: true

languagestring

Example: "it-IT"

templateobject

pageobject

bodyobject

containerobject

styleobject

background-colorstring

Example: "#fff"

background-imagestring

Example: "none"

background-positionstring

Example: "top left"

background-repeatstring

Example: "no-repeat"

background-sizestring

Example: "auto"

Response

Successful response with summary.

Body

summarystring

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

usageobject

prompt_tokensinteger

Example: 425

completion_tokensinteger

Example: 39

total_tokensinteger

Example: 464

Request

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

{
  "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
  }
}

Merge Rows

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

Authorization

Path parameters

collection*string

The collection ID or name

Body

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

columnsarray of object

grid-columnsinteger

modulesarray of object

descriptor*object

computedStyleobject

paragraphobject

HTML and styling for paragraphs

styleobject

containerobject

contentobject

emptyboolean

lockedboolean

metadataobject

syncedboolean

typestring

uuidstring

template*object

A Beefree template in JSON format

webFontsarray of object

List of available webfonts to rectify missing ones

fontFamilystring

namestring

urlstring

Response

Updated template with merged rows

Body

any

Request

Transform JSON Template to HTML

Transform a JSON template into an HTML response.

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

Authorization

Path parameters

collection*string

The collection ID or name

Body

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

bodyobject

The main structure of the template page

containerobject

Defines the style and structure of the container for the page.

styleobject

The CSS style attributes for the container.

backgroundColorstring

Background color in hexadecimal or other CSS color formats.

Example: "#FFFFFF"

contentobject

Content and styling for the page.

computedStyleobject

Contains computed styles for different elements on the page.

linkColorstring

Color of the link.

Example: "#FF819C"

messageBackgroundColorstring

Background color of the message.

Example: "transparent"

messageWidthstring

The width of the message area.

Example: "675px"

styleobject

General styling for text and fonts.

colorstring

Font color.

Example: "#000000"

fontFamilystring

Font family.

Example: "Arial, Helvetica Neue, Helvetica, sans-serif"

webFontsarray of object

List of external web fonts used in the template.

fontFamilystring

The font-family definition for the web font.

Example: "'Montserrat', 'Trebuchet MS', 'Lucida Grande', 'Lucida Sans Unicode', 'Lucida Sans', Tahoma, sans-serif"

namestring

Name of the web font.

Example: "Montserrat"

urlstring

The URL to the web font.

Example: "https://fonts.googleapis.com/css2?family=Montserrat:wght@400;700&display=swap"

descriptionstring

A description of the template.

Example: "BF-ecommerce-template"

rowsarray of object

Contains all the rows in the page layout.

columnsarray of object

Defines the columns in each row.

gridColumnsinteger

Number of grid columns in the row.

Example: 6

modulesarray of object

Content modules within the column.

moduleDescriptorobject

Descriptor for module styles and attributes.

computedStyleobject

Computed styles specific to this module.

cssClassstring

CSS class for the module.

Example: "left fixedwidth"

widthstring

Width of the module.

Example: "287px"

imageobject

Image properties.

altstring

Alternative text for the image.

Example: "Image"

heightstring

Height of the image.

Example: "142px"

hrefstring

Hyperlink for the image.

Example: "https://beefree.io"

srcstring

Source URL of the image.

Example: "https://ih1.redbubble.net/image.4902607927.7016/flat,750x,075,f-pad,750x1000,f8f8f8.jpg"

widthstring

Width of the image.

Example: "546px"

templateobject

namestring

Template name.

Example: "template-base"

typestring

Template type.

Example: "basic"

versionstring

Template version.

Example: "2.0.0"

titlestring

Title of the template.

Example: "BF-ecommerce-template"

Response

The HTML response

Body

string

Request

Response

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

Body

replacearray of object

pathstring

JSON path of the element to replace.

Example: "$..rows[?(@.metadata.uid=='508824c4-8d45-11ee-84be-aafd6b2aca16')]"

valueobject

The new value that will replace the current content.

columnsarray of object

grid-columnsinteger

Example: 4

modulesarray of object

descriptor*object

computedStyleobject

Computed style for the module.

imageobject

Image details and properties.

paragraphobject

Paragraph details and properties.

type*string

Example: "mailup-bee-newsletter-modules-paragraph"

styleobject

Style attributes for the column.

background-colorstring

Example: "transparent"

containerobject

Styling and metadata for the container.

displayConditionobject

Conditions for showing the content.

contentobject

Content metadata and styling.

metadataobject

Metadata for the updated content.

uidstring

Example: "508824c4-8d45-11ee-84be-aafd6b2aca16"

typestring

Example: ""

Response

Successful operation

Body

htmlstring

The transformed HTML output.

jsonobject

The resulting updated JSON structure.

pageobject

The page content and structure.

bodyobject

The body of the page.

rowsarray of object

templateobject

titlestring

commentsobject

Comments associated with the operation.

Request

Response

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();

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();

Get Synced Rows

Retrieve a list of synced rows from a template.

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

Authorization

Path parameters

collection*string

The collection name.

Body

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.

pageobject

bodyobject

containerobject

styleobject

background-colorstring

Example: "#ffffff"

contentobject

computedStyleobject

linkColorstring

Example: "#7747FF"

messageBackgroundColorstring

Example: "transparent"

messageWidthstring

Example: "600px"

styleobject

colorstring

Example: "#000000"

font-familystring

Example: "Arial, Helvetica, sans-serif"

rowsarray of object

columnsarray of object

grid-columnsinteger

modulesarray of object

descriptorobject

paragraphobject

htmlstring

Example: "<p>I'm a new paragraph block.</p>"

styleobject

colorstring

Example: "#101112"

font-familystring

Example: "'Alegreya', 'Trebuchet MS', Helvetica, sans-serif"

font-sizestring

Example: "16px"

metadataobject

guidstring

Example: "0922fb70-f97e-4ae8-bcfe-0be9fd09a0d5"

syncedboolean

Example: true

webFontsarray of object

fontFamilystring

Example: "'Alegreya', 'Trebuchet MS', Helvetica, sans-serif"

namestring

Example: "Alegreya"

urlstring

Example: "https://fonts.googleapis.com/css2?family=Alegreya:wght@100;200;300;400;500;600;700;800;900"

Response

A successful response with a list of synced rows.

Body

syncedRowsarray of object

rowIdentifierstring

The unique identifier for the row, typically a GUID.

Example: "0922fb70-f97e-4ae8-bcfe-0be9fd09a0d5"

rowIndexinteger

The index of the row inside the template.

Example: 0

Request

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

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

Index Rows

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

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

Authorization

Path parameters

collection*string

The collection ID or name

Body

JSON payload containing the Beefree template

source*object

A Beefree template in JSON format

Response

An array of metadata objects containing row details

Body

any

Request

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();

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

Body

optionsobject

modelstring

Example: "gpt-3.5-turbo"

toneOfVoicestring

Specify the tone of voice for the SMS.

lengthenum

Example: "detailed"

concisestandarddetailed

instructionsstring

Extra instructions for the AI.

reportUsageboolean

Example: true

languagestring

Example: "it-IT"

templateobject

pageobject

bodyobject

containerobject

styleobject

background-colorstring

Example: "#fff"

background-imagestring

Example: "none"

background-positionstring

Example: "top left"

background-repeatstring

Example: "no-repeat"

background-sizestring

Example: "auto"

Response

Successful response with SMS.

Body

smsstring

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

usageobject

prompt_tokensinteger

Example: 475

completion_tokensinteger

Example: 87

total_tokensinteger

Example: 562

Request

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

{
  "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
  }
}

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

Body

optionsobject

modelstring

Example: "gpt-3.5-turbo"

toneOfVoicestring

Specify the tone of voice for the summary.

lengthenum

Example: "concise"

concisestandarddetailed

instructionsstring

Extra instructions for the AI.

reportUsageboolean

Example: true

languagestring

Example: "it-IT"

templateobject

pageobject

bodyobject

containerobject

styleobject

background-colorstring

Example: "#fff"

background-imagestring

Example: "none"

background-positionstring

Example: "top left"

background-repeatstring

Example: "no-repeat"

background-sizestring

Example: "auto"

Response

Successful response with summary.

Body

summarystring

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

usageobject

prompt_tokensinteger

Example: 425

completion_tokensinteger

Example: 39

total_tokensinteger

Example: 464

Request

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

{
  "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
  }
}

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

Body

JSON template and options to generate metadata

optionsobject

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

modelstring

The model to be used for the AI, such as GPT-3.5-turbo.

Example: "gpt-3.5-turbo"

toneOfVoicestring

Defines the tone of voice for the generated metadata, e.g., 'Formal', 'Humorous'.

Example: ""

instructionsstring

Additional instructions to the AI for metadata generation.

Example: "Try to use a pun."

reportUsageboolean

Boolean flag to request usage data from the AI.

Example: true

languagestring

Specify the output language using a valid language code.

Example: ""

templateobject

A JSON object representing the template structure.

pageobject

The main content structure of the template.

bodyobject

The body of the template, including container and content styles.

containerobject

Contains style information for the main container of the template.

styleobject

CSS properties for the container.

background-colorstring (color)

Example: "#fff"

background-imagestring

Example: "none"

background-positionstring

Example: "top left"

background-repeatstring

Example: "no-repeat"

background-sizestring

Example: "auto"

contentobject

Contains computed styles and the main content styles.

computedStyleobject

Computed styles for elements within the content.

linkColorstring (color)

Example: "#8a3b8f"

messageBackgroundColorstring (color)

Example: "transparent"

messageWidthstring

Example: "650px"

styleobject

General style attributes for the content.

colorstring (color)

Example: "#000000"

font-familystring

Example: "Lato, Tahoma, Verdana, Segoe, sans-serif"

typestring

Template type used for identification.

Example: "mailup-bee-page-properties"

webFontsarray of object

List of web fonts used in the template.

fontFamilystring

Example: "'Lato', Tahoma, Verdana, Segoe, sans-serif"

namestring

Example: "Lato"

urlstring

URL to fetch the font.

Example: "https://fonts.googleapis.com/css?family=Lato"

templateobject

Basic information about the template.

namestring

Example: "template-base"

typestring

Example: "basic"

versionstring

Example: "2.0.0"

titlestring

Title of the template.

Example: ""

descriptionstring

Brief description of the template.

Example: ""

rowsarray of object

Array of row objects that define the layout of the template.

columnsarray of object

Defines the grid layout within the row.

grid-columnsinteger

Number of grid columns used.

Example: 12

modulesarray of object

Content modules within the column.

descriptorobject

Module descriptor including styles and attributes.

computedStyleobject

alignstring

Example: "center"

styleobject

padding-topstring

Example: "10px"

padding-bottomstring

Example: "5px"

Response

A JSON object with metadata (preheader and subject).

Body

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.

prompt_tokensinteger

Example: 424

completion_tokensinteger

Example: 48

total_tokensinteger

Example: 472

completion_tokens_detailsobject

Detailed information on completion token usage.

reasoning_tokensinteger

Example: 0

Request

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

{
  "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
    }
  }
}