Try it outMCP ServerBook a demoCookbook

AI Collection

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

AI Collection endpoints are part of the Content Services API. The Content Services API is available on Beefree SDK plans that are Essentials or above.

Overview

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

Important: collection is a placeholder within the URL. This placeholder can be replaces with any of the collection options available for the AI Collection resource. Reference the AI Collection Resource and Collection Options table for a list of available option.

Available Collection Value for AI Endpoints

The following table lists the collection values available in this category of endpoints, and their corresponding collection options.

Note: The only collection value available for this category of endpoints is ai. Therefore, all {collection} placeholders in the URL in this category should be replaced with ai.

Prior to referencing the table, the following example shows how you can replace the {collection} placeholder with ai.

How to Replace the {collection} Placeholder

The following example URL has a {collection} placeholder. This placeholder needs to be filled in with a Collection Option prior to making an API call.

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

As an example, if you'd like to generate SMS text using this endpoint, replace {collection} with ai.

The final URL to make the API call will be:

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

The following table provides a comprehensive reference of all available options based on what you'd like to generate.

Resource
Collection Options

/sms

  • /ai

/metadata

  • /ai

/summary

  • /ai

Prerequisites

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

Note: Charges from your AI Provider are separate from those from Beefree SDK.

Metadata (Preheader and Subject)

v1/ai/metadata

Generate Preheader and Subject Metadata with AI

post

Use AI and this endpoint to generate metadata, which includes preheaders and subject lines, automatically.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
collectionstringRequired

The collection ID or name

Body
Responses
200

Successful response

application/json
Responseobject
post
/v1/{collection}/metadata

SMS

v1/ai/sms

Generate SMS with AI

post

Submit your JSON template as the request body to generate a custom SMS using AI.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
collectionstringRequired

The collection ID or name

Body
Responses
200

Successful response

application/json
Responseobject
post
/v1/{collection}/sms

Summary

v1/ai/summary

Generate a Summary with AI

post

Submit your JSON template as the request body to generate a custom and concise summary using AI.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
collectionstringRequired

The collection ID or name

Body
Responses
200

Successful response

application/json
Responseobject
post
/v1/{collection}/summary
PreviousRow ProcessingNextBrand Style

Last updated

Was this helpful?