Skip to content

Commit

Permalink
Add the OpenAI guide (#20)
Browse files Browse the repository at this point in the history
  • Loading branch information
fearnoeval authored Feb 16, 2024
1 parent 1add596 commit 0612905
Show file tree
Hide file tree
Showing 9 changed files with 75 additions and 4 deletions.
9 changes: 5 additions & 4 deletions content/docs/introduction/_table.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,11 @@
|||
|-|-|-|
[AWS](/docs/tutorials/aws)|[Airbrake](/docs/tutorials/airbrake)|[Atlassian](/docs/tutorials/atlassian)|
[Azure DevOps](/docs/tutorials/azuredevops)|[Azure Function](/docs/tutorials/azurefunctionkey)|[Azure Storage](/docs/tutorials/azure)|
[GCP](/docs/tutorials/gcp)|[GitHub](/docs/tutorials/github)|[GitLab](/docs/tutorials/gitlab)|
[Mailchimp](/docs/tutorials/mailchimp)|[MaxMind](/docs/tutorials/maxmind)|[Microsoft Teams](/docs/tutorials/microsoftteams)|
[MongoDB](/docs/tutorials/mongo)|[NPM](/docs/tutorials/npm)|[Netlify](/docs/tutorials/netlify)|
[Azure DevOps](/docs/tutorials/azuredevops)|[Azure Function](/docs/tutorials/azurefunctionkey)|[Azure Search Admin](/docs/tutorials/azuresearchadmin)|
[Azure Search Query](/docs/tutorials/azuresearchquery)|[Azure Storage](/docs/tutorials/azure)|[GCP](/docs/tutorials/gcp)|
[GitHub](/docs/tutorials/github)|[GitLab](/docs/tutorials/gitlab)|[Mailchimp](/docs/tutorials/mailchimp)|
[MaxMind](/docs/tutorials/maxmind)|[Microsoft Teams](/docs/tutorials/microsoftteams)|[MongoDB](/docs/tutorials/mongo)|
[NPM](/docs/tutorials/npm)|[Netlify](/docs/tutorials/netlify)|[OpenAI](/docs/tutorials/openai)|
[Sendbird](/docs/tutorials/sendbird)|[Sendgrid](/docs/tutorials/sendgrid)|[Slack Webhook](/docs/tutorials/slack-webhook)|
[Slack](/docs/tutorials/slack)|[Sourcegraph](/docs/tutorials/sourcegraph)|[Square](/docs/tutorials/square)|
[Stripe](/docs/tutorials/stripe)|[Sumo Logic](/docs/tutorials/sumologic)|[Tailscale](/docs/tutorials/tailscale)|
Expand Down
70 changes: 70 additions & 0 deletions content/docs/tutorials/openai.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,70 @@
---
title: OpenAI
---

*This tutorial provides step-by-step instructions on how to rotate an OpenAI API key.*

---

## Generate a new OpenAI API key

### Step 1 - Navigate to the API key page

The API key page is located at https://platform.openai.com/api-keys.
![](/images/openai/1.png)

### Step 2 - Generate a new API key

#### 2a. Click on the `Create new secret key` button

Click the `Create new secret key` button underneath any existing API keys
![](/images/openai/2.png)

#### 2b. Configure the key

Within the `Create new secret key` modal, there are two settings: an optional
`Name` field and `Permissions`. Make any necessary modifications and click the
`Create secret key` button.
![](/images/openai/3.png)

#### 2c. Copy the key

Upon success, a `Save your key` modal will be displayed. Press the `Copy` button
to place it on your clipboard.
![](/images/openai/4.png)

---

## Replace the original OpenAI API key

Replace the original OpenAI API key with the new one in all impacted applications
and services.

---

## Revoke the original OpenAI API key

### Step 1 - Navigate to the API key page

The API key page is located at https://platform.openai.com/api-keys.
![](/images/openai/5.png)

### Step 2 - Revoke the OpenAI API key

#### 2a. Start the revocation process

Identify the API key to be revoked and click the trash can icon associated with
it.
![](/images/openai/6.png)

#### 2b. Confirm the revocation

Within the `Revoke secret key` modal, ensure the correct key is selected and
click the `Revoke key` button.
![](/images/openai/7.png)

---

## Resources
- [OpenAI's API help page](https://help.openai.com/en/collections/3675931-api)
- [OpenAI's Best Practices for API Key Safety](https://help.openai.com/en/articles/5112595-best-practices-for-api-key-safety)
Binary file added themes/compose/static/images/openai/1.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added themes/compose/static/images/openai/2.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added themes/compose/static/images/openai/3.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added themes/compose/static/images/openai/4.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added themes/compose/static/images/openai/5.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added themes/compose/static/images/openai/6.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added themes/compose/static/images/openai/7.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 0612905

Please sign in to comment.