API reference
Agents
Agent definitions, runs (AgentRun) and embedded chat conversations.
Generated from the public API contract (OpenAPI). Descriptions in the contract are written in Japanese.
Endpoints
Section titled “Endpoints”listAgentConversations
Section titled “listAgentConversations”GET/v1/agents/conversations
agents:read が必要。自分が作った会話を新しい順に返す
Parameters
Section titled “Parameters”| Name | In | Type | Required | Description |
|---|---|---|---|---|
agent |
query | string | ||
limit |
query | integer |
Responses
Section titled “Responses”- 200 —
object: 会話の一覧 - default —
Problem: RFC 9457 Problem Details
createAgentConversation
Section titled “createAgentConversation”POST/v1/agents/conversations
agents:run が必要。自分だけが読める会話を作る。会話のメッセージは、有効なバージョンのチャットの Agent(default: true)が受ける。 title を指定しなければ、最初のメッセージの 1 行目(40 文字まで)を題名にする
Parameters
Section titled “Parameters”| Name | In | Type | Required | Description |
|---|---|---|---|---|
Idempotency-Key |
header | string | 副作用を伴う POST ではサーバーが必須にする。SDK は無ければ自動で付けるので、型では省略できる |
Request body
Section titled “Request body”application/json
| Name | Type | Required | Description |
|---|---|---|---|
title |
string |
Responses
Section titled “Responses”- 201 —
Conversation: 作った会話 - default —
Problem: RFC 9457 Problem Details
getAgentConversation
Section titled “getAgentConversation”GET/v1/agents/conversations/{id}
agents:read が必要。自分が作った会話を返す
Parameters
Section titled “Parameters”| Name | In | Type | Required | Description |
|---|---|---|---|---|
id |
path | string | yes |
Responses
Section titled “Responses”- 200 —
Conversation: 会話 - default —
Problem: RFC 9457 Problem Details
listAgentConversationMessages
Section titled “listAgentConversationMessages”GET/v1/agents/conversations/{id}/messages
agents:read が必要。自分の会話のメッセージを古い順に返す
Parameters
Section titled “Parameters”| Name | In | Type | Required | Description |
|---|---|---|---|---|
id |
path | string | yes | |
limit |
query | integer |
Responses
Section titled “Responses”- 200 —
object: メッセージの一覧 - default —
Problem: RFC 9457 Problem Details
sendAgentConversationMessage
Section titled “sendAgentConversationMessage”POST/v1/agents/conversations/{id}/messages
agents:run が必要。自然文のメッセージを保存し、同じトランザクションでチャットの Agent(default: true)の AgentRun を始める。 チャットの Agent は、必要なときに業務の Agent を agents.run で呼んで結果を受け取り、答えを返事にする。 同じ会話と client_message_id の組では一度だけ受け付ける。返事が終わるまで、次のメッセージは CONFLICT にする。 チャットの返事を外への操作の承認には使わない。 agent を指定すると、チャットの Agent はこのメッセージではその Agent だけを呼べる。 チャットの Agent がないか、チャットの Agent が呼べない Agent を指定したら VALIDATION_FAILED を返し、何も保存しない
Parameters
Section titled “Parameters”| Name | In | Type | Required | Description |
|---|---|---|---|---|
id |
path | string | yes | |
Idempotency-Key |
header | string | 副作用を伴う POST ではサーバーが必須にする。SDK は無ければ自動で付けるので、型では省略できる |
Request body
Section titled “Request body”application/json
| Name | Type | Required | Description |
|---|---|---|---|
content |
string | yes | |
client_message_id |
string | yes | |
agent |
string | 利用者が指定する業務の Agent。チャットの Agent は、このメッセージではこの Agent だけを呼べる | |
attachments |
object[] | 添付する文書。先にアップロードし、自分が読める文書だけを付けられる。 チャットの Agent の文書の入力(format: document)には、会話に添付した文書をすべて渡す |
Responses
Section titled “Responses”- 202 —
ChatMessage: チャットの Agent の答えを待つメッセージ(run_id はチャットの Agent の実行) - default —
Problem: RFC 9457 Problem Details
streamAgentConversationEvents
Section titled “streamAgentConversationEvents”GET/v1/agents/conversations/{id}/events
agents:read が必要。自分が作った会話の現在状態と進行記録を SSE で配信する。 event: snapshot の data は ConversationSnapshot。最初に現在状態を返し、その後は実際の変更があるときに配信する。 activities は Last-Event-ID より後の進行記録で、再接続の際にも同じ sequence を二重に追加しない。 Last-Event-ID が現在の cursor より大きい場合は、進行記録を先頭から返す。 15 秒ごとにコメントの heartbeat を送り、45 秒以内に接続を閉じて再接続時に認証と閲覧権限を確かめる。 event: failure の data は ConversationStreamFailure で、接続中の拒否を知らせて接続を閉じる。 推論の内部過程、資格情報、モデル内部の JSON は配信しない
Parameters
Section titled “Parameters”| Name | In | Type | Required | Description |
|---|---|---|---|---|
id |
path | string | yes | |
Last-Event-ID |
header | string | 最後に受け取った SSE の id。0 以上かつ 9007199254740991 以下の十進整数の文字列 |
Responses
Section titled “Responses”- 200 —
string: text/event-stream の配信。snapshot の id は data.cursor。 conversation・items・turns はその時点の現在状態で、activities は最後の cursor より後の記録 - default —
Problem: RFC 9457 Problem Details
getAgentConversationMemory
Section titled “getAgentConversationMemory”GET/v1/agents/conversations/{conversation_id}/memory
agents:read と会話の作成者であることが必要。資格情報の組織・環境・プロジェクトの範囲で取得する。 現在の Agent に連続して頼んでいる会話のメッセージと、その区間に結び付いたすべての実行を省略せず返す。 実行後も会話を続けるが、別の Agent へ切り替えた境界は越えない。 RunToken・API キー・TenantContext・CLI のセッションファイルは含めない
Parameters
Section titled “Parameters”| Name | In | Type | Required | Description |
|---|---|---|---|---|
conversation_id |
path | string | yes |
Responses
Section titled “Responses”- 200 —
AgentMemorySnapshot: 現在の Agent に対する会話と実行のコンテキスト - default —
Problem: RFC 9457 Problem Details
archiveAgentConversationMemory
Section titled “archiveAgentConversationMemory”POST/v1/agents/conversations/{conversation_id}/memory
agents:read・agents:run と会話の作成者であることが必要。本文は送らず、Idempotency-Key が必要。 現在のコンテキストを、組織・環境・プロジェクト・作成者・会話と内容の digest に結び付けたキーで ObjectStore に保存する。 保存した内容は上書きせず、保存先の key と digest を返す。実行の復元や操作の再実行は行わない
Parameters
Section titled “Parameters”| Name | In | Type | Required | Description |
|---|---|---|---|---|
conversation_id |
path | string | yes | |
Idempotency-Key |
header | string | 副作用を伴う POST ではサーバーが必須にする。SDK は無ければ自動で付けるので、型では省略できる |
Responses
Section titled “Responses”- 201 —
AgentMemoryArchive: 保存したコンテキストの参照 - default —
Problem: RFC 9457 Problem Details
getArchivedAgentConversationMemory
Section titled “getArchivedAgentConversationMemory”GET/v1/agents/conversations/{conversation_id}/memory/{digest}
agents:read と会話の作成者であることが必要。現在の資格情報と会話から組織・環境・プロジェクト・作成者の範囲を確かめる。 保存先の key はサーバーが決め、保存した JSON の digest と組織・環境・プロジェクト・所有者・会話の範囲 が一致することを確認して返す。 取得しても現在の認可や実行台帳は上書きせず、実行の復元や操作の再実行は行わない
Parameters
Section titled “Parameters”| Name | In | Type | Required | Description |
|---|---|---|---|---|
conversation_id |
path | string | yes | |
digest |
path | string | yes |
Responses
Section titled “Responses”- 200 —
AgentMemorySnapshot: 保存したコンテキスト - default —
Problem: RFC 9457 Problem Details
restoreAgentConversationMemory
Section titled “restoreAgentConversationMemory”POST/v1/agents/conversations/{conversation_id}/memory/{digest}/restore
agents:read・agents:run と元の会話の作成者であることが必要。本文は送らず、Idempotency-Key が必要。 ObjectStore から保存したコンテキストを取得し、4 MiB の上限・Schema・digest・組織・環境・プロジェクト・所有者・会話の範囲 を確認して、同じ Agent の新しい会話を作る。 保存した履歴を新しい会話のコンテキストに引き継ぎ、現在の認可と、有効な ReleaseBundle にある同じ Agent の入力の Schema を使って続ける。 別の Agent へ切り替えると、保存した履歴からの引き継ぎもその境界で区切る。 元の AgentRun・ActionRequest・過去の承認状態は再作成せず、操作を再実行しない
Parameters
Section titled “Parameters”| Name | In | Type | Required | Description |
|---|---|---|---|---|
conversation_id |
path | string | yes | |
digest |
path | string | yes | |
Idempotency-Key |
header | string | 副作用を伴う POST ではサーバーが必須にする。SDK は無ければ自動で付けるので、型では省略できる |
Responses
Section titled “Responses”- 201 —
Conversation: 保存したコンテキストを引き継いだ新しい会話 - default —
Problem: RFC 9457 Problem Details
listToolDefinitions
Section titled “listToolDefinitions”GET/v1/agents/tools
agents:read が必要。Tool Registry。有効な ReleaseBundle で ToolExposure から Agent のツールにしている操作の ToolDefinition
Responses
Section titled “Responses”- 200 —
object: ToolDefinition の一覧 - default —
Problem: RFC 9457 Problem Details
listAgentDefinitions
Section titled “listAgentDefinitions”GET/v1/agents/definitions
agents:read が必要。有効なバージョンの Agent の定義
Responses
Section titled “Responses”- 200 —
object: Agent の定義 - default —
Problem: RFC 9457 Problem Details
listAgentRuns
Section titled “listAgentRuns”GET/v1/agents/runs
agents:read が必要。新しい順
Parameters
Section titled “Parameters”| Name | In | Type | Required | Description |
|---|---|---|---|---|
agent |
query | string | ||
case_id |
query | string | ||
limit |
query | integer |
Responses
Section titled “Responses”- 200 —
object: AgentRun の一覧 - default —
Problem: RFC 9457 Problem Details
startAgentRun
Section titled “startAgentRun”POST/v1/agents/runs
agents:run が必要。有効なバージョンの定義で AgentRun を作り、ドライバーの起動を頼む(コンソールの Playground からの実行)
Parameters
Section titled “Parameters”| Name | In | Type | Required | Description |
|---|---|---|---|---|
Idempotency-Key |
header | string | 副作用を伴う POST ではサーバーが必須にする。SDK は無ければ自動で付けるので、型では省略できる |
Request body
Section titled “Request body”application/json
| Name | Type | Required | Description |
|---|---|---|---|
agent |
string | yes | |
input |
object | yes | |
shadow |
boolean | 外への操作と人への引き継ぎをせず、記録だけを残す |
Responses
Section titled “Responses”- 201 —
AgentRun: 起動を待つ AgentRun - default —
Problem: RFC 9457 Problem Details
requestAgent
Section titled “requestAgent”POST/v1/agents/requests
agents:run が必要。受付。頼んだ人の自由な文から、有効な Agent の中から頼む Agent を選び、定義の入力の Schema に沿って 文から入力を拾う。入力がそろえば実行を始める(201)。足りなければ足りない項目を、Agent を決めきれなければ候補を返す(200)。 手元の受付は LLM を使わず、定義の目的・頼み方の例(examples)と入力の形(format・pattern)で決める
Parameters
Section titled “Parameters”| Name | In | Type | Required | Description |
|---|---|---|---|---|
Idempotency-Key |
header | string | 副作用を伴う POST ではサーバーが必須にする。SDK は無ければ自動で付けるので、型では省略できる |
Request body
Section titled “Request body”application/json
| Name | Type | Required | Description |
|---|---|---|---|
messages |
string[] | yes | まだ実行を始めていない間の、頼んだ人の文(古い順)。聞き返されて答えた文は後ろに足す。新しい文の値を優先する |
agent |
string | 頼む Agent を決めているときの名前。文からは入力だけを拾う | |
shadow |
boolean | 外への操作と人への引き継ぎをせず、記録だけを残す |
Responses
Section titled “Responses”- 200 —
AgentRequestResult: 入力が足りないか、Agent を決めきれない - 201 —
AgentRequestResult: 実行を始めた - default —
Problem: RFC 9457 Problem Details
getAgentRun
Section titled “getAgentRun”GET/v1/agents/runs/{id}
agents:read が必要。状態・結果・ツールの呼出しの記録(引数と結果の全文は持たず、要約だけ)
Parameters
Section titled “Parameters”| Name | In | Type | Required | Description |
|---|---|---|---|---|
id |
path | string | yes |
Responses
Section titled “Responses”- 200 —
AgentRun: AgentRun - default —
Problem: RFC 9457 Problem Details
cancelAgentRun
Section titled “cancelAgentRun”POST/v1/agents/runs/{id}/cancel
agents:run が必要。止める。RunToken の期限を待たず、次のツールの呼出しから拒否する
Parameters
Section titled “Parameters”| Name | In | Type | Required | Description |
|---|---|---|---|---|
id |
path | string | yes | |
Idempotency-Key |
header | string | 副作用を伴う POST ではサーバーが必須にする。SDK は無ければ自動で付けるので、型では省略できる |
Request body
Section titled “Request body”application/json
Responses
Section titled “Responses”- 200 —
AgentRun: 止めた AgentRun - default —
Problem: RFC 9457 Problem Details
listActionRequests
Section titled “listActionRequests”GET/v1/agents/action-requests
agents:read が必要。外への操作の提案(ActionRequest)。新しい順。Agent が外への操作のツールを呼ぶと、 宛先と内容を固定して digest を付け、定義の approval の割り当てに承認の Task を作る
Parameters
Section titled “Parameters”| Name | In | Type | Required | Description |
|---|---|---|---|---|
run_id |
query | string | ||
state |
query | string | ||
approval_task_id |
query | string | この承認の Task で決める操作だけ | |
execution_task_id |
query | string | この実行の Task で人が行う操作だけ | |
limit |
query | integer |
Responses
Section titled “Responses”- 200 —
object: ActionRequest の一覧 - default —
Problem: RFC 9457 Problem Details
getActionRequest
Section titled “getActionRequest”GET/v1/agents/action-requests/{id}
agents:read が必要
Parameters
Section titled “Parameters”| Name | In | Type | Required | Description |
|---|---|---|---|---|
id |
path | string | yes |
Responses
Section titled “Responses”- 200 —
ActionRequest: ActionRequest - default —
Problem: RFC 9457 Problem Details
cancelActionRequest
Section titled “cancelActionRequest”POST/v1/agents/action-requests/{id}/cancel
agents:run が必要。実行の前(承認待ち・実行待ち・ランナー待ち)なら止める。承認を待つ Task も取り消す
Parameters
Section titled “Parameters”| Name | In | Type | Required | Description |
|---|---|---|---|---|
id |
path | string | yes | |
Idempotency-Key |
header | string | 副作用を伴う POST ではサーバーが必須にする。SDK は無ければ自動で付けるので、型では省略できる |
Request body
Section titled “Request body”application/json
Responses
Section titled “Responses”- 200 —
ActionRequest: 止めた ActionRequest - default —
Problem: RFC 9457 Problem Details
reviseActionRequest
Section titled “reviseActionRequest”POST/v1/agents/action-requests/{id}/revise
approvals:tasks.decide が必要。承認を待つ台帳への登録の提案の値を直し、そのまま承認する。 直せるのは承認の Task を決められる人だけで、見出し(項目)は変えられない。直した値で digest を取り直し、 承認の Task を「承認する」で閉じて、直した値を推定として取り込む。取り込みの記録には直した人を残す
Parameters
Section titled “Parameters”| Name | In | Type | Required | Description |
|---|---|---|---|---|
id |
path | string | yes | |
Idempotency-Key |
header | string | 副作用を伴う POST ではサーバーが必須にする。SDK は無ければ自動で付けるので、型では省略できる |
Request body
Section titled “Request body”application/json
| Name | Type | Required | Description |
|---|---|---|---|
csv |
string | yes | 直した値。見出しは提案と同じ |
task_version |
integer | yes | 承認の Task のバージョン(If-Match と同じ) |
Responses
Section titled “Responses”- 200 —
ActionRequest: 直して承認した ActionRequest - default —
Problem: RFC 9457 Problem Details
recordManualResult
Section titled “recordManualResult”POST/v1/agents/action-requests/{id}/perform
approvals:tasks.decide が必要。人が行う操作の結果を実行台帳に記録し、実行の Task を閉じる。記録できるのは実行の Task を 決められる人だけ。担当が見た digest がいまの内容と違えば 409。accepted・declined は承認された相手・方法・金額で行ったときだけ 記録でき、違えば 409 で何も残さない。違う内容で行ったら deviated で記録する。ActionRequest は failed になり、再承認に回す
Parameters
Section titled “Parameters”| Name | In | Type | Required | Description |
|---|---|---|---|---|
id |
path | string | yes | |
Idempotency-Key |
header | string | 副作用を伴う POST ではサーバーが必須にする。SDK は無ければ自動で付けるので、型では省略できる |
Request body
Section titled “Request body”application/json — ManualResultInput
| Name | Type | Required | Description |
|---|---|---|---|
task_version |
integer | yes | 実行の Task のバージョン(If-Match と同じ) |
action_digest |
string | yes | 担当が見た承認の対象の digest |
result |
accepted | declined | deviated | not_performed |
yes | accepted は相手が受け付けた、declined は相手が断った、deviated は承認された内容と違うことをした、 not_performed は行わなかった |
performed_at |
string | 行った日時。not_performed のほかは必須 | |
counterparty |
string | 行った相手。not_performed のほかは必須 | |
method |
ManualMethod | ||
reference |
string | 受付番号。accepted は必須 | |
amount |
number | 行った金額(通貨の最小単位)。承認の対象に金額があれば必須 | |
currency |
string | ||
note |
string | 断られた理由、違った内容、行わなかった理由。accepted のほかは必須 |
Responses
Section titled “Responses”- 200 —
ActionRequest: 結果を記録した ActionRequest - default —
Problem: RFC 9457 Problem Details
answerActionHandoff
Section titled “answerActionHandoff”POST/v1/agents/action-requests/{id}/handoff
approvals:tasks.decide が必要で、引き継ぎの Task を決められる人だけが呼べる。CAPTCHA や多要素認証で止まった手順の、 ページの欄に答えて Task を閉じ、止まったところから続ける。答えの値は暗号化して持ち、続きの実行が読んだら消す
Parameters
Section titled “Parameters”| Name | In | Type | Required | Description |
|---|---|---|---|---|
id |
path | string | yes | |
Idempotency-Key |
header | string | 副作用を伴う POST ではサーバーが必須にする。SDK は無ければ自動で付けるので、型では省略できる |
Request body
Section titled “Request body”application/json
| Name | Type | Required | Description |
|---|---|---|---|
fields |
object | yes | 欄の名前ごとの答え。ページで答えられる欄だけを受け付ける |
task_version |
integer | yes |
Responses
Section titled “Responses”- 200 —
ActionRequest: 続きの実行を待つ - default —
Problem: RFC 9457 Problem Details
listBrowserRunners
Section titled “listBrowserRunners”GET/v1/agents/browser-runners
agents:read が必要
Responses
Section titled “Responses”- 200 —
object: ランナーの一覧 - default —
Problem: RFC 9457 Problem Details
registerBrowserRunner
Section titled “registerBrowserRunner”POST/v1/agents/browser-runners
agents:runners.manage が必要。ランナーを、動ける主体と扱ってよい接続に束縛して登録する
Parameters
Section titled “Parameters”| Name | In | Type | Required | Description |
|---|---|---|---|---|
Idempotency-Key |
header | string | 副作用を伴う POST ではサーバーが必須にする。SDK は無ければ自動で付けるので、型では省略できる |
Request body
Section titled “Request body”application/json
| Name | Type | Required | Description |
|---|---|---|---|
name |
string | yes | |
kind |
network | laptop |
yes | |
principal |
string | yes | |
connections |
string[] | yes |
Responses
Section titled “Responses”- 201 —
BrowserRunner: 登録した - default —
Problem: RFC 9457 Problem Details
revokeBrowserRunner
Section titled “revokeBrowserRunner”POST/v1/agents/browser-runners/{id}/revoke
agents:runners.manage が必要。以後は仕事を渡さず、持っている仕事の結果も受け取らない
Parameters
Section titled “Parameters”| Name | In | Type | Required | Description |
|---|---|---|---|---|
id |
path | string | yes | |
Idempotency-Key |
header | string | 副作用を伴う POST ではサーバーが必須にする。SDK は無ければ自動で付けるので、型では省略できる |
Responses
Section titled “Responses”- 200 —
BrowserRunner: 取り消した - default —
Problem: RFC 9457 Problem Details
attendBrowserRunner
Section titled “attendBrowserRunner”POST/v1/agents/browser-runners/{id}/attend
agents:runners.run が必要。社員本人の認証だけが呼べる。端末のランナーに立ち会っていることを 5 分間宣言する
Parameters
Section titled “Parameters”| Name | In | Type | Required | Description |
|---|---|---|---|---|
id |
path | string | yes | |
Idempotency-Key |
header | string | 副作用を伴う POST ではサーバーが必須にする。SDK は無ければ自動で付けるので、型では省略できる |
Responses
Section titled “Responses”- 200 —
BrowserRunner: 宣言した - default —
Problem: RFC 9457 Problem Details
claimBrowserRunnerJob
Section titled “claimBrowserRunnerJob”POST/v1/agents/browser-runners/{id}/claim
agents:runners.run が必要。ランナーの主体だけが呼べる。次の仕事を受け取る。取り消したランナーは拒み、 立ち会いのない端末のランナーには渡さない。応答は冪等の台帳に保存しないので、同じ Idempotency-Key でも呼ぶたびに確かめる
Parameters
Section titled “Parameters”| Name | In | Type | Required | Description |
|---|---|---|---|---|
id |
path | string | yes | |
Idempotency-Key |
header | string | 副作用を伴う POST ではサーバーが必須にする。SDK は無ければ自動で付けるので、型では省略できる |
Responses
Section titled “Responses”- 200 —
object: 仕事。なければ job は null - default —
Problem: RFC 9457 Problem Details
reportBrowserRunnerJob
Section titled “reportBrowserRunnerJob”POST/v1/agents/browser-runners/{id}/jobs/{action}/result
agents:runners.run が必要。受け取った仕事の結果を記録する。取り消したランナーの結果は受け取らない
Parameters
Section titled “Parameters”| Name | In | Type | Required | Description |
|---|---|---|---|---|
id |
path | string | yes | |
action |
path | string | yes | |
Idempotency-Key |
header | string | 副作用を伴う POST ではサーバーが必須にする。SDK は無ければ自動で付けるので、型では省略できる |
Request body
Section titled “Request body”application/json
Responses
Section titled “Responses”- 200 —
ActionRequest: 記録した - default —
Problem: RFC 9457 Problem Details
reconcileActionRequest
Section titled “reconcileActionRequest”POST/v1/agents/action-requests/{id}/reconcile
agents:run が必要。送ったか分からない(unknown)操作を、相手の記録で確かめた結果にする
Parameters
Section titled “Parameters”| Name | In | Type | Required | Description |
|---|---|---|---|---|
id |
path | string | yes | |
Idempotency-Key |
header | string | 副作用を伴う POST ではサーバーが必須にする。SDK は無ければ自動で付けるので、型では省略できる |
Request body
Section titled “Request body”application/json
| Name | Type | Required | Description |
|---|---|---|---|
sent |
boolean | yes | 相手に届いていたか |
note |
string | yes | 確かめた方法 |
Responses
Section titled “Responses”- 200 —
ActionRequest: 照合した ActionRequest - default —
Problem: RFC 9457 Problem Details
listDeciderOverrides
Section titled “listDeciderOverrides”GET/v1/agents/decider-overrides
agents:read が必要。ReleaseBundle を待たずに承認を人だけに戻したツール
Responses
Section titled “Responses”- 200 —
object: 上書きの一覧 - default —
Problem: RFC 9457 Problem Details
restrictDeciders
Section titled “restrictDeciders”POST/v1/agents/decider-overrides
approvals:deciders.restrict が必要。ツールの承認をすぐに人だけに戻す(審査用の Agent の承認と、policy の自動の承認を止める)。 AI に任せる範囲を狭めるだけなので、ReleaseBundle と公開ゲートを通さない。承認を待つ提案にも効く
Parameters
Section titled “Parameters”| Name | In | Type | Required | Description |
|---|---|---|---|---|
Idempotency-Key |
header | string | 副作用を伴う POST ではサーバーが必須にする。SDK は無ければ自動で付けるので、型では省略できる |
Request body
Section titled “Request body”application/json
| Name | Type | Required | Description |
|---|---|---|---|
tools |
string[] | yes | |
reason |
string | yes |
Responses
Section titled “Responses”- 200 —
object: 上書きの一覧 - default —
Problem: RFC 9457 Problem Details
restoreDeciders
Section titled “restoreDeciders”DELETE/v1/agents/decider-overrides/{tool}
approvals:deciders.restore が必要(admin)。上書きを外し、有効な ReleaseBundle の DeciderPolicy に戻す
Parameters
Section titled “Parameters”| Name | In | Type | Required | Description |
|---|---|---|---|---|
tool |
path | string | yes | |
Idempotency-Key |
header | string | 副作用を伴う POST ではサーバーが必須にする。SDK は無ければ自動で付けるので、型では省略できる |
Responses
Section titled “Responses”- 200 —
object: 上書きの一覧 - default —
Problem: RFC 9457 Problem Details
getAgentBudget
Section titled “getAgentBudget”GET/v1/agents/budget
agents:read が必要。今日(UTC)の予算(platform/v1alpha1 Budget)と使った数。Budget がなければ limit は null
Responses
Section titled “Responses”- 200 —
object: 今日の予算 - default —
Problem: RFC 9457 Problem Details
getModelUsage
Section titled “getModelUsage”GET/v1/agents/model-usage
agents:read が必要。Model Gateway を通ったモデルの呼出しを、日(UTC)・Agent・モデルごとに数えた直近の使用量。プロンプトと応答の本文は残していない
Parameters
Section titled “Parameters”| Name | In | Type | Required | Description |
|---|---|---|---|---|
days |
query | integer |
Responses
Section titled “Responses”- 200 —
object: 使用量 - default —
Problem: RFC 9457 Problem Details
listEvalSuites
Section titled “listEvalSuites”GET/v1/agents/eval-suites
agents:read が必要。有効なバージョンの EvalSuite
Responses
Section titled “Responses”- 200 —
object: EvalSuite の定義 - default —
Problem: RFC 9457 Problem Details
listEvals
Section titled “listEvals”GET/v1/agents/evals
agents:read が必要。評価の実行。新しい順に 50 件
Responses
Section titled “Responses”- 200 —
object: 評価の実行 - default —
Problem: RFC 9457 Problem Details
startEval
Section titled “startEval”POST/v1/agents/evals
agents:run が必要。EvalSuite の件ごとに Agent を shadow で起動する。外への操作と人への引き継ぎは起きない
Parameters
Section titled “Parameters”| Name | In | Type | Required | Description |
|---|---|---|---|---|
Idempotency-Key |
header | string | 副作用を伴う POST ではサーバーが必須にする。SDK は無ければ自動で付けるので、型では省略できる |
Request body
Section titled “Request body”application/json
| Name | Type | Required | Description |
|---|---|---|---|
suite |
string | yes | |
release_id |
string | まだ有効にしていないバージョンで評価するときに渡す。stage と prod の有効化には、そのバージョンで通った評価が要る |
Responses
Section titled “Responses”- 202 —
EvalRun: 始めた評価 - default —
Problem: RFC 9457 Problem Details
compareEvals
Section titled “compareEvals”GET/v1/agents/evals/compare
agents:read が必要。同じ EvalSuite の 2 回の評価を件ごとに比べる。知識を入れる前後の ReleaseBundle で評価を流し、 通るようになった件と落ちるようになった件、結果の項目の違いを見る
Parameters
Section titled “Parameters”| Name | In | Type | Required | Description |
|---|---|---|---|---|
base |
query | string | yes | |
target |
query | string | yes |
Responses
Section titled “Responses”- 200 —
EvalComparison: 比べた結果 - default —
Problem: RFC 9457 Problem Details
getEval
Section titled “getEval”GET/v1/agents/evals/{id}
agents:read が必要
Parameters
Section titled “Parameters”| Name | In | Type | Required | Description |
|---|---|---|---|---|
id |
path | string | yes |
Responses
Section titled “Responses”- 200 —
EvalRun: 評価の実行 - default —
Problem: RFC 9457 Problem Details