---
title: "PATCH /projects/{projectId}/wizard-sessions/{sessionId}"
method: PATCH
path: "/projects/{projectId}/wizard-sessions/{sessionId}"
---

# PATCH /projects/{projectId}/wizard-sessions/{sessionId}

`PATCH /projects/{projectId}/wizard-sessions/{sessionId}`

## Request

- Base URL: `https://api.caveman.so/api/v1`
- URL: `https://api.caveman.so/api/v1/projects/{projectId}/wizard-sessions/{sessionId}`
- Auth: one of:
  - OAuth 2
    - Authorization code: `/api/v1/oauth/authorize`
    - Token URL: `/api/v1/oauth/token` scopes: `proposal:draft`
  - HTTP bearer
  - API key in cookie `cave_access`
  - API key in cookie `__Secure-cave_identity.session_token`

PATCH /api/v1/projects/{projectId}/wizard-sessions/{sessionId} on the Caveman Cloud control plane. Requires the proposal:draft scope. Exposed to autonomous agents as the update action of the caveman_wizard_write tool (write access). Start, heartbeat and cancel the onboarding wizard session that `caveman onboard` runs. It reports progress only; it grants nothing and changes no setting.

## Request body

- object
  - `phase` 'connecting' | 'planning' | 'awaiting_confirmation' | 'editing' | 'testing' | 'publishing' | 'completed' | 'failed' | 'cancelled'
  - `tasks` object[]
    - `id` string, required
    - `label` string, required
    - `status` 'pending' | 'running' | 'done' | 'blocked' | 'failed', required
    - `detail` string
  - `pending_input` string
  - `branch` string
  - `pr_url` string
  - `error` string

## Response `2XX`

Successful response. Exact status depends on synchronous or durable delivery outcome.

## Other responses

- `4XX`: Structured failure. `error.code` is stable; `error.request_id` is echoed in the x-cave-request-id header.
- `5XX`: Structured failure. `error.code` is stable; `error.request_id` is echoed in the x-cave-request-id header.

---

[API](https://skmtc.dev/caveman/apis/caveman-cloud-api.md) - [All operations](https://skmtc.dev/caveman/apis/caveman-cloud-api/llms.txt) - [OpenAPI document](https://skmtc.dev/caveman/apis/caveman-cloud-api/revisions/508312d01cfc?raw)