Sign in

v1

latestOpenAPI 3.1.02026-07-17325265.6 KB
Sessions

Update session settings

Update session settings such as auto-accept mode or archived status. Only specified fields will be updated.

patch/sessions/{id}

Path parameters

idstring required

Session ID

Request body

auto_accept_editsboolean

Enable/disable auto-accept for edit tools

dangerously_skip_permissionsboolean

Enable or disable dangerously skip permissions mode

dangerously_skip_permissions_timeout_msinteger nullable

Optional timeout in milliseconds for dangerously skip permissions mode

archivedboolean

Archive/unarchive the session

titlestring

Update session title

modelstring

Model to use (opus, sonnet, or empty for default)

model_idstring

Full model identifier

proxy_enabledboolean

Enable proxy routing for this session

proxy_base_urlstring

Base URL for proxy service

proxy_model_overridestring

Model identifier for proxy routing

proxy_api_keystring

API key for proxy authentication

additional_directoriesstring[]

Update additional directories Claude can access

working_dirstring

Update the working directory for the session

editor_statestring

JSON blob of editor state for draft sessions

status'draft' | 'starting' | 'running' | 'completed' | 'failed' | 'interrupting' | 'interrupted' | 'waiting_input' | 'discarded'

Current status of the session

Example request

{
  "title": "Updated Task Name",
  "model": "sonnet",
  "model_id": "claude-3-5-sonnet-20241022",
  "proxy_enabled": true,
  "proxy_base_url": "https://openrouter.ai/api/v1",
  "proxy_model_override": "anthropic/claude-3.5-sonnet",
  "proxy_api_key": "sk-or-...",
  "additional_directories": [
    "~/.humanlayer/logs",
    "/var/log/myapp"
  ],
  "working_dir": "/Users/john/projects/myapp",
  "editor_state": "{\"content\":\"console.log(\\\"hello\\\");\",\"cursorPosition\":24}"
}

Response

Session updated successfully

Example response

{
  "data": {
    "id": "sess_abcdef123456",
    "run_id": "run_xyz789",
    "claude_session_id": "claude_sess_123",
    "parent_session_id": "sess_parent123",
    "query": "Help me refactor this code",
    "summary": "Refactored authentication module",
    "title": "My Important Task",
    "model": "sonnet",
    "model_id": "claude-opus-4-1-20250805",
    "working_dir": "/home/user/project",
    "additional_directories": [
      "~/.humanlayer/logs",
      "/var/log/myapp"
    ],
    "cost_usd": 0.05,
    "input_tokens": 1000,
    "output_tokens": 500,
    "cache_creation_input_tokens": 100,
    "cache_read_input_tokens": 50000,
    "effective_context_tokens": 51100,
    "context_limit": 168000,
    "duration_ms": 45000,
    "proxy_base_url": "https://openrouter.ai/api/v1",
    "proxy_model_override": "openai/gpt-oss-120b",
    "editor_state": "{\"content\":\"console.log(\\\"hello\\\");\",\"cursorPosition\":24}"
  }
}