Cowork

Cowork の手元のハーネス向けのモデル利用。業務 Agent の定義や実行は必要としない。

説明は公開 API の契約（OpenAPI）から生成しています。

エンドポイント

GET	/v1/cowork/policy
PUT	/v1/cowork/policy
POST	/v1/cowork/model-sessions
GET	/v1/cowork/model-sessions/{session_id}
DELETE	/v1/cowork/model-sessions/{session_id}
POST	/v1/cowork/model-sessions/{session_id}/refresh
GET	/v1/cowork/model-sessions/{session_id}/invocations

getCoworkPolicy

GET/v1/cowork/policy

プロジェクトと環境に適用する設定。cowork:run または cowork:manage が必要。端末は実行中もこの設定を読み直して手元の機能の決まりに反映し、読めなければ禁止として扱う。

応答

• 200 — CoworkPolicy: 未設定なら利用を無効にし、手元の機能をすべて禁止した設定を返す。ETag は設定のバージョン。
• default — Problem: RFC 9457 Problem Details

setCoworkPolicy

PUT/v1/cowork/policy

組織の管理者が利用の可否・モデル・利用枠・手元の機能の決まりを設定する。cowork:manage が必要。local_tools を省くと、保存済みの手元の機能の決まりをそのまま使う。

パラメーター

名前	場所	型	必須	説明
If-Match	header	string	はい	取得したときの ETag（version）

リクエストの本文

application/json — CoworkPolicyInput

名前	型	必須	説明
enabled	boolean	はい
models	string[]	はい
daily_token_limit	integer	はい
session_token_limit	integer	はい
max_output_tokens	integer	はい
local_tools	CoworkLocalTools

応答

• 200 — CoworkPolicy: 保存した設定。
• default — Problem: RFC 9457 Problem Details

createCoworkModelSession

POST/v1/cowork/model-sessions

本人の手元の会話にモデル利用を許可する。cowork:run が必要。同じ会話の有効な利用は再利用する。秘密値を含む応答は保存・再送しない。

パラメーター

名前	場所	型	必須	説明
Idempotency-Key	header	string		副作用を伴う POST ではサーバーが必須にする。SDK は無ければ自動で付けるので、型では省略できる

リクエストの本文

application/json

名前	型	必須	説明
conversation_id	string	はい
model	string	はい

応答

• 201 — CoworkModelCredential: 本人と組織・プロジェクト・環境に束縛したモデル利用と短命の資格情報。
• default — Problem: RFC 9457 Problem Details

getCoworkModelSession

GET/v1/cowork/model-sessions/{session_id}

本人のモデル利用を読む。cowork:run が必要。

パラメーター

名前	場所	型	必須	説明
session_id	path	string	はい

応答

• 200 — CoworkModelSession: モデル利用。
• default — Problem: RFC 9457 Problem Details

revokeCoworkModelSession

DELETE/v1/cowork/model-sessions/{session_id}

本人のモデル利用を取り消す。新規の呼出しは即座に拒否し、流れている呼出しも停止の確認で切る。cowork:run が必要。

パラメーター

名前	場所	型	必須	説明
session_id	path	string	はい

応答

• 204: 取り消した。すでに取り消していても同じ応答。
• default — Problem: RFC 9457 Problem Details

refreshCoworkModelSession

POST/v1/cowork/model-sessions/{session_id}/refresh

本人のいまの権限・設定・残りの利用枠を確かめて資格情報を更新する。古い資格情報での新規の呼出しは拒否する。流れている呼出しの記録は受け付ける。

パラメーター

名前	場所	型	必須	説明
session_id	path	string	はい
Idempotency-Key	header	string		副作用を伴う POST ではサーバーが必須にする。SDK は無ければ自動で付けるので、型では省略できる

応答

• 200 — CoworkModelCredential: 更新した資格情報。秘密値を含む応答は保存・再送しない。
• default — Problem: RFC 9457 Problem Details

listCoworkModelInvocations

GET/v1/cowork/model-sessions/{session_id}/invocations

本人のモデル呼出しの記録。cowork:run が必要。上流へ渡す前に記録し、応答が失われても呼出しが消えない。

パラメーター

名前	場所	型	必須	説明
session_id	path	string	はい
limit	query	integer
cursor	query	string

応答

• 200 — object: 呼出しの記録。
• default — Problem: RFC 9457 Problem Details