Skip to main content

​
Overview

The OpenAI BYOK connector lets you use your own OpenAI API key with Workshop. Usage is billed directly to your OpenAI account.
Published apps use your API key. If you publish a Workshop app that uses this connector, visitors make requests using your key. You will be billed by OpenAI for all usage.
Don’t have an API key? The managed OpenAI connector is enabled by default — no API key needed, usage billed to your Workshop credits.

​
What You’ll Need

CredentialDescriptionFormat
API KeyOpenAI API authentication keysk-proj-...

​
Getting an API Key

1

Access the OpenAI platform

Go to platform.openai.com and sign in or create an account.
2

Set up billing

Click Settings > Billing, add a payment method, and add credits (minimum $5). Billing is required before the API key will work.
3

Navigate to API Keys

Click API keys in the sidebar, or go directly to platform.openai.com/api-keys.
4

Create a key

Click Create new secret key, enter a name (e.g., “Workshop Access”), and optionally select a project.
5

Copy the key

Copy your key immediately. OpenAI only shows it once — if you lose it, you’ll need to generate a new one.

​
Connecting to Workshop

1

Open the Hub

Open the Workshop Hub from the sidebar.
2

Go to Connectors

Click the Connectors tab.
3

Select OpenAI

Click the OpenAI (your API key) card.
4

Enter details

Enter a Connection Name (e.g., “My OpenAI Account”) and paste your API Key.
5

Save

Click Add Connection.
Your OpenAI account is now connected and available across all conversations.

​
Verifying Your Connection

Ask Workshop: 
List the available OpenAI models
If Workshop returns a list of models, your connection is working.

​
Security Best Practices

  • Your API key is stored in Workshop’s encrypted storage — never shared with the AI agent directly
  • Rotate keys periodically at platform.openai.com/api-keys
  • Use OpenAI projects to organize keys by application
  • If you suspect a key is compromised, delete it immediately in your OpenAI settings and create a new one

​
Troubleshooting

IssueSolution
”Invalid API key”Verify the full key was copied. Ensure format is sk-proj-....
”Insufficient quota”Check billing at platform.openai.com. Add credits if needed.
”Rate limit exceeded”Wait and retry. Check rate limits in your OpenAI dashboard.
”Model not found”Verify model access. Some models require special access or are in limited beta.

​
Learn More