---
title: "Create Custom Layout Template"
method: POST
path: "/brand-kit/layout-templates/custom"
tags: ["Brand Kit"]
---

# Create Custom Layout Template

`POST /brand-kit/layout-templates/custom`

## Request

- Base URL: `https://be.graph8.com/api/v1`
- URL: `https://be.graph8.com/api/v1/brand-kit/layout-templates/custom`
- Auth: HTTP bearer

Queue one landing page template built from a plain-language idea.

Pass the `plan` returned by `/layout-templates/custom/plan` to build the
page you previewed; omit it and the idea is re-interpreted from scratch,
which will not match the preview.

`attached_assets` are MANDATORY inclusions, not suggestions - the generated
page uses them. Capped at 5 images and 2 videos.

## Headers

- `Authorization` string, nullable
- `X-Target-Org-Id` string, nullable

## Request body

- CustomLayoutTemplateRequest: Mirrors `campaign_builder.routers.brand_kit.CustomLayoutTemplateRequest`. `plan` is the object `POST /brand-kit/layout-templates/custom/plan` returns. Passing it back is how you build the page you previewed rather than a new interpretation of the same idea.
  - `idea` string, required: Plain-language description of the page to build.
  - `name` string, nullable: Short title. Derived from the idea when omitted.
  - `attached_assets` AttachedAsset[]: Images and videos the page must use. Max 5 images and 2 videos.
    - `type` 'image' | 'video', required: Asset kind.
    - `id` string, required: Asset id.
    - `url` string, required: Public URL the generated page will reference.
    - `poster_url` string, nullable: Poster frame for a video.
    - `alt_text` string, nullable: Alt text.
    - `title` string, nullable: Title.
    - `position_hint` 'hero' | 'body' | 'any': Where the asset should land on the page.
  - `plan` LpPlan: Full landing-page plan — 1..8 sections.
    - `sections` PlanSection[], required
      - `name` string, required
      - `purpose` string, required
      - `media` PlanMediaEntry[]
        - `role` string, required
        - `context` string, required
        - `asset_id` string, nullable
        - `asset_url` string, nullable
        - `asset_type` 'image' | 'video', required
        - `position_hint` 'hero' | 'body' | 'any'
        - `locked` boolean

## Response `202`

Successful Response

- ApiResponseStudioPayload
  - `data` StudioPayload, required: An open envelope for one settings block, document or brand artefact. OPEN on purpose. These surfaces are configuration and generated content, and both grow: a new toggle on a settings block or a new field on a generated document must reach a caller on the day it ships, not on the day somebody remembers to widen a mirror. A closed response model here would silently DROP the new key, which reads to the caller as "the product does not have that setting". The request side is the opposite and is mirrored exactly - see the module docstring for why the asymmetry is deliberate.
  - `pagination` PaginationMeta
    - `page` integer, required: Current page number (1-indexed)
    - `limit` integer, required: Items per page
    - `total` integer, required: Total number of items
    - `has_next` boolean, required: Whether there are more pages
    - `next_cursor` string, nullable: Opaque cursor for the next page; null when there are no more items. Pass it back as the `cursor` query param to fetch the following page without computing page numbers.
    - `total_available` integer, nullable: Search endpoints only: how many records really match, when known. Can be larger than `total`, which is capped at the 10,000 results that can be paged. For company search this is a distinct-company estimate. Null when unknown; absent outside search.
    - `total_is_lower_bound` boolean, nullable: Search endpoints only: true when more records match than `total` shows (the result set is larger than the 10,000 results that can be paged). Absent outside search.
    - `notes` string[], nullable: Search endpoints only: plain-language notes about the result, e.g. that more records match than can be paged, or that a reversed `between` range was put in order.

## Other responses

- `422`: Validation Error

---

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