Skip to main content
Sessions

セッションのアーカイブ

Forward セッションをアーカイブします。

POST /api/v1/forward/sessions/{session_id}/archive セッションをアーカイブします。アーカイブ済みのセッションは既定で一覧結果から除外されます。

Headers

HeaderRequiredDescription
AuthorizationYesBearer <PAT または SAT>
Idempotency-KeyNo安全でないリクエスト向けの任意の冪等性キー。

Path parameters

ParameterTypeRequiredDescription
session_idstringYesSession ID。

Example request

curl -s -X POST 'https://api.qoder.com/api/v1/forward/sessions/sess_xxx/archive' \
  -H "Authorization: Bearer $QODER_ACCESS_TOKEN"

Example response

HTTP 200 OK
{
  "id": "sess_xxx",
  "type": "session",
  "identity_id": "idn_xxx",
  "template": {
    "id": "tmpl_support",
    "type": "template",
    "name": "Support assistant",
    "model": "ultimate",
    "version": 3
  },
  "source_type": "api",
  "status": "idle",
  "title": "Customer support session",
  "metadata": {},
  "config": {
    "environment_variables": {
      "API_KEY": "sk-xxx"
    }
  },
  "stats": {
    "active_seconds": 0,
    "duration_seconds": 0
  },
  "usage": {
    "total_credits": 13.0
  },
  "archived_at": "2026-06-22T12:00:00Z",
  "created_at": "2026-06-22T10:00:00Z",
  "updated_at": "2026-06-22T12:00:00Z"
}

Response fields

archived_at が設定されたアーカイブ済みの Session オブジェクトを返します。

Errors

HTTPTypeCodeTrigger
401authentication_errorauthentication_requiredPAT または SAT が無効または期限切れ。
404not_found_errorsession_not_foundSession が存在しない。
409conflict_errorsession_archivedSession はすでにアーカイブ済み。

Notes

  • 現在の設計では復元用のエンドポイントは提供していません。
  • アーカイブ済みのセッションをクエリするには、List Sessions で include_archived=true を使用してください。
ベストプラクティス