Skip to content
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions docs/docs.json
Original file line number Diff line number Diff line change
Expand Up @@ -722,6 +722,7 @@
"group": "Openai",
"pages": [
"plugins/openai/overview",
"plugins/openai/get-credentials",
"plugins/openai/api",
"plugins/openai/database"
]
Expand Down
32 changes: 32 additions & 0 deletions docs/plugins/openai/get-credentials.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
---
title: Get Credentials
description: Step-by-step instructions for obtaining OpenAI API credentials.
---

## Authentication Method

- **[`api_key`](/concepts/api-key)** - OpenAI API key

## API Key Setup

### Step 1: Get Your API Key

1. Log in to [OpenAI Platform](https://platform.openai.com)
2. Open **API keys** from the left sidebar
3. Select **Create new secret key** and give it a name
4. Copy the key and store it securely
5. Add billing and credits as needed — API calls require paid usage

**Storing Credentials:**

```bash
pnpm corsair setup --plugin=openai api_key=your-api-key
```
Comment thread
yuvanvk marked this conversation as resolved.

## Required Credentials Summary

| Credential | Required For | Where to Find |
|-----------|--------------|---------------|
| API Key | All API calls | OpenAI Platform → API keys |

For general information about how Corsair handles authentication, see [Authentication](/concepts/auth).