Setup Guide

This guide walks you through creating an OpenAI account and generating an API key required to use the OpenAI connector.

Prerequisites

• An OpenAI account. If you do not have one, sign up at platform.openai.com.

Step 1: Log in to the OpenAI Platform

1. Visit platform.openai.com.
2. Sign in with your credentials or create a new account.

Step 2: Create a project

1. Select your profile icon in the top-right corner.

2. In the dropdown menu, select Your Profile.

   

3. Navigate to the Projects section from the sidebar.

   

4. Select Create Project and provide a name.

   

Step 3: Create an API key

1. Navigate to the API Keys section from the sidebar and select + Create new secret key.

   

2. Provide a name for the key (for example, Connector Key), select your project, and confirm.

   

3. Copy the generated API key immediately — it will not be shown again.

   

warning

Store the API key securely. Do not commit it to source control. Use Ballerina's configurable feature and a Config.toml file to supply it at runtime.

What's next

• Action reference: Available operations