---
title: "POST /layouts"
method: POST
path: "/layouts"
tags: ["Layouts"]
---

# POST /layouts

`POST /layouts`

This endpoint allows you to create a layout.

## Request body

- ApiLayoutCreate
  - `panes` ApiPane[]
    - `id` integer, required — Unique identifier of pane in layout assigned to each pane. This determines the location indexing of panes in layout.
    - `name` string, required — Name of the pane in layout
    - `type` 'preview' | 'compositePreview', required — Possible values: * `preview` - show the view for a single camera using "preview" images which are lower resolution and lower frequency than the real stream. * `compositePreview` - show the composite of a de-warped camera view.
    - `size` integer, required — Size of displayed image in pane. Size 1 shows the smallest size
    - `cameraId` string, required — Unique identifier of the camera.
    - `compositeId` string, nullable — Unique identifier of the composite of a de-warped camera view.
  - `settings` object, required — Object identifying the layout settings
    - `showCameraBorder` boolean, required — This flag if enabled, shows pane borders.
    - `showCameraName` boolean, required — This flag if enabled, shows camera name
    - `cameraAspectRatio` '16x9' | '4x3', required — Aspect ratio of image
    - `paneColumns` integer, required — Max number of cameras to show per row
  - `name` string, required — Name of the layout.

## Response `201`

Layout Created

- ApiLayoutForSingle
  - `panes` ApiPane[]
    - `id` integer, required — Unique identifier of pane in layout assigned to each pane. This determines the location indexing of panes in layout.
    - `name` string, required — Name of the pane in layout
    - `type` 'preview' | 'compositePreview', required — Possible values: * `preview` - show the view for a single camera using "preview" images which are lower resolution and lower frequency than the real stream. * `compositePreview` - show the composite of a de-warped camera view.
    - `size` integer, required — Size of displayed image in pane. Size 1 shows the smallest size
    - `cameraId` string, required — Unique identifier of the camera.
    - `compositeId` string, nullable — Unique identifier of the composite of a de-warped camera view.
  - `settings` object, required — Object identifying the layout settings
    - `showCameraBorder` boolean, required — This flag if enabled, shows pane borders.
    - `showCameraName` boolean, required — This flag if enabled, shows camera name
    - `cameraAspectRatio` '16x9' | '4x3', required — Aspect ratio of image
    - `paneColumns` integer, required — Max number of cameras to show per row
  - `name` string, required — Name of the layout.

## Other responses

- `400` — The supplied object is invalid. Error detail will contain the validation error.
- `401` — You are not authenticated. Please authenticate and try again.
- `403` — You have no permission to access the specified resource.
- `500` — Something went wrong in the server. Please try again.

---

[API](https://skmtc.net/eagleeyenetworks/apis/devices.md) · [All operations](https://skmtc.net/eagleeyenetworks/apis/devices/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/eagleeyenetworks/devices/revisions/df57313de545/schema)