---
title: "Trigger Brand Extraction"
method: POST
path: "/brand-kit/extract"
tags: ["Brand Kit"]
---

# Trigger Brand Extraction

`POST /brand-kit/extract`

## Request

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

Start, or restart, brand extraction.

Omit the body to re-extract the website already on the org's company
profile. Supplying `website_url` EXTRACTS A DIFFERENT SITE and replaces
the org's design tokens and homepage capture with that site's - which is
how a brand kit ends up belonging to the wrong company. Asynchronous; the
result appears on `GET /brand-kit`.

## Headers

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

## Request body

- BrandExtractionRequest: Mirrors `campaign_builder.routers.brand_kit.TriggerExtractionPayload`. `website_url` omitted re-runs extraction against the website already on the org's company profile. Supplying one EXTRACTS A DIFFERENT SITE, which replaces the org's design tokens and homepage capture.
  - `website_url` string, nullable: Site to extract from. Omit to re-extract the org's current website.

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