API の概要
ワークスペースをコードから
ご自身のデプロイ向けの REST API で、名前付きの API キーで利用します。以下はすべて、サーバーが実際に適用している OpenAPI ドキュメントから生成しています。
99件の操作
18の分野
33種類のスコープ
251 人が持てるキーの数
できること
API の分野
それぞれの分野は、開発者向けページのその操作にリンクしています。
Profileプロフィール2 件の操作操作を見る →BotsBot11 件の操作操作を見る →Conversations会話8 件の操作操作を見る →Runs実行4 件の操作操作を見る →Routinesルーティン10 件の操作操作を見る →Triggersトリガー9 件の操作操作を見る →Responsibilities担当業務9 件の操作操作を見る →Approvals承認5 件の操作操作を見る →Memoryメモリー4 件の操作操作を見る →MCPMCP5 件の操作操作を見る →Audit監査1 件の操作操作を見る →Tasksタスク6 件の操作操作を見る →Skillsスキル6 件の操作操作を見る →Filesファイル9 件の操作操作を見る →Signed links署名付きリンク1 件の操作操作を見る →Short-lived tokens短時間有効なトークン1 件の操作操作を見る →Boundaries境界5 件の操作操作を見る →Batchバッチ3 件の操作操作を見る →
認証
名前付きのキーを 1 つ、すべてのリクエストに
- ワークスペースの設定 › API キーでキーを作成します。キーは
obk_で始まり、表示されるのは一度だけです。 - キーは作成した人として動き、それ以上の権限は持ちません。その人の現在の役割とアクセス権がリクエストごとに確認されます。
- 各キーは作成時に選んだスコープだけを持ち、有効期限を設定できます。
- キーでキーを作成したり無効にしたりすることはできません。
curl -H "Authorization: Bearer $api_key" \
https://<your-deployment>/api/meほかの使い方
通常のリクエストのほかに
制限
| 1 つのアドレスからのキー認証失敗の上限(期間あたり) | 20 |
|---|---|
| すべてのアドレスを合わせたキー認証失敗の上限(期間あたり) | 500 |
| 期間の長さ(分) | 10 |
| キーに設定できる最長の有効期限(日) | 3650 |
上限を超えると、サーバーは Retry-After ヘッダー付きの 429 を返します。スクリプトの約束ごと、ページ送り、絞り込みは開発者向けページにあります。