Export

This page lists and describes the Export category of endpoints within the Content Services API. It also includes interactive testing environments for each endpoint in this category.

HTML

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

This endpoint allows you to retrieve the full or partial HTML output of a template (email, page, or popup).

How It Works

To generate HTML from a template's JSON:

Capture or store the latest JSON output from the builder using such as onChange or autosave.
Send this JSON payload to the HTML endpoint.
Receive the HTML string as the response.

Required Request Payload

{
  "page": {
    "body": { ... },
    ...
  }
}

page (object, required): The full template structure in Beefree JSON format. This is the same structure returned by the builder or captured from its callbacks.

Notes

This endpoint bypasses the need for the onSave callback and can be used at any time post-editing.
Partial HTML rendering is also supported for specific components or modules (if required by your use case).
The output HTML reflects the current rendering engine used by Beefree, ensuring up-to-date compatibility.

Plain Text

Endpoint: /message/plain-text

PDF

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

You can generate a PDF file from valid HTML content using the dedicated PDF generation endpoint. This operation requires a JSON payload with specific fields to configure the output.

Required Request Payload

{
  "page_size": "Full",
  "page_orientation": "landscape",
  "html": "<!DOCTYPE html>...</html>"
}

Field Descriptions

page_orientation (string, required): Sets the orientation of the generated PDF pages. Accepted values:
- "portrait": vertical layout.
- "landscape": horizontal layout.
page_size (string, required): Defines the dimensions of the PDF output. Accepted values:
- "Letter": US Letter format.
- "A4": A4 paper size.
- "A3": A3 paper size.
- "Full": a single continuous page with fixed width (900px) and height determined proportionally to the content.

When using "Letter", "A4", or "A3", the content is automatically split across multiple pages. Using "Full" produces a single, unpaginated scrollable PDF.

Steps to generate a PDF

To generate a PDF from a template:

Call the /html endpoint to retrieve the template's HTML.
Insert that HTML into the "html" field of the request payload.
Set your preferred "page_orientation" and "page_size".
Send the payload to the PDF generation endpoint.

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

This endpoint allows you to generate an image file (for example, PNG) from a template's HTML. You can control the image output by specifying the dimensions.

Required Request Payload

{
  "html": "<!DOCTYPE html>...</html>",
  "width": 800,
  "height": 600
}

Note: As an alternative to providing width and height, you can also provide size.

Rendering

The HTML is rendered using a fixed-size browser window to simulate a real-world preview. Here are the key rendering parameters:

Window Size: 1920 x 1080 pixels (used for clipping/screenshot area)
Default Viewports:
- Mobile: 320px width
- Desktop: 1024px width
Clipping Region: defaults to 1920 x 1080 pixels
Scale Factor: Automatically calculated to match viewport and clipping dimensions.

You may override the clipping size if your layout requires a custom viewport. If your content exceeds the clipping area, it may be cropped. For improved results, using auto height with the size parameter is recommended.

Steps to perform an Image API call

Set the html field in your image request payload to the HTML generated.
Provide a width and height values, or a size value.
Send the payload to the image endpoint.

Name

Type

Description

html*

String

A Beefree HTML message.

size

String

Use “size” instead of “width” and “height” when you only know the width and want the height automatically calculated. Required if width and height are not defined.

width

Integer

The image width in pixels. Required if size is not defined.

height

Integer

The image height in pixels. Default applies a proportional value based on the given width, keeping the image aspect ratio. When the value is not proportional to the given width, either will occur: If it’s higher, the proportional value applies, or, if it’s lower, the image is cropped. Required if size is not defined.

file_type*

String

Accepts jpg or png.

PreviousAuthentication NextConvert

Last updated 11 hours ago

Was this helpful?

Export

HTML

How It Works

Required Request Payload

Notes

Plain Text

PDF

Required Request Payload

Steps to generate a PDF

Image

Required Request Payload

Rendering

Steps to perform an Image API call

HTML

How It Works

Required Request Payload

Notes

Plain Text

PDF

Required Request Payload

Steps to generate a PDF

Image

Required Request Payload

Rendering

Steps to perform an Image API call

Transform HTML into a PDF

Transform HTML into an Image

Transform Beefree JSON into Plain Text

Transform Beefree JSON into HTML