認証
Studio で Direct API のキーを作成し、スコープとクレジット上限を選んで、すべてのリクエストに付けて送信します。
すべてのリクエストには、組織の API キーをベアラートークンとして含めます。
Authorization: Bearer mor_live_9f2c…キーは作成した人ではなく組織に属します。組織の管理者は誰でもキーを確認して無効化でき、作成者がチームを離れてもキーは引き続き機能します。キーが無効化されたとき、有効期限が切れたとき、作成者のアカウントが停止されたとき、または Morphic が組織の Direct API を無効にしたときに、キーは機能しなくなります。
キーを作成する
Direct API のスコープは、Morphic が組織で Direct API を有効にした後にのみ表示されます。利用を開始する をご覧ください。
- Morphic Studio で組織のドロップダウン（左上の Morphic ロゴ）を開き、「設定」を選択します。
- 左サイドバーで「APIキー」をクリックします。このタブは管理者にのみ表示されます。
- 「新しいキー」をクリックします。
- 「名前」を入力し、キーに必要な「スコープ」を選びます。無期限にしない場合は「有効期限」も指定します。
- 「クレジット上限」で、キーが累計で消費できる上限を設定します。必要に応じて日次と月次の上限も設定します。
- 「Morphic 利用規約（開発者向け API のセクションを含む）に同意します」にチェックを入れます。これにより、組織として 利用規約 に同意したことになります。
- 「キーを作成」をクリックし、シークレットをシークレットマネージャーにコピーします。シークレットは一度しか表示されません。
シークレットを持つ人は誰でも、キーの上限まで組織のクレジットを消費できます。キーをブラウザ、モバイルアプリ、公開リポジトリに含めないでください。
キーの形式
mor_live_<64 hex characters>プレフィックスによって、お客様とシークレットスキャナーは、キーがどのデプロイメント用かを判別できます。
スコープ
キーが利用できるのは、そのスコープが許可するツールだけです。必要最小限のスコープを選んでください。
| スコープ | Studio での表示 | 許可される操作 |
|---|---|---|
projects:read | プロジェクトとそのファイルを読み取る | プロジェクト、ワークフロー、Compose タイムラインの一覧表示 |
assets:read | アセットを検索・読み取る | ライブラリの一覧表示、生成とそのステータスの読み取り、キャラクター |
assets:write | アセットをアップロード・編集する | URL によるメディアの受け渡し、Compose タイムラインの作成 |
generations:write | 画像・動画・音声を生成する（クレジットを消費） | メディアの生成開始、編集、分析を行うすべてのツール |
キーのスコープ外のツールを呼び出すと 403 insufficient_scope が返り、不足しているスコープが data.required_scopes に示されます。list_voices や /me のようにスコープを必要としないエンドポイントとツールは、すべてのキーで利用できます。各ツールに必要なスコープは ツールカタログ に記載しています。
クレジット上限
すべてのキーには、作成時に設定する消費上限があります。管理者は後から「上限を編集」で変更できます。
| 上限 | 必須 | 期間 |
|---|---|---|
total_credit_limit | はい | キーの存続期間全体 |
monthly_credit_limit | いいえ | 暦月（UTC） |
daily_credit_limit | いいえ | 暦日（UTC） |
- いずれかの上限を超える有料の呼び出しは、何も開始されないうちに
402 api_key_credit_limit_reachedで拒否されます。どの上限かはdata.periodに示されます。 - 組織自体の残高も適用されます。残高で支払えない呼び出しは
402 insufficient_creditsで拒否されます。 GET /v1/direct/meは、キーの上限と現在の消費額を返します。クレジットと使用量 をご覧ください。
キーをローテーションする
- 新しいキーを作成します。
- 新しいキーをデプロイします。
- 古いキーを「キーを無効化」で無効にします。
組織は最大 10 個の有効なキーを保持できるため、ローテーション中に空白期間は生じません。
何かお困りのことやご質問がありましたら、お気軽にご連絡ください。喜んでお手伝いします。こちらまでご連絡ください support@morphic.com.