POST /api/v1/cloud/sessions
Session を作成します。新しい Session は idle 状態で開始します。イベントを送信すると処理が始まります。
ヘッダー
| ヘッダー | 必須 | 説明 |
|---|---|---|
Authorization | はい | Bearer $QODER_PAT |
Content-Type | はい | application/json |
リクエストボディ
| フィールド | 型 | 必須 | 説明 |
|---|---|---|---|
agent | string または object | はい | Agent ID、または id、必須の type: "agent"、任意の version を含むオブジェクト。Agent reference を参照 |
environment_id | string | はい | env_ プレフィックスを持つ既存の Environment ID |
title | string | null | いいえ | Session タイトル |
metadata | object | いいえ | Session メタデータ |
environment_variables | string | いいえ | agent ランタイムに注入する Session レベルの環境変数。KEY=VALUE ペアを ;(または改行、全角 ; も受け付け)で区切った単一文字列で指定します。レスポンスのフィールドは JSON オブジェクトです — 検証 を参照。self-hosted 環境では非対応 |
incremental_streaming_enabled | boolean | いいえ | この Session の増分ストリーミングイベントを有効にします。デフォルト: false。true の場合、list および stream のイベント API は、最終的な完全イベントに加えて agent.message_start、agent.content_block_delta、agent.message_stop などの増分 agent イベントを公開します |
resources | array | いいえ | 作成時にアタッチする file、GitHub リポジトリ、または Memory Store リソース |
vault_ids | array | いいえ | Session が利用できる Vault ID |
environment、delta_flush_interval_ms、vaults、memory_store_ids はサポートされません。Memory Store をアタッチするには resources[] で type: "memory_store" を使用してください。
environment variables の検証
名前は[A-Za-z_][A-Za-z0-9_]* に一致する必要があります。予約名 SERVER_ENDPOINT、USER_ID、WORK_DIR、および CAW_ または QODER_ プレフィックスを持つ名前は拒否されます。各値は 8 KiB を超えられません。フィールド全体で 64 エントリまたは合計 64 KiB を超えられません。重複キー、不正な形式のエントリ、または self-hosted 環境での使用は 400 invalid_request_error を返します。
リソースパラメータ
| リソース種別 | 必須フィールド | 任意フィールド |
|---|---|---|
file | type, file_id | mount_path |
github_repository | type, url, authorization_token | mount_path, checkout |
memory_store | type, memory_store_id | access, instructions |
リクエスト例
レスポンス例
HTTP 200 OK Session オブジェクトを返します。エラー
| HTTP | Type | 発生条件 |
|---|---|---|
| 400 | invalid_request_error | リクエストの形式エラー、必須フィールドの欠落、サポートされないレガシーフィールド、または無効なリソース |
| 401 | authentication_error | PAT が無効または期限切れ |
| 404 | not_found_error | Agent、Environment、file、Memory Store、または Vault が存在しない |
| 409 | invalid_request_error | 参照したファイルが ready でない、またはリソースのパス/ID が競合 |
agent_ プレフィックスを持たない agent 値(または env_ プレフィックスを持たない environment_id)も、400 ではなく 404 not_found_error として解決されます。
完全なエラーエンベロープについては Errors を参照してください。
関連項目
Session の起動
Agent を環境で実行し、ステートフルな対話を行う。