OpenAI Setup Guide
Provides your agent with access to OpenAI models (GPT-5, GPT-5.2, etc.) using your own API key.
Prerequisites
- An OpenAI account with billing enabled at platform.openai.com
Step 1: Create an API Key
- Go to platform.openai.com/api-keys
- Click Create new secret key
- Optionally name the key (e.g., "Carapace Agent")
- Copy the key (starts with
sk-) — it's shown only once
Step 2: Connect in Carapace
- Go to Dashboard > Connections
- Find OpenAI and click Connect
- Paste the API key
- Click Save Credentials
Credential Fields Reference
| Field | Required | Format | Description |
|---|---|---|---|
api_key | Yes | Starts with sk- | OpenAI API secret key |
Gotchas
Key shown only once: If you lose the key, generate a new one. Old keys can be revoked from the same page.
Billing must be enabled: API keys without an active billing plan will receive 429 rate limit errors. Ensure your OpenAI account has a payment method and sufficient credits.
Project keys: Newer OpenAI keys may start with sk-proj- instead of just sk-. Both formats work.