Content Services API
Learn more about the Content Services API offering in Beefree SDK.
Beefree SDK API Offering
Beefree SDK includes a comprehensive API offering designed to expand upon the builder's capabilities. By leveraging Beefree SDK's APIs, you can extend the builder's functionality into other aspects of your application.
Beefree SDK's API offering includes three APIs. They are the following:
This section of the documentation discusses the Content Services API, which includes resources for exporting, converting, processing, and styling templates within Beefree SDK as well as managing the files your end users store in the File Manager. This collection of resources extends the functionality of the builder to offer your end users a complete content creation solution.
Export, convert, and style templates and rows. Manage the files and folders in your end users' File Manager storage. Use AI to generate metadata, SMS, and summaries.
✅ Yes, see authentication instructions.

Overview of Content Services API
The Content Services API is a REST-based API that enables Beefree SDK integrators to programmatically manipulate template JSON. It is built to follow predictable resource url patterns, and to utilize standard HTTP response codes and methods.
Beefree SDK requires that you authenticate prior to accessing the Content Services API's resources. You can generate API keys for both production and development applications. API keys associated with development applications are intended for pre-production environments and endpoint testing. They should not be used in production environments.
There are seven categories of resources within the Content Services API. Each of these categories includes a group of endpoints with resources to support various workflows.
These categories are the following:
Export: Services that allow users to extract content into various formats (such as HTML, PDF, or image files), making it easy to repurpose or distribute designs across different platforms.
Convert: Tools that transform content from one format to another (for example, converting template JSON to HTML ). This enables compatibility with different systems and workflows.
AI Collection: AI-powered capabilities for text generation, such as creating metadata for emails, summarizing content, or creating SMS messages.
Row Processing: Services that operate at the structural level, such as analyzing, modifying, or extracting specific rows or sections within a design for granular control over the content layout.
Brand Style: Resources focused on enforcing or applying brand guidelines, including applying consistent colors, typography, and spacing rules to ensure brand integrity across all generated content.
Check: Perform checks on email, page, and row content. Report design feedback to end users.
File Manager: Services that manage the files and folders in your end users' File Manager storage, including listing, searching, uploading, moving, and deleting, from your own server.
The following diagram displays each of the five categories within the Content Services API, and their corresponding resources.

Use Cases and Capabilities
This section provides a high level overview of the Content Services API's capabilities, and lists a few scenarios in which this API is particularly helpful.
Export Different Formats
One of the most common use cases for the Content Services API is exporting different format types. Once your end users complete their designs within the no-code builder, they'll want to export their designs and distribute them. That is where the Export category stands out. By using this category of endpoints, you can provide your end users with the option to export their no-code designs in HTML, plain text, PDF, or image formats.
Your end users may want to export their templates into various formats in the following scenarios:
HTML: For sending email campaigns, publishing landing pages, or embedding pop-ups.
Plain Text: For accessibility, compatibility with text-only email clients, improved deliverability, and compliance with communication regulations.
PDF: For attaching designs to emails, SMS, WhatsApp, printing hard copies, or creating flyers, while preserving the design's layout.
Image: For creating visual galleries, dashboards, social media posts, internal presentations, or campaign planning visuals.
Visit the Export API documentation to learn more.
Convert Content
Another common use case of the Content Services API is converting one format to another. The formats in the Convert category differ from those in the Export category, and serve a separate purpose. This category of endpoints is for creating designs and loading them within the builder.
These endpoints allow you to:
Page to Email: Convert existing page templates into email templates. This saves your end users time by allowing them to use their favorite designs across multiple content channels.
Email to Page: Convert existing email templates into page templates. This saves your end users time by allowing them to use their favorite designs across multiple content channels.
Simple to Full JSON: Convert an AI-generated Simple Schema into full Beefree JSON that can be loaded within the builder for your end users to edit.
Full JSON to Simple JSON: Convert the full JSON of a Beefree SDK template into Simple Schema JSON.
Visit the Convert API documentation to learn more.
AI Collection
This category of endpoints requires that you configure an AI Provider within the Beefree SDK Developer Console. Through the integration with your AI Provider, these endpoints generate the following supporting details for your end users templates:
SMS: Generates concise text versions (e.g., promotional SMS).
Metadata: Generates subject lines and preheaders based on a template's content.
Summary: Generate summaries based on a template's content.
Visit the AI Collection API documentation to learn more.
Row Processing
These endpoints manage rows within templates to maintain consistency and reduce redundancy:
Index: List saved rows available.
Merge: Merge row updates across multiple templates. Particularly useful when applying global updates.
Synced Rows: Retrieve a list of synced rows available.
Visit the Row Processing API documentation to learn more.
Brand Style Management
Brand consistency can be enforced or retroactively applied across templates:
/templates and /rows endpoints allow updating visual properties (colors, fonts, spacings, etc.) across multiple templates or rows based on defined brand styles.
Visit the Brand Style Management API documentation to learn more.
Check
The Check group of endpoints enables you to provide content feedback to your end users directly within the builder. With the Check endpoints, you can inform your end users when their emails, pages, or rows are missing valuable information (for example, links for Calls-to-Action), before they export their designs.
You can use these endpoints to provide feedback on:
Email designs
Page designs
Rows within designs
Visit the Check API documentation to learn more.
File Manager
The File Manager group of endpoints lets your application manage an end user's files and folders from your own server, without opening a builder. They act on the same file system the File Manager displays inside the editor, so anything your application changes through the API is what your end users see the next time they open it.
This means your application can do anything your end users can do to their own files: create folders, upload, search, move, and delete.
You can use these endpoints to:
Integrate asset management into agentic workflows. When an agent or your own pipeline produces an image, upload it by URL and the file is fetched server-side. Agents can also search an end user's existing files and retrieve their URLs.
Provision an account before its first design. Create folders and load brand assets during signup, so a new end user opens the builder to their own imagery instead of an empty File Manager.
Move in an existing asset library. If your end users already have files elsewhere in your product, upload them into the File Manager once and they're available in every design from then on.
Build asset search into your own product. Search an end user's files by name, anywhere beneath a path you set, and render the results anywhere you need them.
Clean up storage on your own terms. Remove an end user's files and folders whenever you need to, deleting assets from churned end users instead of continuing to pay for CDN traffic those assets might still be generating.
These endpoints require your end user's storage to run on the most recent File Manager storage backend.
Visit the File Manager API documentation to learn more.
Base URL
All API access is over HTTPS, and accessed from the following URL:
You can reference each resource and its corresponding collection options in the following section.
The File Manager category is the exception to this pattern. Its endpoints address a file or a directory rather than a fixed resource, so they take the following form instead:
Reference the File Manager Paths section to learn more.
Collections by Category
Each of the following category pages include a table in the page's overview section. This table includes a list of all the possible collection values for that respective category.
The following list includes links to each of the table for the category.
File Manager Paths
The File Manager category doesn’t use collection values. Instead of naming a collection and a resource, a File Manager URL carries the path of the file or directory you want to act on, inside the storage of one of your end users.
Everything after /v1/file/ is that path, and it can be any depth. A trailing slash decides whether the request addresses a directory or a file, so POST /v1/file/campaigns/ creates a folder while POST /v1/file/campaigns/hero.jpg uploads a file into it.
Which end user's storage a request applies to is set by a header rather than by the URL. Visit the File Manager API documentation to learn more about paths, headers, and the six available operations.
Example URLs
The following table provides a few examples of URLs you can reference as an example for making specific types of requests.
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
Pop-up
Request HTML for a pop-up
https://api.getbee.io/v1/popup/html
AMP
Request HTML for AMP
https://api.getbee.io/v1/amp/html
File Manager
List the files in an end user's directory
https://api.getbee.io/v1/file/campaigns/
Rate Limits
API requests rate limits exist independently of API key’s monthly usage allowance.
Beefree SDK applies rate limits per application, with a separate request budget for each group of endpoints below, rather than one shared limit across every call. Your plan tier sets the default budget per group; Enterprise customers can also request custom per-application limits for any group.
Limits by group and plan
Image & PDF Export
/v1/{collection}/image, /v1/{collection}/pdf
50 req / 60s
100 req / 60s
HTML Importer
/v1/conversion/html-to-json
50 req / 60s
100 req / 60s
Template Catalog
/v1/catalog/*
500 req / 60s
1,000 req / 60s
MCP
/v2/sdk/mcp/template*
500 req / 60s
1,000 req / 60s
General
All endpoints not covered by Renderer, HTML Importer, Template Catalog, or MCP above
500 req / 60s
1,000 req / 60s
Plan tiers: Standard includes Essentials, Core, and Superpowers plans. Enterprise is its own tier with higher default limits.
Development applications: All development applications of the same parent application share one rate-limit budget per group. This budget is separate from the parent application’s own budget, so development traffic never reduces production capacity.
X-Rate-Limit, X-Rate-Limit-Remaining: These reflect the status of the specific endpoint group your request belongs to. For example, a call to a Renderer endpoint reports the Renderer group’s limit and remaining count, not an account-wide total. Since the headers describe the call you just made, you can tell which group’s budget they refer to by which endpoint you called.
Retry-After: The number of seconds to wait before sending another request to the same group.
X-Rate-Limit-Reset: The number of milliseconds until the current window resets.
Strategies for Managing Rate Limits
To stay within the default limits and ensure reliable delivery, the following practices are recommended. These not only help distribute traffic more evenly but also provide resilience against transient network issues:
Monitor rate limit headers and handle 429 responses gracefully. Response metadata reflects the remaining capacity and reset timing for the specific group your request hit, not a global total across all groups. When receiving a
429 Too Many Requests, it’s best to pause requests and retry after the time specified in theRetry-Afterheader.Use exponential backoff. On retries, apply an exponentially increasing delay with a small random variation. This helps prevent synchronized retry storms that can worsen congestion.
Throttle traffic using a queue. In applications that generate burst traffic or scale horizontally, a request queue with rate-based throttling can smooth spikes and prevent exceeding per-second or per-minute thresholds.
Debounce high-frequency updates. Debouncing can be especially effective in scenarios like autosaving. For example, it's not typically necessary to request new HTML after every change.
Cache repeated GET requests.
Short-lived caching for frequently accessed data helps reduce redundant requests and conserves rate limit capacity.
Monitor usage patterns. Set up alerting for repeated 429 errors to catch rate limit issues early. Monitoring request patterns can also help anticipate scale needs.
Batch bulk file operations carefully. File Manager requests are billed and rate limited like any other Content Services API call, and deleting is one call per file. A directory is only removed once it is empty, so clearing a large library runs to as many calls as there are files, plus one for each folder. Throttle bulk cleanup and bulk syncing jobs, and schedule them outside your peak editing hours.
FAQs
Reference the answers to the most frequently asked questions in this section.
What is the pricing by plan type?
The Content Services API allows you to carry out a number of useful tasks, like converting an email or a page into a thumbnail image or a PDF document, or updating a footer into all the emails that use it (for example, a saved row).
These tasks consume resources in our Amazon Web Services environment, so we have to account for that. We did extensive research to define pricing that is consistent with other APIs.
Here is a quick summary:
Essentials
15,000
$0.01
Core
50,000
$0.01
Superpowers
250,000
$0.003
Enterprise
Custom
Custom
How will charges appear on my bill?
An additional charge, CSAPI, will be added to your current subscription plan invoice. When you activate the Content Services API, your billing statement will change, and you'll notice a new line item on your Beefree SDK invoice for the service.
Can I use different payment methods for each app?
The Content Services API is provided as a component for your current subscription and the charges will be applied to the subscription payment method. Currently, there is no option to use an alternative payment method specific to these charges.
How do you calculate request limits?
Rate limits are calculated per application, per endpoint group, based on your plan tier (see Rate Limits). In addition, all endpoints share a limit of 100 requests per second per IP address, checked before authentication.
Last updated
Was this helpful?

