diff --git a/docs/docs.json b/docs/docs.json index 9b2d3a02b..4b6cbd695 100644 --- a/docs/docs.json +++ b/docs/docs.json @@ -722,6 +722,7 @@ "group": "Openai", "pages": [ "plugins/openai/overview", + "plugins/openai/get-credentials", "plugins/openai/api", "plugins/openai/database" ] diff --git a/docs/plugins/openai/get-credentials.mdx b/docs/plugins/openai/get-credentials.mdx new file mode 100644 index 000000000..1592c4393 --- /dev/null +++ b/docs/plugins/openai/get-credentials.mdx @@ -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 +``` + +## 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). \ No newline at end of file