OpenAI

Overview

This page discusses how to configure OpenAI as a provider for the AI Writing Assistant AddOn within the Beefree SDK Developer Console. If the AI Writing Assistant AddOn is already enabled for your application, and you'd like to switch providers, take the steps outlined in the Switch Providers section of the AI Writing Assistant page to enable OpenAI as your new provider.

Prerequisites

Prior to getting started, ensure you have the following:

• An OpenAI account and API Key.

• The AI Writing Assistant AddOn enabled in the Beefree SDK Developer Console.

• Beefree SDK .

Configuration Steps

Take the following steps to configure this provider:

1. Log in to the Beefree SDK Developer Console.

2. Navigate to the application with the AI Writing Assistant enabled.

   1. Click Details.

3. Navigate to the AddOns under Application configuration section.

   1. Click View more.

4. Click the Manage Providers tab.

5. Click Add provider.

6. Complete the required information.*

7. Click Save to save your provider configuration.

*Reference the Required Provider Information section of the AI Writing Assistant AddOn page to reference what information is required to configure OpenAI as a provider.

Shared Logic Considerations

Consider the following shared logic when integrating the AI Writing Assistant AddOn and OpenAI as a provider:

• Methods: The methods used for the OpenAI provider are inherited from the AI Writing Assistant AddOn. These include functionality for generating content for supported block types (Title, Paragraph, List, Button) and for handling metadata.

• Events: The integration supports all events from the AI Writing Assistant, such as tracking user actions and processing content generation requests.

• Callbacks: All callbacks associated with the OpenAI provider are inherited from the AI Writing Assistant. They manage notifications for successful or failed content generation attempts.

Additional Considerations

• Billing: Refer to OpenAI’s pricing documentation for more information.