OpenAIでAPIキーを取得する方法

多くのサービスでAPIキーを利用してOpenAI-APIの機能を利用しています。kintoneのAI入力補助プラグイン「Aquarius」でもこのAPIキーが必要になります。

https://www.pulsar-works.jp/aquarius/

ハードルが高いOpenAIのAPIキー取得方法を手順とともに記しました。

# 必要なもの
- メールアドレス
    - アカウント登録に利用します
- クレジットカード
    - 最初のクレジット取得に利用します
    - 最初の登録に必要な金額は$10です

# 方法
具体的な設定方法を説明していきます。やることは以下の通りです。
- OpenAIのアカウントを作成する
- OpenAIプラットホームの画面の確認
- クレジットの取得
- プロジェクトを作る
- プロジェクトに制限値を設定する
- APIキーを作成する

それでは一緒に進めていきましょう。

## OpenAIのアカウントを作成する
👇👇下記URLにアクセスします。

https://platform.openai.com/

OpenAIが展開しているサービス「ChatGPT」とは違いますので、間違えないようにしてください。ここは「OpenAIプラットホーム」というサービスとなります。

![image.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/3712902/b5197fec-b537-b957-ccf0-4b43791cd68f.png)

アクセスしたらサインアップを実施します。Googleなどのソーシャルログインも可能です。

![image.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/3712902/66683f27-1dca-a053-dfff-e2a2babbe67d.png)

組織名はオプションなので、入力の必要はありません。名前と生年月日を入れます。

これでログインは完了です。

## OpenAIプラットホームの画面について
ここで、ログインができたOpenAIプラットホームの画面を見てみます。

### プロジェクト名
![image.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/3712902/3dec199e-22d2-c489-85c5-e6db14478432.png)
現在表示している**プロジェクト名**を表しています。
プロジェクトとは制限をつける単位を指します。詳しくは後述。

### ダッシュボード
![image.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/3712902/4d11ad61-5ca8-e74d-c1a3-21da1692b825.png)
プロジェクト内の状況を確認する画面です。
APIKeyは左のペイン（領域）にあるボタンからアクセスできます。

### 設定
![image.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/3712902/bca165c6-951c-5d1d-a67e-a458462e73f6.png)
設定画面では支払いの状況や利用の制限などを設定することができます。

画面の説明は以上です。

---

## クレジットの取得
$10分のクレジットを取得して、モデルgpt-4oを利用可能にします。
![image.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/3712902/aa678028-6320-6c6d-0309-ee10cd785ffa.png)
設定＞Billing＞Add payment details

![image.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/3712902/ea4d0308-6ea2-9c9e-f7e4-7e22c0e38f7a.png)
ここではIndividualを選びます。

![image.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/3712902/6c829faa-32e2-de11-846e-e20bb0e26663.png)
クレジットカードを登録します。

** **2024-08-28追記** **
$10未満の料金でクレジットカード登録しようとするとエラーになるようです。(2024-08-28現在)
クレジットカードの登録はされるが、先に進めないといった症状。
その場合は、いったん登録をキャンセルします。するとカードはすでに登録済みとなっています。
** **以上** **


クレジットカードを登録すると、「Add to credit balance」が選択できるようになります。
![image.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/3712902/b7a322bd-24bf-7679-2d64-61bd9890f63a.png)
今回は$10追加するので、そのように設定。
支払方法に、先ほど追加したクレジットカードを選びます。




### オートリチャージ
クレジットが枯渇すると、APIキーが使えなくなってしまいます。
プリペイド方式でよければいいのですが、なくなってきたら自動で追加してほしいと思うかもしれません。あるいは、自動請求は嫌なので、常にプリペイド方式がいいと思うかもしれません。その場合の設定です。
![image.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/3712902/260fa94c-227f-577f-54ce-cc13c9227e59.png)
設定＞Billing
Credit balanceに表示されているものが、現在利用できるクレジット量になります。

その下の領域がオートリチャージ設定です。

![image.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/3712902/de050e86-f284-76ca-a8cf-e62115f645b4.png)
この画面の場合は「$5を下回ったら、$10追加してほしい」という設定です。

![image.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/3712902/121bed6f-7691-fec3-cf2b-d721e24ed1a0.png)
オートリチャージを利用したくない場合は、いちばん上のトグルボタンをOFFにします。

これでクレジット登録の説明はおわりです。

---

## プロジェクトを作る
APIキーを作る前にプロジェクトを作ります。
プロジェクトを作ることで、利用するモデルや利用量を制限することができます。
![image.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/3712902/179daaf8-22b6-9edf-6c7b-eab581b15624.png)
設定ボタンを押し、左のペインから「Create project」を選びます。


![image.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/3712902/c70be65a-43b2-00f7-678f-ef11d124daa5.png)
適当な名前を付けてあげます。

![image.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/3712902/56ec09c5-a279-3c76-4950-e66c9cacfecf.png)

プロジェクトの作成に成功すると、Default projectから指定の名前に移動します。

## プロジェクトに制限値を設定する
プロジェクトはデフォルトでは何もできないようになっています。
ここに利用したいモデルを設定します。

![image.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/3712902/493412ad-bd80-a642-e6d1-161517f8d4e3.png)
Select modelsからモデルを選びます。

![image.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/3712902/69d09377-7727-f0c7-702b-b9889880400d.png)
Allowから使いたいモデルを選択します。
今回はgpt-4o, gpt-3.5-turboなどを選びました。

Saveボタンを押して保存します。

![image.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/3712902/6458d4e7-f744-4f70-fe41-2f8991d3bb18.png)
保存されるとこのようになります。


## APIキーを作成する
さあ、APIキーを作りましょう！

![image.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/3712902/915773a8-dddf-2f32-edc3-a340e022d033.png)
ダッシュボード＞API keys＞Create new secret key
と進めます。

![image.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/3712902/bbe2c842-f05a-ad25-8b19-36da13042d6b.png)
今回作成するAPIキーはBotとして外部から実行したいので、Owned byをYouではなく、Service accountに設定します。

また、プロジェクトの設定を間違えないようにしてください。

** **2024-08-28追記** **
サービスアカウントIDは未入力での作成ができなくなったようです。IDは他と重複していなければOKなので、適当な値を入力するようにしてください。
** **以上** **


終わりましたら、Create secret keyを押しますが、**この先の注意をよく読んでください**。

**注意**

![image.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/3712902/d0315bab-fa05-2487-4706-67556d3a868d.png)
この画面で、必ずCopyを押下してAPIキーをクリップボードに記録してください。

**コピーできなかったAPIキーは二度と取得できません。**

かならずコピーを行ってください。

コピーに失敗した場合は、APIキーを消して、作成を最初からやり直します。

# まとめ
おつかれさまでした。最後にはまりやすいポイントをまとめてみました
- クレジットを登録しないと解放できないモデルがある
- クレジットのオートリチャージ機能を確認しよう
- APIキーはプロジェクトに紐づいている
- 利用できるモデルはプロジェクトに設定されている
- APIキーのタイプはService accountを選んでおけばよい
- APIキーは必ずコピーしておく