Installing the AI Writing Assistant requires the installation of the Breakdance AI Writing Assistant plugin and an active OpenAI API Key (paid) —this is separate from a ChatGPT license. This guide will guide you through both processes. Please note that the AI Writing Assistant will not work correctly until both keys have been added to your site.
Please note that the AI Writing Assistant requires PHP 8.1+
Installing the AI Writing Assistant
Plugin Installation and Finding the AI Writing Assistant License Key:
- Download the AI Writing Assistant from the Breakdance portal.
- Next, go to the Licenses page in the portal and copy your AI Writing Assistant License Key.
- In WordPress, go to Plugins > Add New Plugin, select the AI Writing Assistant zip file you downloaded, and activate it.
- Go to Breakdance > Settings > AI Writing Assistant in the WordPress Admin Area.
- Paste your AI Writing Assistant License Key in the “License Key” field.
Getting an OpenAI API Key:
- Log into or create an OpenAI account.
- Go to the API Keys page.
- Click the “Create new secret key” button.
- Copy the secret key after it has been created.
- Go to Breakdance > Settings > AI Writing Assistant in the WordPress Admin Area.
- Paste the secret key in the “OpenAI API Key” field.
Congratulations! You should now be able to use the AI Writing Assistant when working in the Breakdance Interface.
Common Issues and Errors:
If you’re having problems with the AI Writing Assistant not working, here are some steps you may take.
Check for OpenAI Errors:
First, check to see if OpenAI has any errors returned when editing in Breakdance. Here are some common ones:
- The model gpt-4-turbo-preview does not exist, and you do not have access to it: This error indicates that you currently don’t have access to the latest gpt-4 models. To access these models, please see the following help article. Additionally, these models require that you’ve spent $5 or more. Otherwise, you will be in the free tier, where only gpt-3.5 is available.
- You exceeded your current quota, please check your plan and billing details. For more information on this error, read the docs: https://platform.openai.com/docs/guides/error-codes/api-errors: This error indicates you have either run out of credits or have hit your monthly quota. Please see the following OpenAI article on how to resolve this issue.
Check WordPress settings:
If OpenAI isn’t returning any errors, it could be due to communication never being sent/received from OpenAI. Here are some ways to check your WordPress Settings:
- Confirm WordPress REST API is enabled: One way to do this is to go to https://yoursite.com/wp-json. If you see information there, this would mean that the REST API is enabled. If you don’t see anything, this would indicate an issue with the REST API. You may also want to check your Site Health page for any issues.
- Enable Permalinks: Go to Settings > Permalinks in the WordPress Admin area and make sure Plain is not selected. Before leaving the page, click on Save Changes to refresh your Permalinks and rewrite/repair your .htaccess file even if you made no changes.
AI Writing Assistant Settings:
The AI Writing Assistant has two settings that can be found at Breakdance > Settings > AI Writing Assistant in the WordPress Admin Area.
- Available For: Choose which user type has access to the AI Writing Assistant. The options are “Full Interface” users, “Edit Content Interface Only” users, and “No Access” users.
- Model: Select the GPT Model you would like to use within Breakdance. Please note that billing rates vary for each model (OpenAI Pricing).
- GPT-4o: Most advanced GPT model.
- GPT-4o mini: Cheapest and lightweight model. (Replaced gpt-3.5-turbo)
AI Endpoints:
Using the AI Endpoints API, it is possible to change the OpenAI Model or use a different AI Provider, such as OpenRouter.
