Sign in

v1

latestOpenAPI 3.1.02026-07-17325265.6 KB
Sessions

Launch a new session

Create and start a new Claude Code session

post/sessions

Request body

querystring required

Initial query for Claude

titlestring

Optional title for the session

model'opus' | 'sonnet' | 'haiku'

Model to use for the session

permission_prompt_toolstring

MCP tool for permission prompts

working_dirstring

Working directory for the session

max_turnsinteger

Maximum conversation turns

system_promptstring

Override system prompt

append_system_promptstring

Text to append to system prompt

allowed_toolsstring[]

Whitelist of allowed tools

disallowed_toolsstring[]

Blacklist of disallowed tools

additional_directoriesstring[]

Additional directories Claude can access

custom_instructionsstring

Custom instructions for Claude

auto_accept_editsboolean

Enable auto-accept for edit tools

dangerously_skip_permissionsboolean

Launch session with dangerously skip permissions enabled

dangerously_skip_permissions_timeoutinteger nullable

Optional default timeout in milliseconds for dangerously skip permissions

verboseboolean

Enable verbose output

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

draftboolean

Create session in draft state without launching Claude

createDirectoryIfNotExistsboolean

Create the working directory if it does not exist

Example request

{
  "query": "Help me write a Python script to process CSV files",
  "title": "CSV Processing Script",
  "mcp_config": {
    "mcpServers": {
      "filesystem": {
        "command": "mcp-server-filesystem",
        "args": [
          "--read-only"
        ]
      }
    }
  },
  "working_dir": "/home/user/project",
  "max_turns": 10,
  "allowed_tools": [
    "read_file",
    "write_file"
  ],
  "disallowed_tools": [
    "execute_command"
  ],
  "additional_directories": [
    "~/.humanlayer/logs",
    "/var/log/myapp"
  ],
  "proxy_base_url": "https://openrouter.ai/api/v1",
  "proxy_model_override": "openai/gpt-4"
}

Response

Session created successfully

Example response

{
  "data": {
    "session_id": "sess_new123",
    "run_id": "run_new456"
  }
}