API リファレンス
REST API のすべての操作の、パラメーター、リクエストボディ、レスポンスです。デプロイメントが /api/openapi.json で提供するものと同じ OpenAPI ドキュメントから生成しています。開発者ページの説明どおり名前付きキーで認証してください。各操作には必要なスコープを記載しています。
操作一覧このセクションへのリンクをコピー
- Profileプロフィール
- BotsBot
- GET
/api/agents - POST
/api/agents - GET
/api/agents/model-options - GET
/api/agents/{agentId} - PATCH
/api/agents/{agentId} - DELETE
/api/agents/{agentId} - GET
/api/agents/{agentId}/history - GET
/api/agents/{agentId}/tests - POST
/api/agents/{agentId}/tests - DELETE
/api/agents/{agentId}/tests/{testId} - POST
/api/agents/{agentId}/tests/run
- GET
- Conversations会話
- Runs実行
- Routinesルーティン
- Triggersトリガー
- GET
/api/routines/{id}/triggers - POST
/api/routines/{id}/triggers - DELETE
/api/routines/{id}/triggers/{triggerId} - GET
/api/responsibilities/{id}/triggers - POST
/api/responsibilities/{id}/triggers - PATCH
/api/responsibilities/triggers/{triggerId} - DELETE
/api/responsibilities/triggers/{triggerId} - PUT
/api/responsibilities/triggers/{triggerId}/enabled - POST
/api/responsibilities/triggers/{triggerId}/secret
- GET
- Responsibilities担当業務
- Approvals承認
- Memoryメモリー
- MCPMCP
- Audit監査
- Tasksタスク
- Skillsスキル
- Filesファイル
- POST
/api/computers/{botId}/files/list - POST
/api/computers/{botId}/files/read - POST
/api/computers/{botId}/files/search - GET
/api/computers/{botId}/files/download - POST
/api/computers/{botId}/files/upload - POST
/api/computers/{botId}/files/write - POST
/api/computers/{botId}/files/mkdir - POST
/api/computers/{botId}/files/move - POST
/api/computers/{botId}/files/delete
- POST
- Signed links署名付きリンク
- Short-lived tokens短時間有効なトークン
- Boundaries境界
- Batchバッチ
共通ヘッダーこのセクションへのリンクをコピー
Idempotency-Key | header | string (長さ ≥ 1, 長さ ≤ 255) Your id for this request, often a UUID. A repeat within 24 hours gets the first answer, marked Idempotent-Replayed: true.このリクエストに付けるあなたの ID で、多くは UUID です。24 時間以内に同じ ID で送ると最初の応答が返り、Idempotent-Replayed: true が付きます。 |
|---|
Profileプロフィールこのセクションへのリンクをコピー
GET /api/me The person the key belongs toキーの持ち主 read:profile
Requires the read:profile scope (or admin).
read:profile スコープ(または admin)が必要です。
operationId getMe · #
レスポンス
200 成功しました。
application/jsonobject
userobjectobject
idstringemailstringnamestring または nullrole次のいずれか:"admin","user"
GET /api/integration API version, build, available features and this key's own settingsAPI のバージョン、ビルド、利用できる機能とこのキー自身の設定 read:profile
For a start-up check: the API version and build, which optional areas run (one that is off answers 404 or 503), the key's scopes and limit, and the server's clock.
Requires the read:profile scope (or admin).
起動時の確認用です。API のバージョンとビルド、動いている任意の領域(オフのものは 404 または 503 を返します)、キーのスコープと上限、サーバーの時計を返します。
read:profile スコープ(または admin)が必要です。
operationId getIntegrationStatus · #
レスポンス
200 成功しました。
application/jsonobject
apiVersionstringbuildobject または nullobject または null
shastring または nullbuiltAtstring または null
featuresobjectkeyobject または nullobject または null
scopes配列: stringnamestring または null
serverTimestring (date-time)
BotsBotこのセクションへのリンクをコピー
GET /api/agents The Bots the owner can see所有者が見られる Bot read:bots
Requires the read:bots scope (or admin).
read:bots スコープ(または admin)が必要です。
operationId listBots · #
パラメーター
hidden | query | 次のいずれか: "true", "false"true lists the Bots the owner hid instead.true にすると、代わりに所有者が非表示にした Bot を一覧します。 |
|---|---|---|
limit | query | integer (≥ 1, ≤ 200) At most this many items, 1 to 200. The answer then carries nextCursor, null on the last page.最大件数で、1〜200 です。指定すると応答に nextCursor が含まれ、最後のページでは null になります。 |
cursor | query | string The nextCursor of the previous page.前のページの nextCursor です。 |
filter | query | string A condition the items must meet: a field (dots reach into objects), an operator ( = != > >= < <=, or ~ for contains) and a value, such as createdAt>=2026-10-01. Repeat for up to 10; all must hold.項目が満たすべき条件です。フィールド(ドットでオブジェクトの中を指定)、演算子(= != > >= < <=、または「含む」を表す ~)、値の順に createdAt>=2026-10-01 のように書きます。最大 10 個まで繰り返せ、すべてを満たす必要があります。 |
レスポンス
200 成功しました。
application/jsonobject
agents配列: objectnextCursorstring または null Only whenlimit,cursororfilterwas sent: the next page's cursor, or null.limit、cursor、filterのいずれかを送ったときだけ含まれる、次のページのカーソル、または null です。
POST /api/agents Create a BotBot を作成 manage:bots
Validated exactly as the Create a Bot dialog is: a key or password pasted into the role description is refused. The new Bot's first saved version is recorded.
Requires the manage:bots scope (or admin).
Bot 作成ダイアログとまったく同じように検証されます。役割の説明に貼り付けたキーやパスワードは拒否されます。新しい Bot の最初の版が保存されます。
manage:bots スコープ(または admin)が必要です。
operationId createBot · #
パラメーター
Idempotency-Key | header | string (長さ ≥ 1, 長さ ≤ 255) # |
|---|
リクエストボディ
application/jsonobject
namestring (長さ ≥ 1, 長さ ≤ 80) 必須titlestring (長さ ≥ 1, 長さ ≤ 120) 必須roleDescriptionstring (長さ ≥ 1, 長さ ≤ 1000) 必須 What the Bot is for, in plain words. A Bot that runs here works from it.Bot の目的を平易な言葉で書いたものです。ここで動く Bot はこれに沿って作業します。visibility次のいずれか:"public","private"public: everybody on the deployment may use it. On create, absent takes the workspace default.public:デプロイの全員が使えます。作成時に省略すると、ワークスペースの既定値になります。endpointstring An external agent's address. Absent: the Bot runs here.外部エージェントのアドレスです。省略すると、Bot はここで動きます。modelobject または null The model a Bot that runs here answers on; null for the deployment default.ここで動く Bot が回答に使うモデルです。null ならデプロイの既定のモデルです。object または null The model a Bot that runs here answers on; null for the deployment default.ここで動く Bot が回答に使うモデルです。null ならデプロイの既定のモデルです。
providerstringmodelstring
thinking次のいずれか:"off","standard","deep","max"starterTasks配列: string Suggested first requests. A list replaces the stored one.最初の依頼の候補です。一覧を送ると、保存されている一覧と置き換わります。
レスポンス
201 成功しました。
application/jsonobject
agentobject
400リクエストを解釈できませんでした。401キーがない、形式が正しくない、または不明・失効・期限切れのキーです。403キーにスコープがないか、キーの持ち主にこの操作が許可されていません。404見つからないか、キーの持ち主からは見えません。409同じ Idempotency-Key のリクエストをまだ処理中です。Retry-After を参照してください。422この Idempotency-Key は別のリクエストで使われています。429このアドレスからのキーの失敗が多すぎます。Retry-After を参照してください。
application/jsonapplication/problem+jsonGET /api/agents/model-options The models this deployment offers, for a Bot or one runこのデプロイが Bot や 1 回の実行に提供するモデル read:bots
providers lists each provider this deployment holds a key for and its models. perMessage says whether one run may name its own model; allowlist is the models the allowlist permits you, or null when it permits every model listed.
Requires the read:bots scope (or admin).
providers は、このデプロイがキーを持つ各プロバイダーとそのモデルの一覧です。perMessage は、1 回の実行が独自の model を指定できるかどうかを示します。allowlist は許可リストがあなたに認めるモデルで、一覧のすべてのモデルを認めている場合は null です。
read:bots スコープ(または admin)が必要です。
operationId getModelOptions · #
レスポンス
200 成功しました。
application/jsonobject
modelOptionsobject 必須
GET /api/agents/{agentId} One Bot's profile1 つの Bot のプロフィール read:bots
Requires the read:bots scope (or admin).
read:bots スコープ(または admin)が必要です。
operationId getBot · #
パラメーター
agentId | path 必須 | string The Bot's id.Bot の ID です。 |
|---|
レスポンス
200 成功しました。
application/jsonobject
agentobject
PATCH /api/agents/{agentId} Change a Bot's profileBot のプロフィールを変更 manage:bots
Send the whole profile, as the Bot dialog does; a fresh version is saved with your note. Pass the baseVersion you read to be refused with 409 when somebody saved since.
Requires the manage:bots scope (or admin).
Bot のダイアログと同じように、プロフィール全体を送ります。note を付けて新しい版が保存されます。読み取った baseVersion を渡すと、その後に誰かが保存していた場合は 409 で拒否されます。
manage:bots スコープ(または admin)が必要です。
operationId updateBot · #
パラメーター
agentId | path 必須 | string The Bot's id.Bot の ID です。 |
|---|---|---|
Idempotency-Key | header | string (長さ ≥ 1, 長さ ≤ 255) # |
リクエストボディ
application/jsonobject
namestring (長さ ≥ 1, 長さ ≤ 80) 必須titlestring (長さ ≥ 1, 長さ ≤ 120) 必須roleDescriptionstring (長さ ≥ 1, 長さ ≤ 1000) 必須 What the Bot is for, in plain words. A Bot that runs here works from it.Bot の目的を平易な言葉で書いたものです。ここで動く Bot はこれに沿って作業します。visibility次のいずれか:"public","private"必須endpointstring An external agent's address. Absent: the Bot runs here.外部エージェントのアドレスです。省略すると、Bot はここで動きます。modelobject または null The model a Bot that runs here answers on; null for the deployment default.ここで動く Bot が回答に使うモデルです。null ならデプロイの既定のモデルです。object または null The model a Bot that runs here answers on; null for the deployment default.ここで動く Bot が回答に使うモデルです。null ならデプロイの既定のモデルです。
providerstringmodelstring
thinking次のいずれか:"off","standard","deep","max"starterTasks配列: string Suggested first requests. A list replaces the stored one.最初の依頼の候補です。一覧を送ると、保存されている一覧と置き換わります。notestring (長さ ≤ 500)baseVersioninteger (≥ 1)
レスポンス
200 成功しました。
application/jsonobject
agentobject
400リクエストを解釈できませんでした。401キーがない、形式が正しくない、または不明・失効・期限切れのキーです。403キーにスコープがないか、キーの持ち主にこの操作が許可されていません。404見つからないか、キーの持ち主からは見えません。409同じ Idempotency-Key のリクエストをまだ処理中です。Retry-After を参照してください。422この Idempotency-Key は別のリクエストで使われています。429このアドレスからのキーの失敗が多すぎます。Retry-After を参照してください。
application/jsonapplication/problem+jsonDELETE /api/agents/{agentId} Delete a BotBot を削除 manage:bots
It stops answering at once and its stored key stops working. An administrator can restore it from the trash for a while.
Requires the manage:bots scope (or admin).
すぐに応答しなくなり、保存されたキーも使えなくなります。管理者はしばらくの間ゴミ箱から復元できます。
manage:bots スコープ(または admin)が必要です。
operationId deleteBot · #
パラメーター
agentId | path 必須 | string The Bot's id.Bot の ID です。 |
|---|---|---|
Idempotency-Key | header | string (長さ ≥ 1, 長さ ≤ 255) # |
レスポンス
204 Done.完了しました。
400リクエストを解釈できませんでした。401キーがない、形式が正しくない、または不明・失効・期限切れのキーです。403キーにスコープがないか、キーの持ち主にこの操作が許可されていません。404見つからないか、キーの持ち主からは見えません。409同じ Idempotency-Key のリクエストをまだ処理中です。Retry-After を参照してください。422この Idempotency-Key は別のリクエストで使われています。429このアドレスからのキーの失敗が多すぎます。Retry-After を参照してください。
application/jsonapplication/problem+jsonGET /api/agents/{agentId}/history A Bot's saved versions, newest firstBot の保存された版(新しい順) manage:bots
Requires the manage:bots scope (or admin).
manage:bots スコープ(または admin)が必要です。
operationId listBotVersions · #
パラメーター
agentId | path 必須 | string The Bot's id.Bot の ID です。 |
|---|---|---|
limit | query | integer (≥ 1, ≤ 200) How many versions (1 to 200, default 50).バージョンの数です(1〜200、既定は 50)。 |
レスポンス
200 成功しました。
application/jsonobject
versions配列: object
GET /api/agents/{agentId}/tests A Bot's tests and recent runsBot のテストと最近の実行 manage:bots
Requires the manage:bots scope (or admin).
manage:bots スコープ(または admin)が必要です。
operationId listBotTests · #
パラメーター
agentId | path 必須 | string The Bot's id.Bot の ID です。 |
|---|
レスポンス
200 成功しました。
application/jsonobject
tests配列: object 必須runs配列: object 必須
POST /api/agents/{agentId}/tests Save a testテストを保存 manage:bots
Requires the manage:bots scope (or admin).
manage:bots スコープ(または admin)が必要です。
operationId createBotTest · #
パラメーター
agentId | path 必須 | string The Bot's id.Bot の ID です。 |
|---|---|---|
Idempotency-Key | header | string (長さ ≥ 1, 長さ ≤ 255) # |
リクエストボディ
application/jsonobject
promptstring 必須checks配列: 任意 必須{ kind, value }: contains, not_contains, asked_approval, max_time, judge, or called_tool / not_called_tool naming a tool infixtures.{ kind, value }:contains、not_contains、asked_approval、max_time、judge、またはfixtures内のツールを指定する called_tool / not_called_tool です。fixtures配列: object Recorded tool results:{ tool, description?, result }. The test offers the Bot only these tools and answers every call withresult, so nothing real is reached.記録済みのツールの結果{ tool, description?, result }です。テストでは Bot にこれらのツールだけを渡し、すべての呼び出しにresultで応答するため、実際のシステムには一切アクセスしません。配列: object Recorded tool results:
{ tool, description?, result }. The test offers the Bot only these tools and answers every call withresult, so nothing real is reached.記録済みのツールの結果{ tool, description?, result }です。テストでは Bot にこれらのツールだけを渡し、すべての呼び出しにresultで応答するため、実際のシステムには一切アクセスしません。toolstring 必須descriptionstring (長さ ≤ 300)resultstring (長さ ≥ 1, 長さ ≤ 4000) 必須
レスポンス
201 成功しました。
application/jsonobject 任意のフィールドを含む
400リクエストを解釈できませんでした。401キーがない、形式が正しくない、または不明・失効・期限切れのキーです。403キーにスコープがないか、キーの持ち主にこの操作が許可されていません。404見つからないか、キーの持ち主からは見えません。409同じ Idempotency-Key のリクエストをまだ処理中です。Retry-After を参照してください。422この Idempotency-Key は別のリクエストで使われています。429このアドレスからのキーの失敗が多すぎます。Retry-After を参照してください。
application/jsonapplication/problem+jsonDELETE /api/agents/{agentId}/tests/{testId} Delete a testテストを削除 manage:bots
Requires the manage:bots scope (or admin).
manage:bots スコープ(または admin)が必要です。
operationId deleteBotTest · #
パラメーター
agentId | path 必須 | string The Bot's id.Bot の ID です。 |
|---|---|---|
testId | path 必須 | string The test's id.テストの ID です。 |
Idempotency-Key | header | string (長さ ≥ 1, 長さ ≤ 255) # |
レスポンス
200 成功しました。
application/jsonobject 任意のフィールドを含む
400リクエストを解釈できませんでした。401キーがない、形式が正しくない、または不明・失効・期限切れのキーです。403キーにスコープがないか、キーの持ち主にこの操作が許可されていません。404見つからないか、キーの持ち主からは見えません。409同じ Idempotency-Key のリクエストをまだ処理中です。Retry-After を参照してください。422この Idempotency-Key は別のリクエストで使われています。429このアドレスからのキーの失敗が多すぎます。Retry-After を参照してください。
application/jsonapplication/problem+jsonPOST /api/agents/{agentId}/tests/run Run a Bot's tests nowBot のテストを今すぐ実行 manage:bots
Requires the manage:bots scope (or admin).
manage:bots スコープ(または admin)が必要です。
operationId runBotTests · #
パラメーター
agentId | path 必須 | string The Bot's id.Bot の ID です。 |
|---|---|---|
Idempotency-Key | header | string (長さ ≥ 1, 長さ ≤ 255) # |
リクエストボディ
application/jsonobject
target次のいずれか:"published","draft"
レスポンス
200 成功しました。
application/jsonobject 任意のフィールドを含む
400リクエストを解釈できませんでした。401キーがない、形式が正しくない、または不明・失効・期限切れのキーです。403キーにスコープがないか、キーの持ち主にこの操作が許可されていません。404見つからないか、キーの持ち主からは見えません。409同じ Idempotency-Key のリクエストをまだ処理中です。Retry-After を参照してください。422この Idempotency-Key は別のリクエストで使われています。429このアドレスからのキーの失敗が多すぎます。Retry-After を参照してください。
application/jsonapplication/problem+jsonConversations会話このセクションへのリンクをコピー
GET /api/channels The owner's conversations, newest first所有者の会話(新しい順) read:channels
Requires the read:channels scope (or admin).
read:channels スコープ(または admin)が必要です。
operationId listChannels · #
パラメーター
limit | query | integer (≥ 1) How many to return.返す件数です。 |
|---|---|---|
cursor | query | string The nextCursor of the previous page.前のページの nextCursor です。 |
レスポンス
200 成功しました。
application/jsonobject
channels配列: objectnextCursorstring または null
GET /api/channels/{channelId} One conversation1 つの会話 read:channels
Requires the read:channels scope (or admin).
read:channels スコープ(または admin)が必要です。
operationId getChannel · #
パラメーター
channelId | path 必須 | string The conversation's id.会話の ID です。 |
|---|
レスポンス
200 成功しました。
application/jsonobject
channelobject
GET /api/groups/{channelId} A group conversation and its messagesグループ会話とそのメッセージ read:channels
Requires the read:channels scope (or admin).
read:channels スコープ(または admin)が必要です。
operationId listGroupMessages · #
パラメーター
channelId | path 必須 | string The group conversation's id.グループ会話の ID です。 |
|---|
レスポンス
200 成功しました。
application/jsonobject 任意のフィールドを含む
POST /api/groups/{channelId} Send a message into a group conversation, as the owner所有者としてグループ会話にメッセージを送信 write:messages
The Bots in the conversation answer as they would in the app. id is yours to choose; sending the same id twice is one message.
Requires the write:messages scope (or admin).
会話にいる Bot はアプリと同じように応答します。id は自由に選べ、同じ id を 2 回送っても 1 件のメッセージになります。
write:messages スコープ(または admin)が必要です。
operationId sendGroupMessage · #
パラメーター
channelId | path 必須 | string The group conversation's id.グループ会話の ID です。 |
|---|---|---|
Idempotency-Key | header | string (長さ ≥ 1, 長さ ≤ 255) # |
リクエストボディ
application/jsonobject
idstring (長さ ≥ 1, 長さ ≤ 160) 必須textstring (長さ ≥ 1, 長さ ≤ 16000) 必須agentIdstring または null Address one Bot in the conversation.会話の中の 1 つの Bot に宛てます。
レスポンス
202 成功しました。
application/jsonobject 任意のフィールドを含む
400リクエストを解釈できませんでした。401キーがない、形式が正しくない、または不明・失効・期限切れのキーです。403キーにスコープがないか、キーの持ち主にこの操作が許可されていません。404見つからないか、キーの持ち主からは見えません。409同じ Idempotency-Key のリクエストをまだ処理中です。Retry-After を参照してください。422この Idempotency-Key は別のリクエストで使われています。429このアドレスからのキーの失敗が多すぎます。Retry-After を参照してください。
application/jsonapplication/problem+jsonGET /api/groups/{channelId}/stream Watch the Bots' replies arrive, as Server-Sent EventsBot の返信をサーバー送信イベント(SSE)で受け取る read:channels
Events: ready, message, text (a delta, or text with replaced: true), tool (your own Bots only), status, then idle or timeout. It mirrors GET /api/groups/{channelId} live. Up to ten minutes, five streams per person.
Requires the read:channels scope (or admin).
イベントは ready、message、text(delta、または replaced: true 付きの text)、tool(自分の Bot のみ)、status、最後に idle または timeout です。GET /api/groups/{channelId} をライブで映します。最長 10 分、1 人あたり 5 本までです。
read:channels スコープ(または admin)が必要です。
operationId streamGroupReplies · #
パラメーター
channelId | path 必須 | string The group conversation's id.グループ会話の ID です。 |
|---|---|---|
until | query | 次のいずれか: "idle"idle closes the stream once no reply has been written for 15 seconds.idle は、15 秒間返信が書かれなければストリームを閉じます。 |
レスポンス
200 成功しました。
text/event-streamstring
application/jsonobject
POST /api/conversations Start a conversation with a Bot and send its first messageBot との会話を始めて最初のメッセージを送信 write:messages
A direct conversation with the Bot, as the owner; text is the first message and the reply is a run. With externalId, that conversation continues. It shows in the app too.
Requires the write:messages scope (or admin).
所有者として Bot と 1 対 1 の会話を作ります。text が最初のメッセージで、返信は実行になります。externalId を付けるとその会話を続けます。会話はアプリにも表示されます。
write:messages スコープ(または admin)が必要です。
operationId startConversation · #
パラメーター
Idempotency-Key | header | string (長さ ≥ 1, 長さ ≤ 255) # |
|---|
リクエストボディ
application/jsonobject
agentIdstring 必須externalIdstring Your own key for the conversation: 1 to 200 letters, digits or . _ : @ -会話に付けるあなた独自のキーで、1〜200 文字の英字・数字・. _ : @ - です。textstring (長さ ≥ 1, 長さ ≤ 16000) 必須metadataobject Your own values (up to 16 keys of 500 characters each), returned with the run and on its audit rows.あなた独自の値(500 文字までのキーを最大 16 個)で、実行と監査ログの行に付いて返ります。outputobjectobject
schemaobject 必須 A JSON Schema the reply must match. The reply is checked and returned asoutput; a mismatch fails the run with the reason.返信が満たすべき JSON Schema です。返信は検証され、outputとして返ります。一致しない場合、実行は理由とともに失敗になります。
waitinteger (≥ 0, ≤ 120) Seconds to wait for the run to finish;donesays whether it did.実行の完了を待つ秒数です。完了したかどうかはdoneでわかります。tools配列: string The only tools this run may use.この実行で使えるツールです。これ以外は使えません。callbackUrlstring (長さ ≤ 2000, uri) An HTTPS address told when this run finishes or waits for a person. The call carries the run's id, status and address, never the reply; read the run with your key.この実行が完了したとき、または人の対応を待つときに通知される HTTPS アドレスです。通知には実行の ID、状態、アドレスが含まれ、返信は含まれません。実行の内容はキーを使って読んでください。attachments配列: string (uuid) Files to send with the message: the idsuploadAttachmentanswered with, uploaded into this conversation within the last few hours. The Bot reads them as it reads files a person attaches.メッセージと一緒に送るファイルです。uploadAttachmentが返した ID で、ここ数時間以内にこの会話にアップロードしたものを指定します。Bot は、人が添付したファイルと同じように読みます。modelobject The model this one run answers on, from thosegetModelOptionslists. The Bot's own model is not changed. The model allowlist applies; a Bot at its own address chooses its own model and cannot be given one.この 1 回の実行が回答に使うモデルで、getModelOptionsが一覧するものから選びます。Bot 自身のモデルは変わりません。モデルの許可リストが適用されます。独自のアドレスで動く Bot は自分でモデルを選ぶため、指定できません。object The model this one run answers on, from those
getModelOptionslists. The Bot's own model is not changed. The model allowlist applies; a Bot at its own address chooses its own model and cannot be given one.この 1 回の実行が回答に使うモデルで、getModelOptionsが一覧するものから選びます。Bot 自身のモデルは変わりません。モデルの許可リストが適用されます。独自のアドレスで動く Bot は自分でモデルを選ぶため、指定できません。providerstring (長さ ≥ 1, 長さ ≤ 40) 必須modelstring (長さ ≥ 1, 長さ ≤ 128) 必須
レスポンス
202 成功しました。
application/jsonobject
conversationobject 必須object
idstring 必須createdboolean 必須externalIdstring または null 必須
runobject 必須object
idstring 必須conversationIdstring 必須agentIdstring 必須status次のいずれか:"queued","running","waiting","completed","failed","cancelled"必須textstring 必須replystring または null 必須output任意 必須 The validated JSON, whenoutput.schemawas sent.output.schemaを送ったときの、検証済みの JSON です。errorstring または null 必須metadataobject 必須externalIdstring または null 必須attachments配列: string 必須modelobject または null 必須object または null
providerstring (長さ ≥ 1, 長さ ≤ 40) 必須modelstring (長さ ≥ 1, 長さ ≤ 128) 必須
activity配列: object 必須progressstring または null 必須approvalobject または null 必須object または null
idstring または nullkindstring または nullreasonstring
cancelRequestedboolean 必須createdAtstring (date-time) 必須startedAtstring または null (date-time) 必須finishedAtstring または null (date-time) 必須queuedMsinteger または null 必須runMsinteger または null 必須usageobject 必須object
inputTokensinteger または null 必須outputTokensinteger または null 必須
callbackobject または null 必須object または null
urlstringsentAtstring または null (date-time)errorstring または null
doneboolean 必須
400リクエストを解釈できませんでした。401キーがない、形式が正しくない、または不明・失効・期限切れのキーです。403キーにスコープがないか、キーの持ち主にこの操作が許可されていません。404見つからないか、キーの持ち主からは見えません。409同じ Idempotency-Key のリクエストをまだ処理中です。Retry-After を参照してください。422この Idempotency-Key は別のリクエストで使われています。429このアドレスからのキーの失敗が多すぎます。Retry-After を参照してください。
application/jsonapplication/problem+jsonPOST /api/conversations/{conversationId}/messages Send a message in a direct conversation1 対 1 の会話でメッセージを送信 write:messages
One message at a time: while the Bot is still answering the previous one, a new message is refused with 409.
Requires the write:messages scope (or admin).
メッセージは 1 件ずつです。Bot が前のメッセージにまだ応答している間は、新しいメッセージは 409 で拒否されます。
write:messages スコープ(または admin)が必要です。
operationId sendConversationMessage · #
パラメーター
conversationId | path 必須 | string The direct conversation's id.ダイレクト会話の ID です。 |
|---|---|---|
Idempotency-Key | header | string (長さ ≥ 1, 長さ ≤ 255) # |
リクエストボディ
application/jsonobject
textstring (長さ ≥ 1, 長さ ≤ 16000) 必須metadataobject Your own values (up to 16 keys of 500 characters each), returned with the run and on its audit rows.あなた独自の値(500 文字までのキーを最大 16 個)で、実行と監査ログの行に付いて返ります。outputobjectobject
schemaobject 必須 A JSON Schema the reply must match. The reply is checked and returned asoutput; a mismatch fails the run with the reason.返信が満たすべき JSON Schema です。返信は検証され、outputとして返ります。一致しない場合、実行は理由とともに失敗になります。
waitinteger (≥ 0, ≤ 120) Seconds to wait for the run to finish;donesays whether it did.実行の完了を待つ秒数です。完了したかどうかはdoneでわかります。tools配列: string The only tools this run may use.この実行で使えるツールです。これ以外は使えません。callbackUrlstring (長さ ≤ 2000, uri) An HTTPS address told when this run finishes or waits for a person. The call carries the run's id, status and address, never the reply; read the run with your key.この実行が完了したとき、または人の対応を待つときに通知される HTTPS アドレスです。通知には実行の ID、状態、アドレスが含まれ、返信は含まれません。実行の内容はキーを使って読んでください。attachments配列: string (uuid) Files to send with the message: the idsuploadAttachmentanswered with, uploaded into this conversation within the last few hours. The Bot reads them as it reads files a person attaches.メッセージと一緒に送るファイルです。uploadAttachmentが返した ID で、ここ数時間以内にこの会話にアップロードしたものを指定します。Bot は、人が添付したファイルと同じように読みます。modelobject The model this one run answers on, from thosegetModelOptionslists. The Bot's own model is not changed. The model allowlist applies; a Bot at its own address chooses its own model and cannot be given one.この 1 回の実行が回答に使うモデルで、getModelOptionsが一覧するものから選びます。Bot 自身のモデルは変わりません。モデルの許可リストが適用されます。独自のアドレスで動く Bot は自分でモデルを選ぶため、指定できません。object The model this one run answers on, from those
getModelOptionslists. The Bot's own model is not changed. The model allowlist applies; a Bot at its own address chooses its own model and cannot be given one.この 1 回の実行が回答に使うモデルで、getModelOptionsが一覧するものから選びます。Bot 自身のモデルは変わりません。モデルの許可リストが適用されます。独自のアドレスで動く Bot は自分でモデルを選ぶため、指定できません。providerstring (長さ ≥ 1, 長さ ≤ 40) 必須modelstring (長さ ≥ 1, 長さ ≤ 128) 必須
レスポンス
202 成功しました。
application/jsonobject
runobject 必須object
idstring 必須conversationIdstring 必須agentIdstring 必須status次のいずれか:"queued","running","waiting","completed","failed","cancelled"必須textstring 必須replystring または null 必須output任意 必須 The validated JSON, whenoutput.schemawas sent.output.schemaを送ったときの、検証済みの JSON です。errorstring または null 必須metadataobject 必須externalIdstring または null 必須attachments配列: string 必須modelobject または null 必須object または null
providerstring (長さ ≥ 1, 長さ ≤ 40) 必須modelstring (長さ ≥ 1, 長さ ≤ 128) 必須
activity配列: object 必須progressstring または null 必須approvalobject または null 必須object または null
idstring または nullkindstring または nullreasonstring
cancelRequestedboolean 必須createdAtstring (date-time) 必須startedAtstring または null (date-time) 必須finishedAtstring または null (date-time) 必須queuedMsinteger または null 必須runMsinteger または null 必須usageobject 必須object
inputTokensinteger または null 必須outputTokensinteger または null 必須
callbackobject または null 必須object または null
urlstringsentAtstring または null (date-time)errorstring または null
doneboolean 必須
400リクエストを解釈できませんでした。401キーがない、形式が正しくない、または不明・失効・期限切れのキーです。403キーにスコープがないか、キーの持ち主にこの操作が許可されていません。404見つからないか、キーの持ち主からは見えません。409同じ Idempotency-Key のリクエストをまだ処理中です。Retry-After を参照してください。422この Idempotency-Key は別のリクエストで使われています。429このアドレスからのキーの失敗が多すぎます。Retry-After を参照してください。
application/jsonapplication/problem+jsonPOST /api/channels/{channelId}/attachments Upload a file into a conversation, to send with a message会話にファイルをアップロード(メッセージに添えるため) write:messages
The file's bytes as the body, its type as Content-Type and its name in name. Answers the attachment's id: name it in attachments when you send a message in the same conversation. The types and sizes the app accepts apply; a file not sent within a few hours is removed. A multipart form with the file under file works too.
Requires the write:messages scope (or admin).
ファイルのバイト列を本文、種類を Content-Type、名前を name に指定します。添付の id が返るので、同じ会話でメッセージを送るときに attachments へ指定してください。アプリで受け付ける種類とサイズが適用され、数時間以内に送られなかったファイルは削除されます。ファイルを file に入れたマルチパートフォームでも送れます。
write:messages スコープ(または admin)が必要です。
operationId uploadAttachment · #
パラメーター
channelId | path 必須 | string The conversation's id.会話の ID です。 |
|---|---|---|
name | query 必須 | string (長さ ≥ 1, 長さ ≤ 255) The file's name, such as report.pdf.ファイル名です(例:report.pdf)。 |
Idempotency-Key | header | string (長さ ≥ 1, 長さ ≤ 255) # |
リクエストボディ
application/octet-streamstring (binary)
レスポンス
201 成功しました。
application/jsonobject
idstring 必須namestring 必須mimeTypestring 必須sizeBytesinteger 必須
400リクエストを解釈できませんでした。401キーがない、形式が正しくない、または不明・失効・期限切れのキーです。403キーにスコープがないか、キーの持ち主にこの操作が許可されていません。404見つからないか、キーの持ち主からは見えません。409同じ Idempotency-Key のリクエストをまだ処理中です。Retry-After を参照してください。422この Idempotency-Key は別のリクエストで使われています。429このアドレスからのキーの失敗が多すぎます。Retry-After を参照してください。
application/jsonapplication/problem+jsonRuns実行このセクションへのリンクをコピー
GET /api/runs The runs the owner started through the API, newest first所有者が API で始めた実行(新しい順) read:channels
Requires the read:channels scope (or admin).
read:channels スコープ(または admin)が必要です。
operationId listRuns · #
パラメーター
limit | query | integer (≥ 1, ≤ 100) How many to return, up to 100.返す件数で、最大 100 です。 |
|---|---|---|
cursor | query | string The nextCursor of the previous page.前のページの nextCursor です。 |
conversationId | query | string Only this conversation's runs.この会話の実行だけです。 |
レスポンス
200 成功しました。
application/jsonobject
runs配列: object 必須配列: object
idstring 必須conversationIdstring 必須agentIdstring 必須status次のいずれか:"queued","running","waiting","completed","failed","cancelled"必須textstring 必須replystring または null 必須output任意 必須 The validated JSON, whenoutput.schemawas sent.output.schemaを送ったときの、検証済みの JSON です。errorstring または null 必須metadataobject 必須externalIdstring または null 必須attachments配列: string 必須modelobject または null 必須object または null
providerstring (長さ ≥ 1, 長さ ≤ 40) 必須modelstring (長さ ≥ 1, 長さ ≤ 128) 必須
activity配列: object 必須progressstring または null 必須approvalobject または null 必須object または null
idstring または nullkindstring または nullreasonstring
cancelRequestedboolean 必須createdAtstring (date-time) 必須startedAtstring または null (date-time) 必須finishedAtstring または null (date-time) 必須queuedMsinteger または null 必須runMsinteger または null 必須usageobject 必須object
inputTokensinteger または null 必須outputTokensinteger または null 必須
callbackobject または null 必須object または null
urlstringsentAtstring または null (date-time)errorstring または null
nextCursorstring または null 必須
GET /api/runs/{runId} A run's status, timings, token use and any approval it waits on実行の状態、所要時間、トークン使用量、待っている承認 read:channels
Requires the read:channels scope (or admin).
read:channels スコープ(または admin)が必要です。
operationId getRun · #
パラメーター
runId | path 必須 | string The run's id.実行の ID です。 |
|---|
レスポンス
200 成功しました。
application/jsonobject
runobject 必須object
idstring 必須conversationIdstring 必須agentIdstring 必須status次のいずれか:"queued","running","waiting","completed","failed","cancelled"必須textstring 必須replystring または null 必須output任意 必須 The validated JSON, whenoutput.schemawas sent.output.schemaを送ったときの、検証済みの JSON です。errorstring または null 必須metadataobject 必須externalIdstring または null 必須attachments配列: string 必須modelobject または null 必須object または null
providerstring (長さ ≥ 1, 長さ ≤ 40) 必須modelstring (長さ ≥ 1, 長さ ≤ 128) 必須
activity配列: object 必須progressstring または null 必須approvalobject または null 必須object または null
idstring または nullkindstring または nullreasonstring
cancelRequestedboolean 必須createdAtstring (date-time) 必須startedAtstring または null (date-time) 必須finishedAtstring または null (date-time) 必須queuedMsinteger または null 必須runMsinteger または null 必須usageobject 必須object
inputTokensinteger または null 必須outputTokensinteger または null 必須
callbackobject または null 必須object または null
urlstringsentAtstring または null (date-time)errorstring または null
GET /api/runs/{runId}/wait Wait for a run to finish実行が終わるのを待つ read:channels
Answers as soon as the run completes, fails, is stopped or pauses for an approval, or when timeout passes, with done saying which. Call again to keep waiting. A person may hold five waits at once.
Requires the read:channels scope (or admin).
実行が完了、失敗、停止、または承認待ちで一時停止したとき、あるいは timeout が過ぎたときにすぐ応答し、どちらだったかを done が示します。待ち続けるにはもう一度呼び出します。1 人が同時に保てる待機は 5 つまでです。
read:channels スコープ(または admin)が必要です。
operationId waitForRun · #
パラメーター
runId | path 必須 | string The run's id.実行の ID です。 |
|---|---|---|
timeout | query | integer (≥ 0, ≤ 120) Seconds to wait, up to 120; 30 when omitted.待つ秒数で、最大 120 です。省略すると 30 です。 |
レスポンス
200 成功しました。
application/jsonobject
runobject 必須object
idstring 必須conversationIdstring 必須agentIdstring 必須status次のいずれか:"queued","running","waiting","completed","failed","cancelled"必須textstring 必須replystring または null 必須output任意 必須 The validated JSON, whenoutput.schemawas sent.output.schemaを送ったときの、検証済みの JSON です。errorstring または null 必須metadataobject 必須externalIdstring または null 必須attachments配列: string 必須modelobject または null 必須object または null
providerstring (長さ ≥ 1, 長さ ≤ 40) 必須modelstring (長さ ≥ 1, 長さ ≤ 128) 必須
activity配列: object 必須progressstring または null 必須approvalobject または null 必須object または null
idstring または nullkindstring または nullreasonstring
cancelRequestedboolean 必須createdAtstring (date-time) 必須startedAtstring または null (date-time) 必須finishedAtstring または null (date-time) 必須queuedMsinteger または null 必須runMsinteger または null 必須usageobject 必須object
inputTokensinteger または null 必須outputTokensinteger または null 必須
callbackobject または null 必須object または null
urlstringsentAtstring または null (date-time)errorstring または null
doneboolean 必須
POST /api/runs/{runId}/cancel Stop a run, the same as pressing Stop実行を止める(停止ボタンと同じ) write:messages
A queued run never starts; a running one is stopped within a few seconds and ends cancelled. A run waiting for an approval is refused with 409: refuse the approval to end it.
Requires the write:messages scope (or admin).
キューにある実行は始まりません。実行中のものは数秒以内に止まり、cancelled で終わります。承認を待っている実行は 409 で拒否されます。終わらせるには承認を拒否してください。
write:messages スコープ(または admin)が必要です。
operationId cancelRun · #
パラメーター
runId | path 必須 | string The run's id.実行の ID です。 |
|---|---|---|
Idempotency-Key | header | string (長さ ≥ 1, 長さ ≤ 255) # |
レスポンス
202 成功しました。
application/jsonobject
runobject 必須object
idstring 必須conversationIdstring 必須agentIdstring 必須status次のいずれか:"queued","running","waiting","completed","failed","cancelled"必須textstring 必須replystring または null 必須output任意 必須 The validated JSON, whenoutput.schemawas sent.output.schemaを送ったときの、検証済みの JSON です。errorstring または null 必須metadataobject 必須externalIdstring または null 必須attachments配列: string 必須modelobject または null 必須object または null
providerstring (長さ ≥ 1, 長さ ≤ 40) 必須modelstring (長さ ≥ 1, 長さ ≤ 128) 必須
activity配列: object 必須progressstring または null 必須approvalobject または null 必須object または null
idstring または nullkindstring または nullreasonstring
cancelRequestedboolean 必須createdAtstring (date-time) 必須startedAtstring または null (date-time) 必須finishedAtstring または null (date-time) 必須queuedMsinteger または null 必須runMsinteger または null 必須usageobject 必須object
inputTokensinteger または null 必須outputTokensinteger または null 必須
callbackobject または null 必須object または null
urlstringsentAtstring または null (date-time)errorstring または null
400リクエストを解釈できませんでした。401キーがない、形式が正しくない、または不明・失効・期限切れのキーです。403キーにスコープがないか、キーの持ち主にこの操作が許可されていません。404見つからないか、キーの持ち主からは見えません。409同じ Idempotency-Key のリクエストをまだ処理中です。Retry-After を参照してください。422この Idempotency-Key は別のリクエストで使われています。429このアドレスからのキーの失敗が多すぎます。Retry-After を参照してください。
application/jsonapplication/problem+jsonRoutinesルーティンこのセクションへのリンクをコピー
GET /api/routines The owner's routines所有者のルーティン read:routines
Requires the read:routines scope (or admin).
read:routines スコープ(または admin)が必要です。
operationId listRoutines · #
パラメーター
limit | query | integer (≥ 1, ≤ 200) At most this many items, 1 to 200. The answer then carries nextCursor, null on the last page.最大件数で、1〜200 です。指定すると応答に nextCursor が含まれ、最後のページでは null になります。 |
|---|---|---|
cursor | query | string The nextCursor of the previous page.前のページの nextCursor です。 |
filter | query | string A condition the items must meet: a field (dots reach into objects), an operator ( = != > >= < <=, or ~ for contains) and a value, such as createdAt>=2026-10-01. Repeat for up to 10; all must hold.項目が満たすべき条件です。フィールド(ドットでオブジェクトの中を指定)、演算子(= != > >= < <=、または「含む」を表す ~)、値の順に createdAt>=2026-10-01 のように書きます。最大 10 個まで繰り返せ、すべてを満たす必要があります。 |
レスポンス
200 成功しました。
application/jsonobject
routines配列: objectnextCursorstring または null Only whenlimit,cursororfilterwas sent: the next page's cursor, or null.limit、cursor、filterのいずれかを送ったときだけ含まれる、次のページのカーソル、または null です。
POST /api/routines Create a routineルーティンを作成 manage:routines
The same checks as creating one in the app: a five-field cron schedule that runs at most once every fifteen minutes, a cap on how many may be switched on, and a conversation both the owner and the Bot are in.
Requires the manage:routines scope (or admin).
アプリで作成するときと同じ確認を行います。最短でも 15 分に 1 回の 5 項目の cron スケジュール、オンにできる数の上限、所有者と Bot の両方が参加している会話です。
manage:routines スコープ(または admin)が必要です。
operationId createRoutine · #
パラメーター
Idempotency-Key | header | string (長さ ≥ 1, 長さ ≤ 255) # |
|---|
リクエストボディ
application/jsonobject
agentIdstring 必須 The Bot that carries it out.それを実行する Bot です。instructionstring (長さ ≥ 1) 必須cronstring 必須timezonestringchannelIdstring または null The conversation it posts into.投稿先の会話です。
レスポンス
201 成功しました。
application/jsonobject
idstringroutineobject
400リクエストを解釈できませんでした。401キーがない、形式が正しくない、または不明・失効・期限切れのキーです。403キーにスコープがないか、キーの持ち主にこの操作が許可されていません。404見つからないか、キーの持ち主からは見えません。409同じ Idempotency-Key のリクエストをまだ処理中です。Retry-After を参照してください。422この Idempotency-Key は別のリクエストで使われています。429このアドレスからのキーの失敗が多すぎます。Retry-After を参照してください。
application/jsonapplication/problem+jsonGET /api/routines/{id}/runs One routine's runs1 つのルーティンの実行 read:routines
Requires the read:routines scope (or admin).
read:routines スコープ(または admin)が必要です。
operationId listRoutineRuns · #
パラメーター
id | path 必須 | string The routine's id.ルーティンの ID です。 |
|---|---|---|
limit | query | integer (≥ 1, ≤ 200) At most this many items, 1 to 200. The answer then carries nextCursor, null on the last page.最大件数で、1〜200 です。指定すると応答に nextCursor が含まれ、最後のページでは null になります。 |
cursor | query | string The nextCursor of the previous page.前のページの nextCursor です。 |
filter | query | string A condition the items must meet: a field (dots reach into objects), an operator ( = != > >= < <=, or ~ for contains) and a value, such as createdAt>=2026-10-01. Repeat for up to 10; all must hold.項目が満たすべき条件です。フィールド(ドットでオブジェクトの中を指定)、演算子(= != > >= < <=、または「含む」を表す ~)、値の順に createdAt>=2026-10-01 のように書きます。最大 10 個まで繰り返せ、すべてを満たす必要があります。 |
レスポンス
200 成功しました。
application/jsonobject
runs配列: objectnextCursorstring または null Only whenlimit,cursororfilterwas sent: the next page's cursor, or null.limit、cursor、filterのいずれかを送ったときだけ含まれる、次のページのカーソル、または null です。
POST /api/routines/{id}/run Run a routine nowルーティンを今すぐ実行 write:routines
Real work: the routine's Bot runs its instruction exactly as a scheduled run would. A paused routine is refused.
Requires the write:routines scope (or admin).
実際の作業です。ルーティンの Bot が、スケジュール実行とまったく同じように指示を実行します。一時停止中のルーティンは拒否されます。
write:routines スコープ(または admin)が必要です。
operationId runRoutine · #
パラメーター
id | path 必須 | string The routine's id.ルーティンの ID です。 |
|---|---|---|
Idempotency-Key | header | string (長さ ≥ 1, 長さ ≤ 255) # |
レスポンス
202 成功しました。
application/jsonobject
acceptedbooleanrunIdstring
400リクエストを解釈できませんでした。401キーがない、形式が正しくない、または不明・失効・期限切れのキーです。403キーにスコープがないか、キーの持ち主にこの操作が許可されていません。404見つからないか、キーの持ち主からは見えません。409同じ Idempotency-Key のリクエストをまだ処理中です。Retry-After を参照してください。422この Idempotency-Key は別のリクエストで使われています。429このアドレスからのキーの失敗が多すぎます。Retry-After を参照してください。
application/jsonapplication/problem+jsonPUT /api/routines/{id}/instruction Change what a routine doesルーティンの内容を変更 manage:routines
Requires the manage:routines scope (or admin).
manage:routines スコープ(または admin)が必要です。
operationId setRoutineInstruction · #
パラメーター
id | path 必須 | string The routine's id.ルーティンの ID です。 |
|---|---|---|
Idempotency-Key | header | string (長さ ≥ 1, 長さ ≤ 255) # |
リクエストボディ
application/jsonobject
instructionstring (長さ ≥ 1) 必須
レスポンス
200 成功しました。
application/jsonobject
instructionstring
400リクエストを解釈できませんでした。401キーがない、形式が正しくない、または不明・失効・期限切れのキーです。403キーにスコープがないか、キーの持ち主にこの操作が許可されていません。404見つからないか、キーの持ち主からは見えません。409同じ Idempotency-Key のリクエストをまだ処理中です。Retry-After を参照してください。422この Idempotency-Key は別のリクエストで使われています。429このアドレスからのキーの失敗が多すぎます。Retry-After を参照してください。
application/jsonapplication/problem+jsonGET /api/routines/{id}/schedule A routine's schedule and its next runルーティンのスケジュールと次の実行 read:routines
Requires the read:routines scope (or admin).
read:routines スコープ(または admin)が必要です。
operationId getRoutineSchedule · #
パラメーター
id | path 必須 | string The routine's id.ルーティンの ID です。 |
|---|
レスポンス
200 成功しました。
application/jsonobject 任意のフィールドを含む
PUT /api/routines/{id}/schedule Change when a routine runsルーティンの実行時刻を変更 manage:routines
Requires the manage:routines scope (or admin).
manage:routines スコープ(または admin)が必要です。
operationId setRoutineSchedule · #
パラメーター
id | path 必須 | string The routine's id.ルーティンの ID です。 |
|---|---|---|
Idempotency-Key | header | string (長さ ≥ 1, 長さ ≤ 255) # |
リクエストボディ
application/jsonobject
cronstring 必須timezonestring
レスポンス
200 成功しました。
application/jsonobject 任意のフィールドを含む
400リクエストを解釈できませんでした。401キーがない、形式が正しくない、または不明・失効・期限切れのキーです。403キーにスコープがないか、キーの持ち主にこの操作が許可されていません。404見つからないか、キーの持ち主からは見えません。409同じ Idempotency-Key のリクエストをまだ処理中です。Retry-After を参照してください。422この Idempotency-Key は別のリクエストで使われています。429このアドレスからのキーの失敗が多すぎます。Retry-After を参照してください。
application/jsonapplication/problem+jsonPOST /api/routines/schedule-preview Check a schedule and see its next runs, without saving anythingスケジュールを確認して次の実行を見る(何も保存しません) manage:routines
Requires the manage:routines scope (or admin).
manage:routines スコープ(または admin)が必要です。
operationId previewRoutineSchedule · #
パラメーター
Idempotency-Key | header | string (長さ ≥ 1, 長さ ≤ 255) # |
|---|
リクエストボディ
application/jsonobject
cronstring 必須timezonestring
レスポンス
200 成功しました。
application/jsonobject 任意のフィールドを含む
400リクエストを解釈できませんでした。401キーがない、形式が正しくない、または不明・失効・期限切れのキーです。403キーにスコープがないか、キーの持ち主にこの操作が許可されていません。404見つからないか、キーの持ち主からは見えません。409同じ Idempotency-Key のリクエストをまだ処理中です。Retry-After を参照してください。422この Idempotency-Key は別のリクエストで使われています。429このアドレスからのキーの失敗が多すぎます。Retry-After を参照してください。
application/jsonapplication/problem+jsonPUT /api/routines/{id}/enabled Switch a routine on or offルーティンをオンまたはオフにする manage:routines
Requires the manage:routines scope (or admin).
manage:routines スコープ(または admin)が必要です。
operationId setRoutineEnabled · #
パラメーター
id | path 必須 | string The routine's id.ルーティンの ID です。 |
|---|---|---|
Idempotency-Key | header | string (長さ ≥ 1, 長さ ≤ 255) # |
リクエストボディ
application/jsonobject
enabledboolean 必須
レスポンス
200 成功しました。
application/jsonobject
enabledboolean
400リクエストを解釈できませんでした。401キーがない、形式が正しくない、または不明・失効・期限切れのキーです。403キーにスコープがないか、キーの持ち主にこの操作が許可されていません。404見つからないか、キーの持ち主からは見えません。409同じ Idempotency-Key のリクエストをまだ処理中です。Retry-After を参照してください。422この Idempotency-Key は別のリクエストで使われています。429このアドレスからのキーの失敗が多すぎます。Retry-After を参照してください。
application/jsonapplication/problem+jsonDELETE /api/routines/{id} Delete a routineルーティンを削除 manage:routines
Requires the manage:routines scope (or admin).
manage:routines スコープ(または admin)が必要です。
operationId deleteRoutine · #
パラメーター
id | path 必須 | string The routine's id.ルーティンの ID です。 |
|---|---|---|
Idempotency-Key | header | string (長さ ≥ 1, 長さ ≤ 255) # |
レスポンス
204 Done.完了しました。
400リクエストを解釈できませんでした。401キーがない、形式が正しくない、または不明・失効・期限切れのキーです。403キーにスコープがないか、キーの持ち主にこの操作が許可されていません。404見つからないか、キーの持ち主からは見えません。409同じ Idempotency-Key のリクエストをまだ処理中です。Retry-After を参照してください。422この Idempotency-Key は別のリクエストで使われています。429このアドレスからのキーの失敗が多すぎます。Retry-After を参照してください。
application/jsonapplication/problem+jsonTriggersトリガーこのセクションへのリンクをコピー
GET /api/routines/{id}/triggers The event triggers that start a routineルーティンを始めるイベントトリガー read:routines
Requires the read:routines scope (or admin).
read:routines スコープ(または admin)が必要です。
operationId listRoutineTriggers · #
パラメーター
id | path 必須 | string The routine's id.ルーティンの ID です。 |
|---|---|---|
limit | query | integer (≥ 1, ≤ 200) At most this many items, 1 to 200. The answer then carries nextCursor, null on the last page.最大件数で、1〜200 です。指定すると応答に nextCursor が含まれ、最後のページでは null になります。 |
cursor | query | string The nextCursor of the previous page.前のページの nextCursor です。 |
filter | query | string A condition the items must meet: a field (dots reach into objects), an operator ( = != > >= < <=, or ~ for contains) and a value, such as createdAt>=2026-10-01. Repeat for up to 10; all must hold.項目が満たすべき条件です。フィールド(ドットでオブジェクトの中を指定)、演算子(= != > >= < <=、または「含む」を表す ~)、値の順に createdAt>=2026-10-01 のように書きます。最大 10 個まで繰り返せ、すべてを満たす必要があります。 |
レスポンス
200 成功しました。
application/jsonobject
triggers配列: objectnextCursorstring または null Only whenlimit,cursororfilterwas sent: the next page's cursor, or null.limit、cursor、filterのいずれかを送ったときだけ含まれる、次のページのカーソル、または null です。
POST /api/routines/{id}/triggers Add a trigger that starts a routineルーティンを始めるトリガーを追加 manage:routines
The answer carries the trigger's signing secret, in this answer only. Keep it where the sender can use it.
Requires the manage:routines scope (or admin).
応答にはトリガーの署名用シークレットが含まれます(この応答でのみ)。送信側が使える場所に保管してください。
manage:routines スコープ(または admin)が必要です。
operationId createRoutineTrigger · #
パラメーター
id | path 必須 | string The routine's id.ルーティンの ID です。 |
|---|---|---|
Idempotency-Key | header | string (長さ ≥ 1, 長さ ≤ 255) # |
リクエストボディ
application/jsonobject
configobject 必須 The trigger's kind and settings, as the app saves them.トリガーの種類と設定で、アプリが保存する形式と同じです。secretstring A secret of your own; one is generated when omitted.あなた独自のシークレットです。省略すると生成されます。
レスポンス
201 成功しました。
application/jsonobject
triggerobjectsecretstring または null
400リクエストを解釈できませんでした。401キーがない、形式が正しくない、または不明・失効・期限切れのキーです。403キーにスコープがないか、キーの持ち主にこの操作が許可されていません。404見つからないか、キーの持ち主からは見えません。409同じ Idempotency-Key のリクエストをまだ処理中です。Retry-After を参照してください。422この Idempotency-Key は別のリクエストで使われています。429このアドレスからのキーの失敗が多すぎます。Retry-After を参照してください。
application/jsonapplication/problem+jsonDELETE /api/routines/{id}/triggers/{triggerId} Remove a routine's triggerルーティンのトリガーを削除 manage:routines
Requires the manage:routines scope (or admin).
manage:routines スコープ(または admin)が必要です。
operationId deleteRoutineTrigger · #
パラメーター
id | path 必須 | string The routine's id.ルーティンの ID です。 |
|---|---|---|
triggerId | path 必須 | string The trigger's id.トリガーの ID です。 |
Idempotency-Key | header | string (長さ ≥ 1, 長さ ≤ 255) # |
レスポンス
204 Done.完了しました。
400リクエストを解釈できませんでした。401キーがない、形式が正しくない、または不明・失効・期限切れのキーです。403キーにスコープがないか、キーの持ち主にこの操作が許可されていません。404見つからないか、キーの持ち主からは見えません。409同じ Idempotency-Key のリクエストをまだ処理中です。Retry-After を参照してください。422この Idempotency-Key は別のリクエストで使われています。429このアドレスからのキーの失敗が多すぎます。Retry-After を参照してください。
application/jsonapplication/problem+jsonGET /api/responsibilities/{id}/triggers The event triggers that start a responsibility担当業務を始めるイベントトリガー read:responsibilities
Requires the read:responsibilities scope (or admin).
read:responsibilities スコープ(または admin)が必要です。
operationId listResponsibilityTriggers · #
パラメーター
id | path 必須 | string The responsibility's id.担当業務の ID です。 |
|---|---|---|
limit | query | integer (≥ 1, ≤ 200) At most this many items, 1 to 200. The answer then carries nextCursor, null on the last page.最大件数で、1〜200 です。指定すると応答に nextCursor が含まれ、最後のページでは null になります。 |
cursor | query | string The nextCursor of the previous page.前のページの nextCursor です。 |
filter | query | string A condition the items must meet: a field (dots reach into objects), an operator ( = != > >= < <=, or ~ for contains) and a value, such as createdAt>=2026-10-01. Repeat for up to 10; all must hold.項目が満たすべき条件です。フィールド(ドットでオブジェクトの中を指定)、演算子(= != > >= < <=、または「含む」を表す ~)、値の順に createdAt>=2026-10-01 のように書きます。最大 10 個まで繰り返せ、すべてを満たす必要があります。 |
レスポンス
200 成功しました。
application/jsonobject
triggers配列: objectnextCursorstring または null Only whenlimit,cursororfilterwas sent: the next page's cursor, or null.limit、cursor、filterのいずれかを送ったときだけ含まれる、次のページのカーソル、または null です。
POST /api/responsibilities/{id}/triggers Add a trigger that starts a responsibility担当業務を始めるトリガーを追加 manage:responsibilities
The answer carries the trigger's signing secret, in this answer only.
Requires the manage:responsibilities scope (or admin).
応答にはトリガーの署名用シークレットが含まれます(この応答でのみ)。
manage:responsibilities スコープ(または admin)が必要です。
operationId createResponsibilityTrigger · #
パラメーター
id | path 必須 | string The responsibility's id.担当業務の ID です。 |
|---|---|---|
Idempotency-Key | header | string (長さ ≥ 1, 長さ ≤ 255) # |
リクエストボディ
application/jsonobject
configobject 必須 The trigger's kind and settings, as the app saves them.トリガーの種類と設定で、アプリが保存する形式と同じです。secretstring A secret of your own; one is generated when omitted.あなた独自のシークレットです。省略すると生成されます。
レスポンス
201 成功しました。
application/jsonobject
triggerobjectsecretstring または null
400リクエストを解釈できませんでした。401キーがない、形式が正しくない、または不明・失効・期限切れのキーです。403キーにスコープがないか、キーの持ち主にこの操作が許可されていません。404見つからないか、キーの持ち主からは見えません。409同じ Idempotency-Key のリクエストをまだ処理中です。Retry-After を参照してください。422この Idempotency-Key は別のリクエストで使われています。429このアドレスからのキーの失敗が多すぎます。Retry-After を参照してください。
application/jsonapplication/problem+jsonPATCH /api/responsibilities/triggers/{triggerId} Change a trigger's settingsトリガーの設定を変更 manage:responsibilities
Any trigger the owner has, whether it starts a routine or a responsibility.
Requires the manage:responsibilities scope (or admin).
ルーティンを始めるものでも担当業務を始めるものでも、所有者のどのトリガーにも使えます。
manage:responsibilities スコープ(または admin)が必要です。
operationId updateTrigger · #
パラメーター
triggerId | path 必須 | string The trigger's id.トリガーの ID です。 |
|---|---|---|
Idempotency-Key | header | string (長さ ≥ 1, 長さ ≤ 255) # |
リクエストボディ
application/jsonobject
configobject 必須
レスポンス
200 成功しました。
application/jsonobject
triggerobject
400リクエストを解釈できませんでした。401キーがない、形式が正しくない、または不明・失効・期限切れのキーです。403キーにスコープがないか、キーの持ち主にこの操作が許可されていません。404見つからないか、キーの持ち主からは見えません。409同じ Idempotency-Key のリクエストをまだ処理中です。Retry-After を参照してください。422この Idempotency-Key は別のリクエストで使われています。429このアドレスからのキーの失敗が多すぎます。Retry-After を参照してください。
application/jsonapplication/problem+jsonDELETE /api/responsibilities/triggers/{triggerId} Remove a triggerトリガーを削除 manage:responsibilities
Requires the manage:responsibilities scope (or admin).
manage:responsibilities スコープ(または admin)が必要です。
operationId deleteTrigger · #
パラメーター
triggerId | path 必須 | string The trigger's id.トリガーの ID です。 |
|---|---|---|
Idempotency-Key | header | string (長さ ≥ 1, 長さ ≤ 255) # |
レスポンス
204 Done.完了しました。
400リクエストを解釈できませんでした。401キーがない、形式が正しくない、または不明・失効・期限切れのキーです。403キーにスコープがないか、キーの持ち主にこの操作が許可されていません。404見つからないか、キーの持ち主からは見えません。409同じ Idempotency-Key のリクエストをまだ処理中です。Retry-After を参照してください。422この Idempotency-Key は別のリクエストで使われています。429このアドレスからのキーの失敗が多すぎます。Retry-After を参照してください。
application/jsonapplication/problem+jsonPUT /api/responsibilities/triggers/{triggerId}/enabled Pause or resume a triggerトリガーを一時停止または再開 manage:responsibilities
Requires the manage:responsibilities scope (or admin).
manage:responsibilities スコープ(または admin)が必要です。
operationId setTriggerEnabled · #
パラメーター
triggerId | path 必須 | string The trigger's id.トリガーの ID です。 |
|---|---|---|
Idempotency-Key | header | string (長さ ≥ 1, 長さ ≤ 255) # |
リクエストボディ
application/jsonobject
enabledboolean 必須
レスポンス
200 成功しました。
application/jsonobject
triggerobject
400リクエストを解釈できませんでした。401キーがない、形式が正しくない、または不明・失効・期限切れのキーです。403キーにスコープがないか、キーの持ち主にこの操作が許可されていません。404見つからないか、キーの持ち主からは見えません。409同じ Idempotency-Key のリクエストをまだ処理中です。Retry-After を参照してください。422この Idempotency-Key は別のリクエストで使われています。429このアドレスからのキーの失敗が多すぎます。Retry-After を参照してください。
application/jsonapplication/problem+jsonPOST /api/responsibilities/triggers/{triggerId}/secret Give a trigger a new signing secretトリガーに新しい署名用シークレットを発行 manage:responsibilities
The old secret stops working at once. The new one is in this answer only; send your own as secret to set it instead.
Requires the manage:responsibilities scope (or admin).
古いシークレットはすぐに使えなくなります。新しいシークレットはこの応答にのみ含まれます。代わりに自分で決めたものを設定するには secret で送ってください。
manage:responsibilities スコープ(または admin)が必要です。
operationId rotateTriggerSecret · #
パラメーター
triggerId | path 必須 | string The trigger's id.トリガーの ID です。 |
|---|---|---|
Idempotency-Key | header | string (長さ ≥ 1, 長さ ≤ 255) # |
リクエストボディ
application/jsonobject
secretstring Optional: your own secret.任意:あなた独自のシークレットです。
レスポンス
200 成功しました。
application/jsonobject
triggerobjectsecretstring または null
400リクエストを解釈できませんでした。401キーがない、形式が正しくない、または不明・失効・期限切れのキーです。403キーにスコープがないか、キーの持ち主にこの操作が許可されていません。404見つからないか、キーの持ち主からは見えません。409同じ Idempotency-Key のリクエストをまだ処理中です。Retry-After を参照してください。422この Idempotency-Key は別のリクエストで使われています。429このアドレスからのキーの失敗が多すぎます。Retry-After を参照してください。
application/jsonapplication/problem+jsonResponsibilities担当業務このセクションへのリンクをコピー
GET /api/responsibilities The owner's responsibilities所有者の担当業務 read:responsibilities
Requires the read:responsibilities scope (or admin).
read:responsibilities スコープ(または admin)が必要です。
operationId listResponsibilities · #
パラメーター
limit | query | integer (≥ 1, ≤ 200) At most this many items, 1 to 200. The answer then carries nextCursor, null on the last page.最大件数で、1〜200 です。指定すると応答に nextCursor が含まれ、最後のページでは null になります。 |
|---|---|---|
cursor | query | string The nextCursor of the previous page.前のページの nextCursor です。 |
filter | query | string A condition the items must meet: a field (dots reach into objects), an operator ( = != > >= < <=, or ~ for contains) and a value, such as createdAt>=2026-10-01. Repeat for up to 10; all must hold.項目が満たすべき条件です。フィールド(ドットでオブジェクトの中を指定)、演算子(= != > >= < <=、または「含む」を表す ~)、値の順に createdAt>=2026-10-01 のように書きます。最大 10 個まで繰り返せ、すべてを満たす必要があります。 |
レスポンス
200 成功しました。
application/jsonobject
responsibilities配列: objectnextCursorstring または null Only whenlimit,cursororfilterwas sent: the next page's cursor, or null.limit、cursor、filterのいずれかを送ったときだけ含まれる、次のページのカーソル、または null です。
POST /api/responsibilities Create a responsibility担当業務を作成 manage:responsibilities
The same fields and checks as the form in the app: the Bot that holds it, the goal in plain words, and how it is started.
Requires the manage:responsibilities scope (or admin).
アプリのフォームと同じ項目と確認です。担当する Bot、平易な言葉での目標、始まり方を指定します。
manage:responsibilities スコープ(または admin)が必要です。
operationId createResponsibility · #
パラメーター
Idempotency-Key | header | string (長さ ≥ 1, 長さ ≤ 255) # |
|---|
リクエストボディ
application/jsonobject 任意のフィールドを含む
レスポンス
201 成功しました。
application/jsonobject
responsibilityobject
400リクエストを解釈できませんでした。401キーがない、形式が正しくない、または不明・失効・期限切れのキーです。403キーにスコープがないか、キーの持ち主にこの操作が許可されていません。404見つからないか、キーの持ち主からは見えません。409同じ Idempotency-Key のリクエストをまだ処理中です。Retry-After を参照してください。422この Idempotency-Key は別のリクエストで使われています。429このアドレスからのキーの失敗が多すぎます。Retry-After を参照してください。
application/jsonapplication/problem+jsonGET /api/responsibilities/{id} One responsibility1 つの担当業務 read:responsibilities
Requires the read:responsibilities scope (or admin).
read:responsibilities スコープ(または admin)が必要です。
operationId getResponsibility · #
パラメーター
id | path 必須 | string The responsibility's id.担当業務の ID です。 |
|---|
レスポンス
200 成功しました。
application/jsonobject
responsibilityobject
PATCH /api/responsibilities/{id} Change a responsibility担当業務を変更 manage:responsibilities
Requires the manage:responsibilities scope (or admin).
manage:responsibilities スコープ(または admin)が必要です。
operationId updateResponsibility · #
パラメーター
id | path 必須 | string The responsibility's id.担当業務の ID です。 |
|---|---|---|
Idempotency-Key | header | string (長さ ≥ 1, 長さ ≤ 255) # |
リクエストボディ
application/jsonobject 任意のフィールドを含む
レスポンス
200 成功しました。
application/jsonobject
responsibilityobject
400リクエストを解釈できませんでした。401キーがない、形式が正しくない、または不明・失効・期限切れのキーです。403キーにスコープがないか、キーの持ち主にこの操作が許可されていません。404見つからないか、キーの持ち主からは見えません。409同じ Idempotency-Key のリクエストをまだ処理中です。Retry-After を参照してください。422この Idempotency-Key は別のリクエストで使われています。429このアドレスからのキーの失敗が多すぎます。Retry-After を参照してください。
application/jsonapplication/problem+jsonGET /api/responsibilities/{id}/runs One responsibility's runs1 つの担当業務の実行 read:responsibilities
Requires the read:responsibilities scope (or admin).
read:responsibilities スコープ(または admin)が必要です。
operationId listResponsibilityRuns · #
パラメーター
id | path 必須 | string The responsibility's id.担当業務の ID です。 |
|---|---|---|
limit | query | integer (≥ 1, ≤ 200) At most this many items, 1 to 200. The answer then carries nextCursor, null on the last page.最大件数で、1〜200 です。指定すると応答に nextCursor が含まれ、最後のページでは null になります。 |
cursor | query | string The nextCursor of the previous page.前のページの nextCursor です。 |
filter | query | string A condition the items must meet: a field (dots reach into objects), an operator ( = != > >= < <=, or ~ for contains) and a value, such as createdAt>=2026-10-01. Repeat for up to 10; all must hold.項目が満たすべき条件です。フィールド(ドットでオブジェクトの中を指定)、演算子(= != > >= < <=、または「含む」を表す ~)、値の順に createdAt>=2026-10-01 のように書きます。最大 10 個まで繰り返せ、すべてを満たす必要があります。 |
レスポンス
200 成功しました。
application/jsonobject
runs配列: objectnextCursorstring または null Only whenlimit,cursororfilterwas sent: the next page's cursor, or null.limit、cursor、filterのいずれかを送ったときだけ含まれる、次のページのカーソル、または null です。
POST /api/responsibilities/{id}/pause Pause a responsibility担当業務を一時停止 manage:responsibilities
Requires the manage:responsibilities scope (or admin).
manage:responsibilities スコープ(または admin)が必要です。
operationId pauseResponsibility · #
パラメーター
id | path 必須 | string The responsibility's id.担当業務の ID です。 |
|---|---|---|
Idempotency-Key | header | string (長さ ≥ 1, 長さ ≤ 255) # |
レスポンス
200 成功しました。
application/jsonobject
responsibilityobject
400リクエストを解釈できませんでした。401キーがない、形式が正しくない、または不明・失効・期限切れのキーです。403キーにスコープがないか、キーの持ち主にこの操作が許可されていません。404見つからないか、キーの持ち主からは見えません。409同じ Idempotency-Key のリクエストをまだ処理中です。Retry-After を参照してください。422この Idempotency-Key は別のリクエストで使われています。429このアドレスからのキーの失敗が多すぎます。Retry-After を参照してください。
application/jsonapplication/problem+jsonPOST /api/responsibilities/{id}/resume Resume a paused responsibility一時停止した担当業務を再開 manage:responsibilities
Requires the manage:responsibilities scope (or admin).
manage:responsibilities スコープ(または admin)が必要です。
operationId resumeResponsibility · #
パラメーター
id | path 必須 | string The responsibility's id.担当業務の ID です。 |
|---|---|---|
Idempotency-Key | header | string (長さ ≥ 1, 長さ ≤ 255) # |
レスポンス
200 成功しました。
application/jsonobject
responsibilityobject
400リクエストを解釈できませんでした。401キーがない、形式が正しくない、または不明・失効・期限切れのキーです。403キーにスコープがないか、キーの持ち主にこの操作が許可されていません。404見つからないか、キーの持ち主からは見えません。409同じ Idempotency-Key のリクエストをまだ処理中です。Retry-After を参照してください。422この Idempotency-Key は別のリクエストで使われています。429このアドレスからのキーの失敗が多すぎます。Retry-After を参照してください。
application/jsonapplication/problem+jsonPOST /api/responsibilities/{id}/complete Mark a responsibility complete担当業務を完了にする manage:responsibilities
Requires the manage:responsibilities scope (or admin).
manage:responsibilities スコープ(または admin)が必要です。
operationId completeResponsibility · #
パラメーター
id | path 必須 | string The responsibility's id.担当業務の ID です。 |
|---|---|---|
Idempotency-Key | header | string (長さ ≥ 1, 長さ ≤ 255) # |
レスポンス
200 成功しました。
application/jsonobject
responsibilityobject
400リクエストを解釈できませんでした。401キーがない、形式が正しくない、または不明・失効・期限切れのキーです。403キーにスコープがないか、キーの持ち主にこの操作が許可されていません。404見つからないか、キーの持ち主からは見えません。409同じ Idempotency-Key のリクエストをまだ処理中です。Retry-After を参照してください。422この Idempotency-Key は別のリクエストで使われています。429このアドレスからのキーの失敗が多すぎます。Retry-After を参照してください。
application/jsonapplication/problem+jsonPOST /api/responsibilities/{id}/run Run a responsibility now担当業務を今すぐ実行 manage:responsibilities
Real work: its Bot takes it up as if it had been started. A paused or completed one is refused.
Requires the manage:responsibilities scope (or admin).
実際の作業です。担当の Bot が、始まったときと同じように取りかかります。一時停止中または完了済みのものは拒否されます。
manage:responsibilities スコープ(または admin)が必要です。
operationId runResponsibility · #
パラメーター
id | path 必須 | string The responsibility's id.担当業務の ID です。 |
|---|---|---|
Idempotency-Key | header | string (長さ ≥ 1, 長さ ≤ 255) # |
レスポンス
202 成功しました。
application/jsonobject 任意のフィールドを含む
400リクエストを解釈できませんでした。401キーがない、形式が正しくない、または不明・失効・期限切れのキーです。403キーにスコープがないか、キーの持ち主にこの操作が許可されていません。404見つからないか、キーの持ち主からは見えません。409同じ Idempotency-Key のリクエストをまだ処理中です。Retry-After を参照してください。422この Idempotency-Key は別のリクエストで使われています。429このアドレスからのキーの失敗が多すぎます。Retry-After を参照してください。
application/jsonapplication/problem+jsonApprovals承認このセクションへのリンクをコピー
GET /api/approvals Approval requests and Bot questions waiting for the owner所有者を待っている承認依頼と Bot の質問 read:approvals
requests are the owner's own, addressed the ones waiting on somebody else that the owner may answer (as a delegate or backup approver), and questions the Bots' open questions.
Requires the read:approvals scope (or admin).
requests は所有者自身のもの、addressed はほかの人を待っているもので所有者が(代理または予備の承認者として)答えられるもの、questions は Bot の未回答の質問です。
read:approvals スコープ(または admin)が必要です。
operationId listApprovals · #
レスポンス
200 成功しました。
application/jsonobject
requests配列: objectaddressed配列: objectquestions配列: object
GET /api/approvals/{id}/context What the Bot saw and said when it asked依頼したときに Bot が見ていたものと言ったこと read:approvals
Requires the read:approvals scope (or admin).
read:approvals スコープ(または admin)が必要です。
operationId getApprovalContext · #
パラメーター
id | path 必須 | string The approval request's id.承認リクエストの ID です。 |
|---|
レスポンス
200 成功しました。
application/jsonobject 任意のフィールドを含む
POST /api/approvals/{id}/decision Approve or refuse one request, as the owner所有者として 1 件の依頼を承認または拒否 write:approvals
Exactly the choices the approval card offers. The audit trail records the decision with the key's name. A request that needs a reason to approve is refused without one, and a two-person request still needs its second approver.
Requires the write:approvals scope (or admin).
承認カードが示す選択肢そのままです。監査証跡にはキーの名前とともに判断が記録されます。承認に理由が必要な依頼は理由がなければ拒否され、2 人承認の依頼には 2 人目の承認者が引き続き必要です。
write:approvals スコープ(または admin)が必要です。
operationId decideApproval · #
パラメーター
id | path 必須 | string The approval request's id.承認リクエストの ID です。 |
|---|---|---|
Idempotency-Key | header | string (長さ ≥ 1, 長さ ≤ 255) # |
リクエストボディ
application/jsonobject
decision次のいずれか:"allow_once","allow_always","deny","handled"必須notestring (長さ ≤ 500) With deny: told to the Bot with the refusal.deny のとき:拒否と一緒に Bot に伝えられます。reasonstring (長さ ≤ 500) With an approval: why. Required for a high-risk request.承認のとき:その理由です。リスクの高いリクエストでは必須です。
レスポンス
200 成功しました。
application/jsonobject
idstringstatusstring
400リクエストを解釈できませんでした。401キーがない、形式が正しくない、または不明・失効・期限切れのキーです。403キーにスコープがないか、キーの持ち主にこの操作が許可されていません。404見つからないか、キーの持ち主からは見えません。409同じ Idempotency-Key のリクエストをまだ処理中です。Retry-After を参照してください。422この Idempotency-Key は別のリクエストで使われています。429このアドレスからのキーの失敗が多すぎます。Retry-After を参照してください。
application/jsonapplication/problem+jsonPOST /api/approvals/decisions Approve or refuse several requests for the same action at once同じ操作の複数の依頼をまとめて承認または拒否 write:approvals
Refused as a whole, and nothing decided, unless every request may be answered together.
Requires the write:approvals scope (or admin).
すべての依頼をまとめて答えられる場合を除き、全体として拒否され、何も判断されません。
write:approvals スコープ(または admin)が必要です。
operationId decideApprovals · #
パラメーター
Idempotency-Key | header | string (長さ ≥ 1, 長さ ≤ 255) # |
|---|
リクエストボディ
application/jsonobject
ids配列: string 必須decision次のいずれか:"approve","deny"必須notestring (長さ ≤ 500)reasonstring (長さ ≤ 500)
レスポンス
200 成功しました。
application/jsonobject 任意のフィールドを含む
400リクエストを解釈できませんでした。401キーがない、形式が正しくない、または不明・失効・期限切れのキーです。403キーにスコープがないか、キーの持ち主にこの操作が許可されていません。404見つからないか、キーの持ち主からは見えません。409同じ Idempotency-Key のリクエストをまだ処理中です。Retry-After を参照してください。422この Idempotency-Key は別のリクエストで使われています。429このアドレスからのキーの失敗が多すぎます。Retry-After を参照してください。
application/jsonapplication/problem+jsonPOST /api/approvals/questions/{id}/respond Answer a Bot's question, so its work can carry onBot の質問に答えて作業を続けさせる write:approvals
Requires the write:approvals scope (or admin).
write:approvals スコープ(または admin)が必要です。
operationId answerQuestion · #
パラメーター
id | path 必須 | string The question's id, from questions in the list.質問の ID で、一覧の questions から取得します。 |
|---|---|---|
Idempotency-Key | header | string (長さ ≥ 1, 長さ ≤ 255) # |
リクエストボディ
application/jsonobject
responsestring (長さ ≥ 1, 長さ ≤ 6000) 必須
レスポンス
200 成功しました。
application/jsonobject
idstringqueuedboolean
400リクエストを解釈できませんでした。401キーがない、形式が正しくない、または不明・失効・期限切れのキーです。403キーにスコープがないか、キーの持ち主にこの操作が許可されていません。404見つからないか、キーの持ち主からは見えません。409同じ Idempotency-Key のリクエストをまだ処理中です。Retry-After を参照してください。422この Idempotency-Key は別のリクエストで使われています。429このアドレスからのキーの失敗が多すぎます。Retry-After を参照してください。
application/jsonapplication/problem+jsonMemoryメモリーこのセクションへのリンクをコピー
GET /api/memory The memories the owner's Bots keep about them所有者について Bot が覚えているメモリー read:memory
Requires the read:memory scope (or admin).
read:memory スコープ(または admin)が必要です。
operationId listMemories · #
パラメーター
limit | query | integer (≥ 1, ≤ 200) At most this many items, 1 to 200. The answer then carries nextCursor, null on the last page.最大件数で、1〜200 です。指定すると応答に nextCursor が含まれ、最後のページでは null になります。 |
|---|---|---|
cursor | query | string The nextCursor of the previous page.前のページの nextCursor です。 |
filter | query | string A condition the items must meet: a field (dots reach into objects), an operator ( = != > >= < <=, or ~ for contains) and a value, such as createdAt>=2026-10-01. Repeat for up to 10; all must hold.項目が満たすべき条件です。フィールド(ドットでオブジェクトの中を指定)、演算子(= != > >= < <=、または「含む」を表す ~)、値の順に createdAt>=2026-10-01 のように書きます。最大 10 個まで繰り返せ、すべてを満たす必要があります。 |
レスポンス
200 成功しました。
application/jsonobject
memories配列: objectnextCursorstring または null Only whenlimit,cursororfilterwas sent: the next page's cursor, or null.limit、cursor、filterのいずれかを送ったときだけ含まれる、次のページのカーソル、または null です。
POST /api/memory Add a memoryメモリーを追加 write:memory
Requires the write:memory scope (or admin).
write:memory スコープ(または admin)が必要です。
operationId createMemory · #
パラメーター
Idempotency-Key | header | string (長さ ≥ 1, 長さ ≤ 255) # |
|---|
リクエストボディ
application/jsonobject
contentstring (長さ ≥ 1, 長さ ≤ 6000) 必須provenancestring (長さ ≤ 500) Where it came from. Defaults to “You”.出どころです。既定は「You」です。enabledbooleancategory次のいずれか:"preference","fact_about_me","project","contact","working_style",null
レスポンス
201 成功しました。
application/jsonobject
memoryobject
400リクエストを解釈できませんでした。401キーがない、形式が正しくない、または不明・失効・期限切れのキーです。403キーにスコープがないか、キーの持ち主にこの操作が許可されていません。404見つからないか、キーの持ち主からは見えません。409同じ Idempotency-Key のリクエストをまだ処理中です。Retry-After を参照してください。422この Idempotency-Key は別のリクエストで使われています。429このアドレスからのキーの失敗が多すぎます。Retry-After を参照してください。
application/jsonapplication/problem+jsonPATCH /api/memory/{id} Edit, switch off or confirm a memoryメモリーを編集、無効化、または確認 write:memory
Requires the write:memory scope (or admin).
write:memory スコープ(または admin)が必要です。
operationId updateMemory · #
パラメーター
id | path 必須 | string The memory's id.メモリーの ID です。 |
|---|---|---|
Idempotency-Key | header | string (長さ ≥ 1, 長さ ≤ 255) # |
リクエストボディ
application/jsonobject
contentstring (長さ ≥ 1, 長さ ≤ 6000)enabledbooleanreviewState次のいずれか:"unreviewed","confirmed","edited"category次のいずれか:"preference","fact_about_me","project","contact","working_style",null
レスポンス
200 成功しました。
application/jsonobject
memoryobject
400リクエストを解釈できませんでした。401キーがない、形式が正しくない、または不明・失効・期限切れのキーです。403キーにスコープがないか、キーの持ち主にこの操作が許可されていません。404見つからないか、キーの持ち主からは見えません。409同じ Idempotency-Key のリクエストをまだ処理中です。Retry-After を参照してください。422この Idempotency-Key は別のリクエストで使われています。429このアドレスからのキーの失敗が多すぎます。Retry-After を参照してください。
application/jsonapplication/problem+jsonDELETE /api/memory/{id} Forget a memoryメモリーを忘れさせる write:memory
Requires the write:memory scope (or admin).
write:memory スコープ(または admin)が必要です。
operationId deleteMemory · #
パラメーター
id | path 必須 | string The memory's id.メモリーの ID です。 |
|---|---|---|
Idempotency-Key | header | string (長さ ≥ 1, 長さ ≤ 255) # |
レスポンス
204 Done.完了しました。
400リクエストを解釈できませんでした。401キーがない、形式が正しくない、または不明・失効・期限切れのキーです。403キーにスコープがないか、キーの持ち主にこの操作が許可されていません。404見つからないか、キーの持ち主からは見えません。409同じ Idempotency-Key のリクエストをまだ処理中です。Retry-After を参照してください。422この Idempotency-Key は別のリクエストで使われています。429このアドレスからのキーの失敗が多すぎます。Retry-After を参照してください。
application/jsonapplication/problem+jsonMCPMCPこのセクションへのリンクをコピー
POST /api/mcp This workspace as an MCP server (JSON-RPC over HTTP)MCP サーバーとしてのこのワークスペース(HTTP 上の JSON-RPC) use:mcp
MCP over HTTP for a desktop assistant or code editor, with the key as a bearer token (one JSON-RPC message per request). Tools follow the key's other scopes; read:files adds files as resources, manage:skills skills as prompts. Each call gets the matching endpoint's checks and audit trail.
Requires the use:mcp scope (or admin).
デスクトップアシスタントやコードエディター向けの HTTP 上の MCP で、キーをベアラートークンとして使います(1 リクエストに 1 つの JSON-RPC メッセージ)。ツールはキーのほかのスコープに従い、read:files でファイルがリソースに、manage:skills でスキルがプロンプトに加わります。各呼び出しには、対応するエンドポイントの確認と監査証跡が適用されます。
use:mcp スコープ(または admin)が必要です。
operationId mcp · #
パラメーター
Idempotency-Key | header | string (長さ ≥ 1, 長さ ≤ 255) # |
|---|
リクエストボディ
application/jsonobject
jsonrpc次のいずれか:"2.0"必須idstring または integermethodstring 必須paramsobject
レスポンス
200 成功しました。
application/jsonobject 任意のフィールドを含む
400リクエストを解釈できませんでした。401キーがない、形式が正しくない、または不明・失効・期限切れのキーです。403キーにスコープがないか、キーの持ち主にこの操作が許可されていません。404見つからないか、キーの持ち主からは見えません。409同じ Idempotency-Key のリクエストをまだ処理中です。Retry-After を参照してください。422この Idempotency-Key は別のリクエストで使われています。429このアドレスからのキーの失敗が多すぎます。Retry-After を参照してください。
application/jsonapplication/problem+jsonPOST /api/mcp/bots/{botId} One Bot as an MCP serverMCP サーバーとしての 1 つの Bot use:mcp
Tools to message this Bot and wait for its answer, and to read, wait for and stop its runs; its workspace files as resources and its skills as prompts. Runs and files of other Bots are refused.
Requires the use:mcp scope (or admin).
この Bot にメッセージを送って応答を待つツール、その実行を読む・待つ・止めるツール、ワークスペースのファイルをリソースとして、スキルをプロンプトとして提供します。ほかの Bot の実行やファイルは拒否されます。
use:mcp スコープ(または admin)が必要です。
operationId mcpForBot · #
パラメーター
botId | path 必須 | string The Bot's id.Bot の ID です。 |
|---|---|---|
Idempotency-Key | header | string (長さ ≥ 1, 長さ ≤ 255) # |
リクエストボディ
application/jsonobject
jsonrpc次のいずれか:"2.0"必須idstring または integermethodstring 必須paramsobject
レスポンス
200 成功しました。
application/jsonobject 任意のフィールドを含む
400リクエストを解釈できませんでした。401キーがない、形式が正しくない、または不明・失効・期限切れのキーです。403キーにスコープがないか、キーの持ち主にこの操作が許可されていません。404見つからないか、キーの持ち主からは見えません。409同じ Idempotency-Key のリクエストをまだ処理中です。Retry-After を参照してください。422この Idempotency-Key は別のリクエストで使われています。429このアドレスからのキーの失敗が多すぎます。Retry-After を参照してください。
application/jsonapplication/problem+jsonPOST /api/mcp/audit The audit trail as an MCP serverMCP サーバーとしての監査証跡 use:mcp
Read-only tools to search the audit trail, count it by event type, person and day, and list event types. Needs read:audit, on an administrator's key.
Requires the use:mcp scope (or admin).
監査証跡を検索し、イベントの種類・人・日ごとに数え、イベントの種類を一覧にする読み取り専用のツールです。管理者のキーで read:audit が必要です。
use:mcp スコープ(または admin)が必要です。
operationId mcpForAudit · #
パラメーター
Idempotency-Key | header | string (長さ ≥ 1, 長さ ≤ 255) # |
|---|
リクエストボディ
application/jsonobject
jsonrpc次のいずれか:"2.0"必須idstring または integermethodstring 必須paramsobject
レスポンス
200 成功しました。
application/jsonobject 任意のフィールドを含む
400リクエストを解釈できませんでした。401キーがない、形式が正しくない、または不明・失効・期限切れのキーです。403キーにスコープがないか、キーの持ち主にこの操作が許可されていません。404見つからないか、キーの持ち主からは見えません。409同じ Idempotency-Key のリクエストをまだ処理中です。Retry-After を参照してください。422この Idempotency-Key は別のリクエストで使われています。429このアドレスからのキーの失敗が多すぎます。Retry-After を参照してください。
application/jsonapplication/problem+jsonPOST /api/mcp/routines Routines as an MCP serverMCP サーバーとしてのルーティン use:mcp
Tools to list and inspect routines, read their runs, run one now (write:routines) and pause or resume one (manage:routines).
Requires the use:mcp scope (or admin).
ルーティンを一覧・確認し、実行を読み、今すぐ実行し(write:routines)、一時停止・再開する(manage:routines)ツールです。
use:mcp スコープ(または admin)が必要です。
operationId mcpForRoutines · #
パラメーター
Idempotency-Key | header | string (長さ ≥ 1, 長さ ≤ 255) # |
|---|
リクエストボディ
application/jsonobject
jsonrpc次のいずれか:"2.0"必須idstring または integermethodstring 必須paramsobject
レスポンス
200 成功しました。
application/jsonobject 任意のフィールドを含む
400リクエストを解釈できませんでした。401キーがない、形式が正しくない、または不明・失効・期限切れのキーです。403キーにスコープがないか、キーの持ち主にこの操作が許可されていません。404見つからないか、キーの持ち主からは見えません。409同じ Idempotency-Key のリクエストをまだ処理中です。Retry-After を参照してください。422この Idempotency-Key は別のリクエストで使われています。429このアドレスからのキーの失敗が多すぎます。Retry-After を参照してください。
application/jsonapplication/problem+jsonPOST /api/mcp/approvals Approvals as an MCP serverMCP サーバーとしての承認 use:mcp
Tools to list the approvals waiting for the owner and read one (read:approvals), and to approve or refuse one with the approval card's choices or answer a Bot's question (write:approvals). Each decision is audited under the key's name.
Requires the use:mcp scope (or admin).
キーの所有者を待っている承認を一覧して内容を読み(read:approvals)、承認カードと同じ選択肢で承認・拒否したり、Bot の質問に答えたりする(write:approvals)ツールです。判断はキーの名前で監査ログに残ります。
use:mcp スコープ(または admin)が必要です。
operationId mcpForApprovals · #
パラメーター
Idempotency-Key | header | string (長さ ≥ 1, 長さ ≤ 255) # |
|---|
リクエストボディ
application/jsonobject
jsonrpc次のいずれか:"2.0"必須idstring または integermethodstring 必須paramsobject
レスポンス
200 成功しました。
application/jsonobject 任意のフィールドを含む
400リクエストを解釈できませんでした。401キーがない、形式が正しくない、または不明・失効・期限切れのキーです。403キーにスコープがないか、キーの持ち主にこの操作が許可されていません。404見つからないか、キーの持ち主からは見えません。409同じ Idempotency-Key のリクエストをまだ処理中です。Retry-After を参照してください。422この Idempotency-Key は別のリクエストで使われています。429このアドレスからのキーの失敗が多すぎます。Retry-After を参照してください。
application/jsonapplication/problem+jsonAudit監査このセクションへのリンクをコピー
GET /api/audit/stream Pull the audit trail as NDJSON, oldest first, from a cursorカーソルから古い順に NDJSON で監査証跡を取得 read:audit
One redacted event per line, ordered by time then id. Keep the x-audit-next-cursor response header and send it back as after. Rows younger than ten seconds are held back so none is skipped.
Requires the read:audit scope (or admin). The key's owner must be an administrator.
1 行に 1 件、伏せ字処理したイベントを、時刻、次に id の順に返します。応答ヘッダー x-audit-next-cursor を保管し、after として送り返してください。10 秒より新しい行は、取りこぼしがないよう保留されます。
read:audit スコープ(または admin)が必要です。キーの所有者は管理者である必要があります。
operationId streamAuditEvents · #
パラメーター
after | query | string The x-audit-next-cursor of the previous page.前のページの x-audit-next-cursor です。 |
|---|---|---|
limit | query | integer (≥ 1, ≤ 1000) Rows per page, up to 1000.1 ページの行数で、最大 1000 です。 |
レスポンス
200 成功しました。
application/x-ndjsonstring
application/jsonobject
Tasksタスクこのセクションへのリンクをコピー
GET /api/me/tasks The owner's tasks, open ones first所有者のタスク(未完了が先) read:tasks
Requires the read:tasks scope (or admin).
read:tasks スコープ(または admin)が必要です。
operationId listTasks · #
パラメーター
done | query | 次のいずれか: "include"include lists done tasks too.include にすると、完了したタスクも一覧します。 |
|---|---|---|
projectId | query | string Only the tasks filed under this project.このプロジェクトに分類されたタスクだけです。 |
channelId | query | string Only the tasks linked to this conversation.この会話に関連付けられたタスクだけです。 |
limit | query | integer (≥ 1, ≤ 200) At most this many items, 1 to 200. The answer then carries nextCursor, null on the last page.最大件数で、1〜200 です。指定すると応答に nextCursor が含まれ、最後のページでは null になります。 |
cursor | query | string The nextCursor of the previous page.前のページの nextCursor です。 |
filter | query | string A condition the items must meet: a field (dots reach into objects), an operator ( = != > >= < <=, or ~ for contains) and a value, such as createdAt>=2026-10-01. Repeat for up to 10; all must hold.項目が満たすべき条件です。フィールド(ドットでオブジェクトの中を指定)、演算子(= != > >= < <=、または「含む」を表す ~)、値の順に createdAt>=2026-10-01 のように書きます。最大 10 個まで繰り返せ、すべてを満たす必要があります。 |
レスポンス
200 成功しました。
application/jsonobject
tasks配列: object配列: object
idstringtitlestringdueOnstring または nulldueTimestring または nullpriority次のいずれか:"low","normal","high"donebooleandoneAtstring または nullstage次のいずれか:"todo","doing","waiting"repeatstring または nullsourcestringprojectIdstring または nullwaitingOnstring または nullnudgeOnstring または nullcreatedAtstring (date-time)updatedAtstring (date-time)
nextCursorstring または null Only whenlimit,cursororfilterwas sent: the next page's cursor, or null.limit、cursor、filterのいずれかを送ったときだけ含まれる、次のページのカーソル、または null です。
POST /api/me/tasks Add a task to the owner's list所有者のリストにタスクを追加 write:tasks
Requires the write:tasks scope (or admin).
write:tasks スコープ(または admin)が必要です。
operationId createTask · #
パラメーター
Idempotency-Key | header | string (長さ ≥ 1, 長さ ≤ 255) # |
|---|
リクエストボディ
application/jsonobject
titlestring (長さ ≥ 1, 長さ ≤ 300) 必須dueOnstring または null (date) A calendar day, YYYY-MM-DD.日付で、YYYY-MM-DD 形式です。dueTimestring または null HH:MM on the due day, in the owner's time zone.期限日の時刻で、所有者のタイムゾーンの HH:MM 形式です。priority次のいずれか:"low","normal","high"stage次のいずれか:"todo","doing","waiting"repeat次のいずれか:"daily","weekdays","weekly","monthly","yearly",nullchecklist配列: object配列: object
idstringtextstring (長さ ≤ 200) 必須doneboolean
projectIdstring または null One of the owner's own projects.所有者自身のプロジェクトの 1 つです。waitingOnstring または null (長さ ≤ 120)nudgeOnstring または null (date) A calendar day, YYYY-MM-DD.日付で、YYYY-MM-DD 形式です。
レスポンス
201 成功しました。
application/jsonobject
taskobjectobject
idstringtitlestringdueOnstring または nulldueTimestring または nullpriority次のいずれか:"low","normal","high"donebooleandoneAtstring または nullstage次のいずれか:"todo","doing","waiting"repeatstring または nullsourcestringprojectIdstring または nullwaitingOnstring または nullnudgeOnstring または nullcreatedAtstring (date-time)updatedAtstring (date-time)
400リクエストを解釈できませんでした。401キーがない、形式が正しくない、または不明・失効・期限切れのキーです。403キーにスコープがないか、キーの持ち主にこの操作が許可されていません。404見つからないか、キーの持ち主からは見えません。409同じ Idempotency-Key のリクエストをまだ処理中です。Retry-After を参照してください。422この Idempotency-Key は別のリクエストで使われています。429このアドレスからのキーの失敗が多すぎます。Retry-After を参照してください。
application/jsonapplication/problem+jsonGET /api/me/tasks/export.csv Every task the owner keeps, as CSV所有者が持つすべてのタスクを CSV で read:tasks
Requires the read:tasks scope (or admin).
read:tasks スコープ(または admin)が必要です。
operationId exportTasks · #
レスポンス
200 成功しました。
text/csvstring
application/jsonobject
GET /api/me/tasks/{taskId}/history Who made a task, what changed and when it was ticked offタスクを作った人、変わった内容、完了した時刻 read:tasks
Requires the read:tasks scope (or admin).
read:tasks スコープ(または admin)が必要です。
operationId getTaskHistory · #
パラメーター
taskId | path 必須 | string The task's id.タスクの ID です。 |
|---|
レスポンス
200 成功しました。
application/jsonobject
events配列: object
PATCH /api/me/tasks/{taskId} Change a task, or tick it off with done: trueタスクを変更、または done: true で完了にする write:tasks
Requires the write:tasks scope (or admin).
write:tasks スコープ(または admin)が必要です。
operationId updateTask · #
パラメーター
taskId | path 必須 | string The task's id.タスクの ID です。 |
|---|---|---|
Idempotency-Key | header | string (長さ ≥ 1, 長さ ≤ 255) # |
リクエストボディ
application/jsonobject
titlestring (長さ ≥ 1, 長さ ≤ 300)dueOnstring または null (date) A calendar day, YYYY-MM-DD.日付で、YYYY-MM-DD 形式です。dueTimestring または null HH:MM on the due day, in the owner's time zone.期限日の時刻で、所有者のタイムゾーンの HH:MM 形式です。priority次のいずれか:"low","normal","high"stage次のいずれか:"todo","doing","waiting"repeat次のいずれか:"daily","weekdays","weekly","monthly","yearly",nullchecklist配列: object配列: object
idstringtextstring (長さ ≤ 200) 必須doneboolean
projectIdstring または null One of the owner's own projects.所有者自身のプロジェクトの 1 つです。waitingOnstring または null (長さ ≤ 120)nudgeOnstring または null (date) A calendar day, YYYY-MM-DD.日付で、YYYY-MM-DD 形式です。doneboolean
レスポンス
200 成功しました。
application/jsonobject
taskobjectobject
idstringtitlestringdueOnstring または nulldueTimestring または nullpriority次のいずれか:"low","normal","high"donebooleandoneAtstring または nullstage次のいずれか:"todo","doing","waiting"repeatstring または nullsourcestringprojectIdstring または nullwaitingOnstring または nullnudgeOnstring または nullcreatedAtstring (date-time)updatedAtstring (date-time)
400リクエストを解釈できませんでした。401キーがない、形式が正しくない、または不明・失効・期限切れのキーです。403キーにスコープがないか、キーの持ち主にこの操作が許可されていません。404見つからないか、キーの持ち主からは見えません。409同じ Idempotency-Key のリクエストをまだ処理中です。Retry-After を参照してください。422この Idempotency-Key は別のリクエストで使われています。429このアドレスからのキーの失敗が多すぎます。Retry-After を参照してください。
application/jsonapplication/problem+jsonDELETE /api/me/tasks/{taskId} Delete a taskタスクを削除 write:tasks
Requires the write:tasks scope (or admin).
write:tasks スコープ(または admin)が必要です。
operationId deleteTask · #
パラメーター
taskId | path 必須 | string The task's id.タスクの ID です。 |
|---|---|---|
Idempotency-Key | header | string (長さ ≥ 1, 長さ ≤ 255) # |
レスポンス
204 Done.完了しました。
400リクエストを解釈できませんでした。401キーがない、形式が正しくない、または不明・失効・期限切れのキーです。403キーにスコープがないか、キーの持ち主にこの操作が許可されていません。404見つからないか、キーの持ち主からは見えません。409同じ Idempotency-Key のリクエストをまだ処理中です。Retry-After を参照してください。422この Idempotency-Key は別のリクエストで使われています。429このアドレスからのキーの失敗が多すぎます。Retry-After を参照してください。
application/jsonapplication/problem+jsonSkillsスキルこのセクションへのリンクをコピー
GET /api/plugins/skills The deployment's skills and the owner's ownデプロイのスキルと所有者自身のスキル manage:skills
Requires the manage:skills scope (or admin).
manage:skills スコープ(または admin)が必要です。
operationId listSkills · #
パラメーター
limit | query | integer (≥ 1, ≤ 200) At most this many items, 1 to 200. The answer then carries nextCursor, null on the last page.最大件数で、1〜200 です。指定すると応答に nextCursor が含まれ、最後のページでは null になります。 |
|---|---|---|
cursor | query | string The nextCursor of the previous page.前のページの nextCursor です。 |
filter | query | string A condition the items must meet: a field (dots reach into objects), an operator ( = != > >= < <=, or ~ for contains) and a value, such as createdAt>=2026-10-01. Repeat for up to 10; all must hold.項目が満たすべき条件です。フィールド(ドットでオブジェクトの中を指定)、演算子(= != > >= < <=、または「含む」を表す ~)、値の順に createdAt>=2026-10-01 のように書きます。最大 10 個まで繰り返せ、すべてを満たす必要があります。 |
レスポンス
200 成功しました。
application/jsonobject
skills配列: objectnextCursorstring または null Only whenlimit,cursororfilterwas sent: the next page's cursor, or null.limit、cursor、filterのいずれかを送ったときだけ含まれる、次のページのカーソル、または null です。
POST /api/plugins/skills Write a skill, or a new version of oneスキル、またはその新しい版を書く manage:skills
Saving a slug that exists saves a new version of it, if the owner may change it. global (administrators only) writes one for the whole deployment.
Requires the manage:skills scope (or admin).
既にある slug を保存すると、所有者が変更できる場合はその新しい版として保存されます。global(管理者のみ)はデプロイ全体のスキルを書きます。
manage:skills スコープ(または admin)が必要です。
operationId saveSkill · #
パラメーター
Idempotency-Key | header | string (長さ ≥ 1, 長さ ≤ 255) # |
|---|
リクエストボディ
application/jsonobject
slugstring 必須titlestring (長さ ≥ 1, 長さ ≤ 120) 必須summarystring (長さ ≤ 200)instructionsstring (長さ ≥ 1) 必須tools配列: string The tools the skill needs, by reference.スキルが必要とするツールで、参照で指定します。globalbooleannotestring (長さ ≤ 500)
レスポンス
200 成功しました。
application/jsonobject
skills配列: objectversioninteger
400リクエストを解釈できませんでした。401キーがない、形式が正しくない、または不明・失効・期限切れのキーです。403キーにスコープがないか、キーの持ち主にこの操作が許可されていません。404見つからないか、キーの持ち主からは見えません。409同じ Idempotency-Key のリクエストをまだ処理中です。Retry-After を参照してください。422この Idempotency-Key は別のリクエストで使われています。429このアドレスからのキーの失敗が多すぎます。Retry-After を参照してください。
application/jsonapplication/problem+jsonDELETE /api/plugins/skills/{slug} Delete a skillスキルを削除 manage:skills
Requires the manage:skills scope (or admin).
manage:skills スコープ(または admin)が必要です。
operationId deleteSkill · #
パラメーター
slug | path 必須 | string The skill's slug.スキルのスラッグです。 |
|---|---|---|
Idempotency-Key | header | string (長さ ≥ 1, 長さ ≤ 255) # |
レスポンス
200 成功しました。
application/jsonobject
okboolean
400リクエストを解釈できませんでした。401キーがない、形式が正しくない、または不明・失効・期限切れのキーです。403キーにスコープがないか、キーの持ち主にこの操作が許可されていません。404見つからないか、キーの持ち主からは見えません。409同じ Idempotency-Key のリクエストをまだ処理中です。Retry-After を参照してください。422この Idempotency-Key は別のリクエストで使われています。429このアドレスからのキーの失敗が多すぎます。Retry-After を参照してください。
application/jsonapplication/problem+jsonGET /api/plugins/for/{agentId} What one Bot has been given: skills, tools and other Bots1 つの Bot に与えられたもの:スキル、ツール、ほかの Bot manage:skills
Requires the manage:skills scope (or admin).
manage:skills スコープ(または admin)が必要です。
operationId listBotGrants · #
パラメーター
agentId | path 必須 | string The Bot's id.Bot の ID です。 |
|---|
レスポンス
200 成功しました。
application/jsonobject 任意のフィールドを含む
POST /api/plugins/grants Give a skill to a BotBot にスキルを与える manage:skills
Requires the manage:skills scope (or admin).
manage:skills スコープ(または admin)が必要です。
operationId grantSkill · #
パラメーター
Idempotency-Key | header | string (長さ ≥ 1, 長さ ≤ 255) # |
|---|
リクエストボディ
application/jsonobject
kind任意 必須 A key with onlymanage:skillsgrants skills. Tools are an administrator's to give.manage:skillsだけを持つキーはスキルを付与します。ツールを与えるのは管理者です。refstring 必須 The skill's slug.スキルのスラッグです。agentIdstring 必須
レスポンス
200 成功しました。
application/jsonobject
okboolean
400リクエストを解釈できませんでした。401キーがない、形式が正しくない、または不明・失効・期限切れのキーです。403キーにスコープがないか、キーの持ち主にこの操作が許可されていません。404見つからないか、キーの持ち主からは見えません。409同じ Idempotency-Key のリクエストをまだ処理中です。Retry-After を参照してください。422この Idempotency-Key は別のリクエストで使われています。429このアドレスからのキーの失敗が多すぎます。Retry-After を参照してください。
application/jsonapplication/problem+jsonDELETE /api/plugins/grants Take a skill from a BotBot からスキルを外す manage:skills
Requires the manage:skills scope (or admin).
manage:skills スコープ(または admin)が必要です。
operationId revokeSkill · #
パラメーター
kind | query 必須 | 任意skill.skill です。 |
|---|---|---|
ref | query 必須 | string The skill's slug.スキルのスラッグです。 |
agentId | query 必須 | string The Bot's id.Bot の ID です。 |
Idempotency-Key | header | string (長さ ≥ 1, 長さ ≤ 255) # |
レスポンス
200 成功しました。
application/jsonobject
okboolean
400リクエストを解釈できませんでした。401キーがない、形式が正しくない、または不明・失効・期限切れのキーです。403キーにスコープがないか、キーの持ち主にこの操作が許可されていません。404見つからないか、キーの持ち主からは見えません。409同じ Idempotency-Key のリクエストをまだ処理中です。Retry-After を参照してください。422この Idempotency-Key は別のリクエストで使われています。429このアドレスからのキーの失敗が多すぎます。Retry-After を参照してください。
application/jsonapplication/problem+jsonFilesファイルこのセクションへのリンクをコピー
POST /api/computers/{botId}/files/list List a folder in a Bot's workspaceBot のワークスペースのフォルダーを一覧にする read:files
Also answers uploadMaxBytes, the largest upload this deployment takes. Every file action is decided by the deployment's computer policy and recorded on the audit trail, as in the app.
Requires the read:files scope (or admin).
このデプロイが受け付ける最大のアップロードである uploadMaxBytes も返します。ファイルの操作はすべて、アプリと同じようにデプロイのコンピューターポリシーで判断され、監査証跡に記録されます。
read:files スコープ(または admin)が必要です。
operationId listFiles · #
パラメーター
botId | path 必須 | string The Bot whose workspace it is.ワークスペースを持つ Bot です。 |
|---|---|---|
Idempotency-Key | header | string (長さ ≥ 1, 長さ ≤ 255) # |
リクエストボディ
application/jsonobject
pathstring The folder; absent: the top.フォルダーです。省略すると最上位です。
レスポンス
200 成功しました。
application/jsonobject 任意のフィールドを含む
400リクエストを解釈できませんでした。401キーがない、形式が正しくない、または不明・失効・期限切れのキーです。403キーにスコープがないか、キーの持ち主にこの操作が許可されていません。404見つからないか、キーの持ち主からは見えません。409同じ Idempotency-Key のリクエストをまだ処理中です。Retry-After を参照してください。422この Idempotency-Key は別のリクエストで使われています。429このアドレスからのキーの失敗が多すぎます。Retry-After を参照してください。
application/jsonapplication/problem+jsonPOST /api/computers/{botId}/files/read Read a text fileテキストファイルを読む read:files
Requires the read:files scope (or admin).
read:files スコープ(または admin)が必要です。
operationId readFile · #
パラメーター
botId | path 必須 | string The Bot whose workspace it is.ワークスペースを持つ Bot です。 |
|---|---|---|
Idempotency-Key | header | string (長さ ≥ 1, 長さ ≤ 255) # |
リクエストボディ
application/jsonobject
pathstring (長さ ≥ 1, 長さ ≤ 1024) 必須
レスポンス
200 成功しました。
application/jsonobject 任意のフィールドを含む
400リクエストを解釈できませんでした。401キーがない、形式が正しくない、または不明・失効・期限切れのキーです。403キーにスコープがないか、キーの持ち主にこの操作が許可されていません。404見つからないか、キーの持ち主からは見えません。409同じ Idempotency-Key のリクエストをまだ処理中です。Retry-After を参照してください。422この Idempotency-Key は別のリクエストで使われています。429このアドレスからのキーの失敗が多すぎます。Retry-After を参照してください。
application/jsonapplication/problem+jsonPOST /api/computers/{botId}/files/search Find files by name pattern or by text inside them名前のパターンや中身のテキストでファイルを探す read:files
Requires the read:files scope (or admin).
read:files スコープ(または admin)が必要です。
operationId searchFiles · #
パラメーター
botId | path 必須 | string The Bot whose workspace it is.ワークスペースを持つ Bot です。 |
|---|---|---|
Idempotency-Key | header | string (長さ ≥ 1, 長さ ≤ 255) # |
リクエストボディ
application/jsonobject
namestringtextstring
レスポンス
200 成功しました。
application/jsonobject 任意のフィールドを含む
400リクエストを解釈できませんでした。401キーがない、形式が正しくない、または不明・失効・期限切れのキーです。403キーにスコープがないか、キーの持ち主にこの操作が許可されていません。404見つからないか、キーの持ち主からは見えません。409同じ Idempotency-Key のリクエストをまだ処理中です。Retry-After を参照してください。422この Idempotency-Key は別のリクエストで使われています。429このアドレスからのキーの失敗が多すぎます。Retry-After を参照してください。
application/jsonapplication/problem+jsonGET /api/computers/{botId}/files/download Download a file as it isファイルをそのままダウンロード read:files
Requires the read:files scope (or admin).
read:files スコープ(または admin)が必要です。
operationId downloadFile · #
パラメーター
botId | path 必須 | string The Bot whose workspace it is.ワークスペースを持つ Bot です。 |
|---|---|---|
path | query 必須 | string (長さ ≥ 1, 長さ ≤ 1024) The file's path in the workspace.ワークスペース内のファイルのパスです。 |
レスポンス
200 成功しました。
application/octet-streamstring
application/jsonobject
POST /api/computers/{botId}/files/upload Upload a file, its bytes as the bodyファイルをアップロード(本文にバイト列) write:files
Never overwrites: a path already taken answers 409 with exists. Bodies over uploadMaxBytes are refused with 413.
Requires the write:files scope (or admin).
上書きはしません。既に使われているパスには 409 と exists が返ります。uploadMaxBytes を超える本文は 413 で拒否されます。
write:files スコープ(または admin)が必要です。
operationId uploadFile · #
パラメーター
botId | path 必須 | string The Bot whose workspace it is.ワークスペースを持つ Bot です。 |
|---|---|---|
path | query 必須 | string (長さ ≥ 1, 長さ ≤ 1024) Where to put it in the workspace.ワークスペース内の置き場所です。 |
Idempotency-Key | header | string (長さ ≥ 1, 長さ ≤ 255) # |
リクエストボディ
application/octet-streamstring (binary)
レスポンス
200 成功しました。
application/jsonobject 任意のフィールドを含む
400リクエストを解釈できませんでした。401キーがない、形式が正しくない、または不明・失効・期限切れのキーです。403キーにスコープがないか、キーの持ち主にこの操作が許可されていません。404見つからないか、キーの持ち主からは見えません。409同じ Idempotency-Key のリクエストをまだ処理中です。Retry-After を参照してください。422この Idempotency-Key は別のリクエストで使われています。429このアドレスからのキーの失敗が多すぎます。Retry-After を参照してください。
application/jsonapplication/problem+jsonPOST /api/computers/{botId}/files/write Write a text file, or add to the end of oneテキストファイルを書く、または末尾に追加する write:files
Requires the write:files scope (or admin).
write:files スコープ(または admin)が必要です。
operationId writeFile · #
パラメーター
botId | path 必須 | string The Bot whose workspace it is.ワークスペースを持つ Bot です。 |
|---|---|---|
Idempotency-Key | header | string (長さ ≥ 1, 長さ ≤ 255) # |
リクエストボディ
application/jsonobject
pathstring (長さ ≥ 1, 長さ ≤ 1024) 必須contentsstring 必須appendboolean
レスポンス
200 成功しました。
application/jsonobject 任意のフィールドを含む
400リクエストを解釈できませんでした。401キーがない、形式が正しくない、または不明・失効・期限切れのキーです。403キーにスコープがないか、キーの持ち主にこの操作が許可されていません。404見つからないか、キーの持ち主からは見えません。409同じ Idempotency-Key のリクエストをまだ処理中です。Retry-After を参照してください。422この Idempotency-Key は別のリクエストで使われています。429このアドレスからのキーの失敗が多すぎます。Retry-After を参照してください。
application/jsonapplication/problem+jsonPOST /api/computers/{botId}/files/mkdir Make a folderフォルダーを作る write:files
Requires the write:files scope (or admin).
write:files スコープ(または admin)が必要です。
operationId makeFolder · #
パラメーター
botId | path 必須 | string The Bot whose workspace it is.ワークスペースを持つ Bot です。 |
|---|---|---|
Idempotency-Key | header | string (長さ ≥ 1, 長さ ≤ 255) # |
リクエストボディ
application/jsonobject
pathstring (長さ ≥ 1, 長さ ≤ 1024) 必須
レスポンス
200 成功しました。
application/jsonobject 任意のフィールドを含む
400リクエストを解釈できませんでした。401キーがない、形式が正しくない、または不明・失効・期限切れのキーです。403キーにスコープがないか、キーの持ち主にこの操作が許可されていません。404見つからないか、キーの持ち主からは見えません。409同じ Idempotency-Key のリクエストをまだ処理中です。Retry-After を参照してください。422この Idempotency-Key は別のリクエストで使われています。429このアドレスからのキーの失敗が多すぎます。Retry-After を参照してください。
application/jsonapplication/problem+jsonPOST /api/computers/{botId}/files/move Move or rename a file or folderファイルやフォルダーを移動または名前変更 write:files
Requires the write:files scope (or admin).
write:files スコープ(または admin)が必要です。
operationId moveFile · #
パラメーター
botId | path 必須 | string The Bot whose workspace it is.ワークスペースを持つ Bot です。 |
|---|---|---|
Idempotency-Key | header | string (長さ ≥ 1, 長さ ≤ 255) # |
リクエストボディ
application/jsonobject
fromstring (長さ ≥ 1, 長さ ≤ 1024) 必須tostring (長さ ≥ 1, 長さ ≤ 1024) 必須
レスポンス
200 成功しました。
application/jsonobject 任意のフィールドを含む
400リクエストを解釈できませんでした。401キーがない、形式が正しくない、または不明・失効・期限切れのキーです。403キーにスコープがないか、キーの持ち主にこの操作が許可されていません。404見つからないか、キーの持ち主からは見えません。409同じ Idempotency-Key のリクエストをまだ処理中です。Retry-After を参照してください。422この Idempotency-Key は別のリクエストで使われています。429このアドレスからのキーの失敗が多すぎます。Retry-After を参照してください。
application/jsonapplication/problem+jsonPOST /api/computers/{botId}/files/delete Delete a file or folderファイルやフォルダーを削除 write:files
It goes to the workspace's trash, where the app can put it back.
Requires the write:files scope (or admin).
ワークスペースのゴミ箱に移り、アプリから元に戻せます。
write:files スコープ(または admin)が必要です。
operationId deleteFile · #
パラメーター
botId | path 必須 | string The Bot whose workspace it is.ワークスペースを持つ Bot です。 |
|---|---|---|
Idempotency-Key | header | string (長さ ≥ 1, 長さ ≤ 255) # |
リクエストボディ
application/jsonobject
pathstring (長さ ≥ 1, 長さ ≤ 1024) 必須
レスポンス
200 成功しました。
application/jsonobject 任意のフィールドを含む
400リクエストを解釈できませんでした。401キーがない、形式が正しくない、または不明・失効・期限切れのキーです。403キーにスコープがないか、キーの持ち主にこの操作が許可されていません。404見つからないか、キーの持ち主からは見えません。409同じ Idempotency-Key のリクエストをまだ処理中です。Retry-After を参照してください。422この Idempotency-Key は別のリクエストで使われています。429このアドレスからのキーの失敗が多すぎます。Retry-After を参照してください。
application/jsonapplication/problem+jsonSigned links署名付きリンクこのセクションへのリンクをコピー
POST /api/links Make a short-lived link that carries out one request as this keyこのキーとして 1 件のリクエストを行う、短時間有効なリンクを作る write:links
A download (exportTasks, exportAuditEvents, downloadFile; up to an hour) or an approval decision (decideApproval with its body; up to a week) the key could make itself. Using the link needs no key; each use is checked as the key. GET on a decision link describes it; POST carries it out, once.
Requires the write:links scope (or admin).
キー自身が行えるダウンロード(exportTasks、exportAuditEvents、downloadFile。最長 1 時間)または承認の判断(本文付きの decideApproval。最長 1 週間)です。リンクを使うのにキーは不要で、使うたびにキーとして確認されます。判断のリンクに GET するとその内容を説明し、POST すると 1 回だけ実行します。
write:links スコープ(または admin)が必要です。
operationId createSignedLink · #
パラメーター
Idempotency-Key | header | string (長さ ≥ 1, 長さ ≤ 255) # |
|---|
リクエストボディ
application/jsonobject
method次のいずれか:"GET","POST"pathstring 必須bodyobjectexpiresInSecondsinteger (≥ 60, ≤ 604800) 900 when omitted.省略すると 900 です。
レスポンス
201 成功しました。
application/jsonobject
linkobject 必須object
urlstring 必須pathstring 必須method次のいずれか:"GET","POST"必須operationstring 必須expiresAtstring (date-time) 必須
400リクエストを解釈できませんでした。401キーがない、形式が正しくない、または不明・失効・期限切れのキーです。403キーにスコープがないか、キーの持ち主にこの操作が許可されていません。404見つからないか、キーの持ち主からは見えません。409同じ Idempotency-Key のリクエストをまだ処理中です。Retry-After を参照してください。422この Idempotency-Key は別のリクエストで使われています。429このアドレスからのキーの失敗が多すぎます。Retry-After を参照してください。
application/jsonapplication/problem+jsonShort-lived tokens短時間有効なトークンこのセクションへのリンクをコピー
POST /api/tokens Exchange this key for a token that works for a few minutesこのキーを数分間使えるトークンに交換 write:tokens
The token acts as this key, narrowed to scopes (every scope of the key when omitted), for minutes (1 to 60, 15 when omitted, never past the key's own expiry). It stops at once when the key is revoked, turned off or expires, and it cannot make another token or a signed link. Send it as Authorization: Bearer <token>.
Requires the write:tokens scope (or admin).
トークンはこのキーとして動き、scopes(省略するとキーのすべてのスコープ)に絞られ、minutes(1〜60、省略すると 15、キー自身の有効期限は超えません)の間有効です。キーが失効、無効化、期限切れになるとすぐに止まり、別のトークンや署名付きリンクは作れません。Authorization: Bearer <token> として送ってください。
write:tokens スコープ(または admin)が必要です。
operationId createShortLivedToken · #
パラメーター
Idempotency-Key | header | string (長さ ≥ 1, 長さ ≤ 255) # |
|---|
リクエストボディ
application/jsonobject
minutesinteger (≥ 1, ≤ 60)scopes配列: string Some or all of this key's own scopes.このキー自身のスコープの一部またはすべてです。
レスポンス
201 成功しました。
application/jsonobject
tokenstring 必須tokenType次のいずれか:"Bearer"必須scopes配列: string 必須expiresAtstring (date-time) 必須expiresIninteger (≥ 0) 必須
400リクエストを解釈できませんでした。401キーがない、形式が正しくない、または不明・失効・期限切れのキーです。403キーにスコープがないか、キーの持ち主にこの操作が許可されていません。404見つからないか、キーの持ち主からは見えません。409同じ Idempotency-Key のリクエストをまだ処理中です。Retry-After を参照してください。422この Idempotency-Key は別のリクエストで使われています。429このアドレスからのキーの失敗が多すぎます。Retry-After を参照してください。
application/jsonapplication/problem+jsonBoundaries境界このセクションへのリンクをコピー
GET /api/computers/policy The boundary in force, and rules that can never match有効な境界と、決して一致しないルール manage:boundaries
Requires the manage:boundaries scope (or admin). The key's owner must be an administrator.
manage:boundaries スコープ(または admin)が必要です。キーの所有者は管理者である必要があります。
operationId getBoundaryPolicy · #
レスポンス
200 成功しました。
application/jsonobject
policyobject 必須findings配列: 任意
PUT /api/computers/policy Propose a new boundary, for another administrator to approve新しい境界を提案し、別の管理者の承認を待つ manage:boundaries
Checked as a save in the app is, with a reason for each new or changed rule in meta. It waits as a pending change until a different administrator approves it in the app.
Requires the manage:boundaries scope (or admin). The key's owner must be an administrator.
アプリで保存するときと同じように確認され、新しいルールや変更したルールごとの理由を meta に入れます。別の管理者がアプリで承認するまで、保留中の変更として待ちます。
manage:boundaries スコープ(または admin)が必要です。キーの所有者は管理者である必要があります。
operationId proposeBoundaryPolicy · #
パラメーター
Idempotency-Key | header | string (長さ ≥ 1, 長さ ≤ 255) # |
|---|
リクエストボディ
application/jsonobject
mode次のいずれか:"enforce","dry-run"必須deny配列: string 必須allow配列: string 必須ask配列: stringmetaobjectnotestring (長さ ≤ 500)
レスポンス
202 成功しました。
application/jsonobject
pendingobject 必須
400リクエストを解釈できませんでした。401キーがない、形式が正しくない、または不明・失効・期限切れのキーです。403キーにスコープがないか、キーの持ち主にこの操作が許可されていません。404見つからないか、キーの持ち主からは見えません。409同じ Idempotency-Key のリクエストをまだ処理中です。Retry-After を参照してください。422この Idempotency-Key は別のリクエストで使われています。429このアドレスからのキーの失敗が多すぎます。Retry-After を参照してください。
application/jsonapplication/problem+jsonPOST /api/computers/policy-validate Check one rule, and where it stops being valid1 つのルールと、それが有効でなくなる箇所を確認 manage:boundaries
Requires the manage:boundaries scope (or admin). The key's owner must be an administrator.
manage:boundaries スコープ(または admin)が必要です。キーの所有者は管理者である必要があります。
operationId validateBoundaryRule · #
パラメーター
Idempotency-Key | header | string (長さ ≥ 1, 長さ ≤ 255) # |
|---|
リクエストボディ
application/jsonobject
rulestring 必須
レスポンス
200 成功しました。
application/jsonobject 任意のフィールドを含む
400リクエストを解釈できませんでした。401キーがない、形式が正しくない、または不明・失効・期限切れのキーです。403キーにスコープがないか、キーの持ち主にこの操作が許可されていません。404見つからないか、キーの持ち主からは見えません。409同じ Idempotency-Key のリクエストをまだ処理中です。Retry-After を参照してください。422この Idempotency-Key は別のリクエストで使われています。429このアドレスからのキーの失敗が多すぎます。Retry-After を参照してください。
application/jsonapplication/problem+jsonPOST /api/computers/policy-dry-run What a draft boundary would have decided for recent actions下書きの境界が最近の操作に対してどう判断したか manage:boundaries
Requires the manage:boundaries scope (or admin). The key's owner must be an administrator.
manage:boundaries スコープ(または admin)が必要です。キーの所有者は管理者である必要があります。
operationId dryRunBoundaryPolicy · #
パラメーター
Idempotency-Key | header | string (長さ ≥ 1, 長さ ≤ 255) # |
|---|
リクエストボディ
application/jsonobject
policyobject 必須object
mode次のいずれか:"enforce","dry-run"必須deny配列: string 必須allow配列: string 必須ask配列: string
limitinteger (≥ 1, ≤ 500)
レスポンス
200 成功しました。
application/jsonobject
reportobject 必須
400リクエストを解釈できませんでした。401キーがない、形式が正しくない、または不明・失効・期限切れのキーです。403キーにスコープがないか、キーの持ち主にこの操作が許可されていません。404見つからないか、キーの持ち主からは見えません。409同じ Idempotency-Key のリクエストをまだ処理中です。Retry-After を参照してください。422この Idempotency-Key は別のリクエストで使われています。429このアドレスからのキーの失敗が多すぎます。Retry-After を参照してください。
application/jsonapplication/problem+jsonGET /api/computers/policy-changes Proposed boundary changes and what became of them提案された境界の変更とその結果 manage:boundaries
Requires the manage:boundaries scope (or admin). The key's owner must be an administrator.
manage:boundaries スコープ(または admin)が必要です。キーの所有者は管理者である必要があります。
operationId listBoundaryChanges · #
レスポンス
200 成功しました。
application/jsonobject 任意のフィールドを含む
Batchバッチこのセクションへのリンクをコピー
POST /api/batch Send up to 100 requests in one call, each answered on its own1 回の呼び出しで最大 100 件のリクエストを送り、それぞれに応答 read:profile
Each request is sent as if alone, with this key: its own scope, Bot limit, rate limit and idempotency key apply, and one that is refused does not stop the rest unless stopOnError is set. Results come back in order. With async: true the call answers 202 with an operation to poll at /api/operations/{id}. A batch cannot hold another batch or a live event socket.
Requires the read:profile scope (or admin).
各リクエストはこのキーで単独に送ったときと同じように扱われ、それぞれのスコープ、Bot の制限、レート制限、冪等キーが適用されます。stopOnError を指定しない限り、拒否されたものがあっても残りは止まりません。結果は順番どおりに返ります。async: true では 202 が返り、/api/operations/{id} で確認できる操作が作られます。バッチの中に別のバッチやライブイベントのソケットは入れられません。
read:profile スコープ(または admin)が必要です。
operationId runBatch · #
パラメーター
Idempotency-Key | header | string (長さ ≥ 1, 長さ ≤ 255) # |
|---|
リクエストボディ
application/jsonobject
requests配列: object 必須配列: object
idstring Your own name for the request, returned with its result.リクエストに付けるあなた独自の名前で、結果と一緒に返ります。method次のいずれか:"GET","POST","PUT","PATCH","DELETE"必須pathstring 必須body任意idempotencyKeystring (長さ ≤ 200)
stopOnErrorbooleanasyncboolean
レスポンス
200 成功しました。
application/jsonobject
results配列: object 必須配列: object
indexinteger 必須idstring または null 必須methodstring 必須pathstring 必須statusinteger 必須headersobject 必須body任意 必須truncatedboolean
succeededinteger 必須failedinteger 必須skippedinteger 必須
400リクエストを解釈できませんでした。401キーがない、形式が正しくない、または不明・失効・期限切れのキーです。403キーにスコープがないか、キーの持ち主にこの操作が許可されていません。404見つからないか、キーの持ち主からは見えません。409同じ Idempotency-Key のリクエストをまだ処理中です。Retry-After を参照してください。422この Idempotency-Key は別のリクエストで使われています。429このアドレスからのキーの失敗が多すぎます。Retry-After を参照してください。
application/jsonapplication/problem+jsonGET /api/operations The background operations this person started, newest firstこの人が始めたバックグラウンドの操作(新しい順) read:profile
Requires the read:profile scope (or admin).
read:profile スコープ(または admin)が必要です。
operationId listOperations · #
パラメーター
limit | query | integer (≥ 1, ≤ 100) At most this many (1 to 100, 25 when omitted).最大件数です(1〜100、省略すると 25)。 |
|---|---|---|
cursor | query | string The nextCursor of the page before.前のページの nextCursor です。 |
レスポンス
200 成功しました。
application/jsonobject
operations配列: object 必須配列: object
idstring 必須kind次のいずれか:"batch"必須status次のいずれか:"running","succeeded","failed","interrupted"必須totalinteger 必須doneinteger 必須failedinteger 必須errorstring または null 必須createdAtstring (date-time) 必須updatedAtstring (date-time) 必須finishedAtstring または null (date-time) 必須
nextCursorstring または null 必須
GET /api/operations/{id} One background operation: how far it is, and each result so far1 つのバックグラウンド操作:進み具合とここまでの各結果 read:profile
Requires the read:profile scope (or admin).
read:profile スコープ(または admin)が必要です。
operationId getOperation · #
パラメーター
id | path 必須 | string The operation's id.操作の ID です。 |
|---|
レスポンス
200 成功しました。
application/jsonobject
operationobject 必須object
idstring 必須kind次のいずれか:"batch"必須status次のいずれか:"running","succeeded","failed","interrupted"必須totalinteger 必須doneinteger 必須failedinteger 必須errorstring または null 必須createdAtstring (date-time) 必須updatedAtstring (date-time) 必須finishedAtstring または null (date-time) 必須results配列: object 必須配列: object
indexinteger 必須idstring または null 必須methodstring 必須pathstring 必須statusinteger 必須headersobject 必須body任意 必須truncatedboolean
スキーマこのセクションへのリンクをコピー
Error
object
errorstring 必須
Problem
object
typestring 必須titlestring 必須statusinteger 必須detailstring 必須instancestringrequestIdstringerrorstring
最終更新日