---
title: "Save Session Canvas State"
method: PATCH
path: "/api/v1/creative-agent/sessions/{session_id}/canvas_state"
tags: ["Creative Agent"]
---

# Save Session Canvas State

`PATCH /api/v1/creative-agent/sessions/{session_id}/canvas_state`

## Request

- Base URL: `https://api.muapi.ai`
- URL: `https://api.muapi.ai/api/v1/creative-agent/sessions/{session_id}/canvas_state`
- Auth: one of:
  - API key in header `x-api-key`
  - OAuth 2 (client credentials, token URL `https://api.muapi.ai/oauth/token`)

Persist the canvas layout immediately after a direct-manipulation edit
(delete, move, resize) that isn't part of a chat turn — without this, such
edits are lost on refresh since canvas_state otherwise only saves as a
side-effect of sending a chat message.

## Path parameters

- `session_id` string, required

## Query parameters

- `team_id` integer, nullable

## Headers

- `x-api-key` string
- `x-embed-code` string, nullable
- `x-agent-embed-code` string, nullable
- `x-whitelabel-studio` string, nullable
- `authorization` string, nullable

## Request body

- SaveCanvasStateRequest
  - `canvas_state` object, required

## Response `200`

Successful Response

- unknown

## Other responses

- `422`: Validation Error

---

[API](https://skmtc.dev/muapi/apis/muapi-api.md) · [All operations](https://skmtc.dev/muapi/apis/muapi-api/llms.txt) · [OpenAPI document](https://skmtc.dev/muapi/apis/muapi-api/revisions/e4b7374381e5?raw)