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

# Get Session Canvas State

`GET /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`)

Return the persisted canvas layout (positions + viewport) for a session.
Frontend fetches this on session open so assets render at their last
positions instead of stacking at canvas centre. Returns {} for sessions
that haven't had any layout written yet.

## 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

## 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)