Create a brand and start its extraction

curl --request POST \
  --url https://brew.new/api/v1/brands \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "url": "acme.com",
  "instructions": "Use the product pages for tone. Primary brand color is the deep navy in the header."
}
'

import requests

url = "https://brew.new/api/v1/brands"

payload = {
    "url": "acme.com",
    "instructions": "Use the product pages for tone. Primary brand color is the deep navy in the header."
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    url: 'acme.com',
    instructions: 'Use the product pages for tone. Primary brand color is the deep navy in the header.'
  })
};

fetch('https://brew.new/api/v1/brands', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://brew.new/api/v1/brands",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'url' => 'acme.com',
    'instructions' => 'Use the product pages for tone. Primary brand color is the deep navy in the header.'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://brew.new/api/v1/brands"

	payload := strings.NewReader("{\n  \"url\": \"acme.com\",\n  \"instructions\": \"Use the product pages for tone. Primary brand color is the deep navy in the header.\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://brew.new/api/v1/brands")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"url\": \"acme.com\",\n  \"instructions\": \"Use the product pages for tone. Primary brand color is the deep navy in the header.\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://brew.new/api/v1/brands")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"url\": \"acme.com\",\n  \"instructions\": \"Use the product pages for tone. Primary brand color is the deep navy in the header.\"\n}"

response = http.request(request)
puts response.read_body

{
  "brandId": "kx9d1p2qbrxy4nkm55ftz3lmvn21abcd",
  "domain": "acme.com",
  "status": "extracting",
  "ready": false,
  "progress": 0,
  "phase": "analyzing",
  "createdAt": "2026-04-08T12:00:00.000Z",
  "updatedAt": "2026-04-08T12:00:00.000Z",
  "extraction": {
    "chatId": "6f1c2b9e-6c2a-4a2e-9f5f-2b7d9a3e4c11",
    "statusUrl": "/v1/brands/kx9d1p2qbrxy4nkm55ftz3lmvn21abcd"
  }
}

Brands

Create a brand and start its extraction

Starts an asynchronous brand extraction that crawls the site and builds the design system. Returns 201 immediately with status: "extracting" — poll GET /v1/brands/{brandId} until ready is true (typically 1–3 minutes) before calling POST /v1/emails, which returns 422 BRAND_NOT_READY until then.

Requires an ORGANIZATION-scoped credential (403 ORG_SCOPE_REQUIRED otherwise) and the brands scope, which is NOT implied by emails.

Extraction requires a non-empty credit balance but is not itself charged to your credits.

POST

brands

Create a brand and start its extraction

curl --request POST \
  --url https://brew.new/api/v1/brands \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "url": "acme.com",
  "instructions": "Use the product pages for tone. Primary brand color is the deep navy in the header."
}
'

import requests

url = "https://brew.new/api/v1/brands"

payload = {
    "url": "acme.com",
    "instructions": "Use the product pages for tone. Primary brand color is the deep navy in the header."
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    url: 'acme.com',
    instructions: 'Use the product pages for tone. Primary brand color is the deep navy in the header.'
  })
};

fetch('https://brew.new/api/v1/brands', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://brew.new/api/v1/brands",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'url' => 'acme.com',
    'instructions' => 'Use the product pages for tone. Primary brand color is the deep navy in the header.'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://brew.new/api/v1/brands"

	payload := strings.NewReader("{\n  \"url\": \"acme.com\",\n  \"instructions\": \"Use the product pages for tone. Primary brand color is the deep navy in the header.\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://brew.new/api/v1/brands")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"url\": \"acme.com\",\n  \"instructions\": \"Use the product pages for tone. Primary brand color is the deep navy in the header.\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://brew.new/api/v1/brands")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"url\": \"acme.com\",\n  \"instructions\": \"Use the product pages for tone. Primary brand color is the deep navy in the header.\"\n}"

response = http.request(request)
puts response.read_body

{
  "brandId": "kx9d1p2qbrxy4nkm55ftz3lmvn21abcd",
  "domain": "acme.com",
  "status": "extracting",
  "ready": false,
  "progress": 0,
  "phase": "analyzing",
  "createdAt": "2026-04-08T12:00:00.000Z",
  "updatedAt": "2026-04-08T12:00:00.000Z",
  "extraction": {
    "chatId": "6f1c2b9e-6c2a-4a2e-9f5f-2b7d9a3e4c11",
    "statusUrl": "/v1/brands/kx9d1p2qbrxy4nkm55ftz3lmvn21abcd"
  }
}

Authorizations

Authorization

string

header

default:Bearer brew_your_api_key

required

Send your Brew API key as Authorization: Bearer brew_xxx.

Headers

Idempotency-Key

string

Optional idempotency key for safe retries. Reusing the same key with the same request body returns the original response for 24 hours.

Required string length: 1 - 100

Body

application/json

url

string

required

Required string length: 1 - 2048

instructions

string

Maximum string length: 4000

includePaths

string[]

Maximum array length: 50

Maximum string length: 2048

excludePaths

string[]

Maximum array length: 50

Maximum string length: 2048

excludeSubdomains

string[]

Maximum array length: 50

Maximum string length: 253

Response

The brand was created and extraction started. Poll extraction.statusUrl.

brandId

string

required

Minimum string length: 1

domain

string

required

Minimum string length: 1

status

enum<string>

required

Available options:

extracting,

completed,

failed,

deleting

ready

boolean

required

extraction

object

required

Show child attributes

progress

integer

Required range: 0 <= x <= 100

phase

string

error

string

createdAt

string<date-time>

updatedAt

string<date-time>

Start Here

REST API

API Contracts

API Guides

MCP server

CLI

SDK Overview

TypeScript SDK

Public API v1

Create a brand and start its extraction

Authorizations

Headers

Body

Response