はじめに

認証

すべてのリクエストにAPIキーを付け、ベアラートークンとして送ります。

キーを作る

Settingsを開き、API keysに進みます。キーには、使う場所が分かる名前を付けて作成します。

キーが表示されるのは1回だけです。すぐにコピーして、サーバーの環境変数など、安全な場所に保管してください。Setherionが保存するのはキーのフィンガープリントだけなので、私たちを含め、誰もキーをもう一度表示することはできません。紛失した場合は、そのキーを失効させて、新しく作ってください。

キーはsth_で始まり、そのあとに43文字のランダムな英字、数字、-、_が続き、全部で47文字です。名前は60文字まで使えます。それより長い名前は切り詰められます。

すべてのリクエストに付ける

キーをAuthorizationヘッダーに入れます。

bash
curl https://www.setherion.com/api/v1/projects \
  -H "Authorization: Bearer $SETHERION_API_KEY"
js
const res = await fetch('https://www.setherion.com/api/v1/projects', {
  headers: { Authorization: `Bearer ${process.env.SETHERION_API_KEY}` },
})
const data = await res.json()

読み取られるのはBearer方式だけです。有効なキーがないリクエストには401が返ります。

json
{
  "ok": false,
  "error": "A valid API key is required. Make one on your Setherion account page and send it as \"Authorization: Bearer sth_...\"."
}

ヘッダーがない場合、キーのつづりが違う場合、存在しないキーの場合、失効したキーの場合は、どれも同じ応答が返ります。そのため、どれが原因なのかは分かりません。

キーでできること

キーはあなたとして動作します。Setherionであなたができることは、キーでもできます。

  • ダッシュボードにあるアプリを見る。自分のアプリと、共有されているアプリの両方です。
  • 開けるアプリのアプリストアガイドとプライバシー回答を読む。
  • 編集できるアプリを変更する。エディターでの編集と同じようにクレジットを使います。
  • 編集できるアプリを公開し、そのストアページを書く。

そのほかは、各アプリでのあなたのロールで決まります。読み取る呼び出しにはviewer以上、アプリを変更したりクレジットを使ったりする呼び出しにはeditor以上が必要です。どの呼び出しに何が必要かは、はじめにを参照してください。

キーでは、アカウント、プラン、支払いを変更することはできません。また、キーを作ることも失効させることもできません。それができるのは、あなた自身がSetherionにログインしているときだけなので、キーが1つ漏れても、ほかのキーを作られることはありません。

キーはパスワードと同じように扱ってください。ブラウザーで動くコードや、ほかの人に渡すアプリには、決して入れないでください。リポジトリにコミットするのも避けてください。コードにキーが含まれているアプリは、Setherionが公開をブロックします。

キーを失効させる

API keysで、キーの横にあるRevokeを押します。キーはすぐに使えなくなります。失効したキーは一覧に残るので、最後に使われた日時を確認できます。

有効なキーは同時に10個まで持てます。11個目を作ろうとすると、You have 10 active keys. Revoke one you no longer use to make another.と表示されて拒否されます。一覧には各キーが最後に使われた日時が表示され、更新は1分に1回までです。

キーなしでログインする

AIアシスタントは、キーの代わりに、ログインページと許可ボタンで接続します。MCP:AIアシスタントを接続するを参照してください。

このログインで発行されるトークンが使えるのは、アシスタント用のアドレス(/api/mcp)だけです。このリファレンスのエンドポイントは、APIキーだけを受け付けます。

このページは役に立ちましたか?

コミュニティに参加

質問、アイデア、ほかの人が作っているもの。