Skip to content

Commit 0612905

Browse files
authored
Add the OpenAI guide (#20)
1 parent 1add596 commit 0612905

File tree

9 files changed

+75
-4
lines changed

9 files changed

+75
-4
lines changed

content/docs/introduction/_table.md

+5-4
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,11 @@
11
|||
22
|-|-|-|
33
[AWS](/docs/tutorials/aws)|[Airbrake](/docs/tutorials/airbrake)|[Atlassian](/docs/tutorials/atlassian)|
4-
[Azure DevOps](/docs/tutorials/azuredevops)|[Azure Function](/docs/tutorials/azurefunctionkey)|[Azure Storage](/docs/tutorials/azure)|
5-
[GCP](/docs/tutorials/gcp)|[GitHub](/docs/tutorials/github)|[GitLab](/docs/tutorials/gitlab)|
6-
[Mailchimp](/docs/tutorials/mailchimp)|[MaxMind](/docs/tutorials/maxmind)|[Microsoft Teams](/docs/tutorials/microsoftteams)|
7-
[MongoDB](/docs/tutorials/mongo)|[NPM](/docs/tutorials/npm)|[Netlify](/docs/tutorials/netlify)|
4+
[Azure DevOps](/docs/tutorials/azuredevops)|[Azure Function](/docs/tutorials/azurefunctionkey)|[Azure Search Admin](/docs/tutorials/azuresearchadmin)|
5+
[Azure Search Query](/docs/tutorials/azuresearchquery)|[Azure Storage](/docs/tutorials/azure)|[GCP](/docs/tutorials/gcp)|
6+
[GitHub](/docs/tutorials/github)|[GitLab](/docs/tutorials/gitlab)|[Mailchimp](/docs/tutorials/mailchimp)|
7+
[MaxMind](/docs/tutorials/maxmind)|[Microsoft Teams](/docs/tutorials/microsoftteams)|[MongoDB](/docs/tutorials/mongo)|
8+
[NPM](/docs/tutorials/npm)|[Netlify](/docs/tutorials/netlify)|[OpenAI](/docs/tutorials/openai)|
89
[Sendbird](/docs/tutorials/sendbird)|[Sendgrid](/docs/tutorials/sendgrid)|[Slack Webhook](/docs/tutorials/slack-webhook)|
910
[Slack](/docs/tutorials/slack)|[Sourcegraph](/docs/tutorials/sourcegraph)|[Square](/docs/tutorials/square)|
1011
[Stripe](/docs/tutorials/stripe)|[Sumo Logic](/docs/tutorials/sumologic)|[Tailscale](/docs/tutorials/tailscale)|

content/docs/tutorials/openai.md

+70
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,70 @@
1+
---
2+
title: OpenAI
3+
---
4+
5+
*This tutorial provides step-by-step instructions on how to rotate an OpenAI API key.*
6+
7+
---
8+
9+
## Generate a new OpenAI API key
10+
11+
### Step 1 - Navigate to the API key page
12+
13+
The API key page is located at https://platform.openai.com/api-keys.
14+
![](/images/openai/1.png)
15+
16+
### Step 2 - Generate a new API key
17+
18+
#### 2a. Click on the `Create new secret key` button
19+
20+
Click the `Create new secret key` button underneath any existing API keys
21+
![](/images/openai/2.png)
22+
23+
#### 2b. Configure the key
24+
25+
Within the `Create new secret key` modal, there are two settings: an optional
26+
`Name` field and `Permissions`. Make any necessary modifications and click the
27+
`Create secret key` button.
28+
![](/images/openai/3.png)
29+
30+
#### 2c. Copy the key
31+
32+
Upon success, a `Save your key` modal will be displayed. Press the `Copy` button
33+
to place it on your clipboard.
34+
![](/images/openai/4.png)
35+
36+
---
37+
38+
## Replace the original OpenAI API key
39+
40+
Replace the original OpenAI API key with the new one in all impacted applications
41+
and services.
42+
43+
---
44+
45+
## Revoke the original OpenAI API key
46+
47+
### Step 1 - Navigate to the API key page
48+
49+
The API key page is located at https://platform.openai.com/api-keys.
50+
![](/images/openai/5.png)
51+
52+
### Step 2 - Revoke the OpenAI API key
53+
54+
#### 2a. Start the revocation process
55+
56+
Identify the API key to be revoked and click the trash can icon associated with
57+
it.
58+
![](/images/openai/6.png)
59+
60+
#### 2b. Confirm the revocation
61+
62+
Within the `Revoke secret key` modal, ensure the correct key is selected and
63+
click the `Revoke key` button.
64+
![](/images/openai/7.png)
65+
66+
---
67+
68+
## Resources
69+
- [OpenAI's API help page](https://help.openai.com/en/collections/3675931-api)
70+
- [OpenAI's Best Practices for API Key Safety](https://help.openai.com/en/articles/5112595-best-practices-for-api-key-safety)
83.9 KB
Loading
84 KB
Loading
57.3 KB
Loading
73.7 KB
Loading
88.9 KB
Loading
88.6 KB
Loading
69.3 KB
Loading

0 commit comments

Comments
 (0)