Get design.md - Sequenzy

GET

api

design-md

Get design.md

curl --request GET \
  --url https://api.sequenzy.com/api/v1/design-md \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.sequenzy.com/api/v1/design-md', 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://api.sequenzy.com/api/v1/design-md",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

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

curl_close($curl);

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

package main

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

func main() {

	url := "https://api.sequenzy.com/api/v1/design-md"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

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

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

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.sequenzy.com/api/v1/design-md")

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

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

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

{
  "success": true,
  "markdown": "---\n# Exact values Sequenzy applies when it renders AI-generated emails.\n# Change a value to pin it. Untouched values are not saved.\nlogo: \"https://acme.com/logo.png\"\ncolors:\n  primary: \"#1f4fff\"\n  background: \"#f4f4f5\"\n  text: \"#18181b\"\nfonts:\n  body: \"Inter, Arial, sans-serif\"\n  heading: null\nbuttons:\n  style: solid\n  radius: 8\ncornerRadius: 8\nlayout:\n  spine: editorial\n  kicker: letterspaced\n  titleAlignment: left\n  buttonShape: rounded\n  dividers: line\n  density: airy\n  openers: [editorial-masthead, title-led]\n---\n\n# Acme email design\n\n## Voice\n\nPlain and direct. Setup steps first.\n\n## Design direction\n\nEditorial and calm. One idea per email.\n\n## Reference email\n\nNone. Save an email as your AI style from the email editor to have new emails copy its look. This section is read-only.\n",
  "version": "3f9a2c1d8e7b6a50",
  "designSystem": {
    "version": 1,
    "designCode": {
      "version": 1,
      "kickerStyle": "letterspaced",
      "titleAlignment": "left",
      "buttonShape": "rounded",
      "dividerStyle": "line",
      "density": "airy",
      "openerTreatments": ["editorial-masthead", "title-led"]
    },
    "compositionSpine": "editorial",
    "source": "custom"
  }
}

{ "error": "Invalid API key format" }

{
  "success": false,
  "error": "Company not found",
  "code": "DESIGN_MD_NOT_FOUND"
}

Get the company’s design.md: the brief Sequenzy AI follows when it writes and designs emails, in one Markdown document you can read, edit and save back with Update design.md. design.md is a view over the company’s existing brand settings, not a separate copy. Changes you make to the theme, voice or design direction anywhere else show up here, and saving design.md updates those same settings.

Document format

The YAML frontmatter between the --- lines holds exact values. They are the values your AI-generated emails actually get, including the corner radius and heading font that layout defaults pick when your brand does not set them.

Key	Values
`logo`	Logo image URL, or `null`
`colors`	Hex colors: `primary`, `background`, `content`, `surface`, `text`, `heading`, `mutedText`, `link`, `border`, `buttonText`
`fonts.body`	Body font name or CSS font stack
`fonts.heading`	Heading font, or `null` to use the body font
`buttons.style`	`solid` or `outline`
`buttons.radius`	Button corner radius in pixels (0 to 9999)
`cornerRadius`	Corner radius of cards and images in pixels (0 to 9999)
`layout.spine`	`hero-led`, `editorial`, or `product-spec`
`layout.kicker`	`chip`, `letterspaced`, or `none`
`layout.titleAlignment`	`left` or `center`
`layout.buttonShape`	`rounded` or `pill`
`layout.dividers`	`line` or `space`
`layout.density`	`airy` or `compact`
`layout.openers`	List of `hero-image`, `hero-color`, `header-hero`, `editorial-masthead`, `title-led`

The body has three sections:

## Voice: how emails are written. This is the company’s tone of voice.
## Design direction: how emails are designed, in your own words. The layout tokens above are parsed from this text, so it can say things like “pill buttons” too.
## Reference email: the email saved as your AI style, if any. Read-only here; change it from the email editor or Email AI Style.

Request

curl "https://api.sequenzy.com/api/v1/design-md" \
  -H "Authorization: Bearer YOUR_API_KEY"

Requires the account:read scope.

Response fields

string

The full design.md document.

string

Content version. Pass it as expectedVersion when you save, so the save fails instead of overwriting a change someone else made in between.

object

The layout tokens parsed from the design direction: designCode, compositionSpine, and source (derived while every token still comes from your brand, custom once the direction text sets them). Same shape as Get Email Design System.

Responses

{
  "success": true,
  "markdown": "---\n# Exact values Sequenzy applies when it renders AI-generated emails.\n# Change a value to pin it. Untouched values are not saved.\nlogo: \"https://acme.com/logo.png\"\ncolors:\n  primary: \"#1f4fff\"\n  background: \"#f4f4f5\"\n  text: \"#18181b\"\nfonts:\n  body: \"Inter, Arial, sans-serif\"\n  heading: null\nbuttons:\n  style: solid\n  radius: 8\ncornerRadius: 8\nlayout:\n  spine: editorial\n  kicker: letterspaced\n  titleAlignment: left\n  buttonShape: rounded\n  dividers: line\n  density: airy\n  openers: [editorial-masthead, title-led]\n---\n\n# Acme email design\n\n## Voice\n\nPlain and direct. Setup steps first.\n\n## Design direction\n\nEditorial and calm. One idea per email.\n\n## Reference email\n\nNone. Save an email as your AI style from the email editor to have new emails copy its look. This section is read-only.\n",
  "version": "3f9a2c1d8e7b6a50",
  "designSystem": {
    "version": 1,
    "designCode": {
      "version": 1,
      "kickerStyle": "letterspaced",
      "titleAlignment": "left",
      "buttonShape": "rounded",
      "dividerStyle": "line",
      "density": "airy",
      "openerTreatments": ["editorial-masthead", "title-led"]
    },
    "compositionSpine": "editorial",
    "source": "custom"
  }
}

{ "error": "Invalid API key format" }

{
  "success": false,
  "error": "Company not found",
  "code": "DESIGN_MD_NOT_FOUND"
}

Get design.md

curl --request GET \
  --url https://api.sequenzy.com/api/v1/design-md \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.sequenzy.com/api/v1/design-md', 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://api.sequenzy.com/api/v1/design-md",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

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

curl_close($curl);

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

package main

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

func main() {

	url := "https://api.sequenzy.com/api/v1/design-md"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

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

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

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.sequenzy.com/api/v1/design-md")

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

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

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

{
  "success": true,
  "markdown": "---\n# Exact values Sequenzy applies when it renders AI-generated emails.\n# Change a value to pin it. Untouched values are not saved.\nlogo: \"https://acme.com/logo.png\"\ncolors:\n  primary: \"#1f4fff\"\n  background: \"#f4f4f5\"\n  text: \"#18181b\"\nfonts:\n  body: \"Inter, Arial, sans-serif\"\n  heading: null\nbuttons:\n  style: solid\n  radius: 8\ncornerRadius: 8\nlayout:\n  spine: editorial\n  kicker: letterspaced\n  titleAlignment: left\n  buttonShape: rounded\n  dividers: line\n  density: airy\n  openers: [editorial-masthead, title-led]\n---\n\n# Acme email design\n\n## Voice\n\nPlain and direct. Setup steps first.\n\n## Design direction\n\nEditorial and calm. One idea per email.\n\n## Reference email\n\nNone. Save an email as your AI style from the email editor to have new emails copy its look. This section is read-only.\n",
  "version": "3f9a2c1d8e7b6a50",
  "designSystem": {
    "version": 1,
    "designCode": {
      "version": 1,
      "kickerStyle": "letterspaced",
      "titleAlignment": "left",
      "buttonShape": "rounded",
      "dividerStyle": "line",
      "density": "airy",
      "openerTreatments": ["editorial-masthead", "title-led"]
    },
    "compositionSpine": "editorial",
    "source": "custom"
  }
}

{ "error": "Invalid API key format" }

{
  "success": false,
  "error": "Company not found",
  "code": "DESIGN_MD_NOT_FOUND"
}

​Document format

​Request

​Response fields

​Responses

Document format

Request

Response fields

Responses