Skip to main content
POST
/
v1
/
emails
/
{emailId}
/
accessibility-audit
Accessibility audit
curl --request POST \
  --url https://brew.new/api/v1/emails/{emailId}/accessibility-audit \
  --header 'Authorization: Bearer <token>'
import requests

url = "https://brew.new/api/v1/emails/{emailId}/accessibility-audit"

headers = {"Authorization": "Bearer <token>"}

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

print(response.text)
const options = {method: 'POST', headers: {Authorization: 'Bearer <token>'}};

fetch('https://brew.new/api/v1/emails/{emailId}/accessibility-audit', 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/emails/{emailId}/accessibility-audit",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  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://brew.new/api/v1/emails/{emailId}/accessibility-audit"

	req, _ := http.NewRequest("POST", 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))

}
HttpResponse<String> response = Unirest.post("https://brew.new/api/v1/emails/{emailId}/accessibility-audit")
  .header("Authorization", "Bearer <token>")
  .asString();
require 'uri'
require 'net/http'

url = URI("https://brew.new/api/v1/emails/{emailId}/accessibility-audit")

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

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

response = http.request(request)
puts response.read_body
{
  "score": 90,
  "summary": {
    "errors": 1,
    "warnings": 0
  },
  "issues": [
    {
      "rule": "img-alt",
      "severity": "error",
      "wcag": "1.1.1",
      "message": "Image is missing an alt attribute. Add descriptive alt text, or alt=\"\" if it is purely decorative.",
      "element": "<img src=\"https://cdn.brew.new/hero.png\">"
    }
  ]
}
{
  "error": {
    "code": "INVALID_API_KEY",
    "type": "authentication_error",
    "message": "The provided API key is invalid.",
    "suggestion": "Check the API key format and retry with a valid active key.",
    "docs": "https://docs.brew.new/api-reference/api/authentication"
  }
}
{
  "error": {
    "code": "INSUFFICIENT_CREDITS",
    "type": "payment_required",
    "message": "This operation required more credits than the 0 remaining on the 'free' plan. See the per-operation cost in GET /v1/help.",
    "suggestion": "Upgrade your plan or wait for the next billing period to reset. Check your balance up front with GET /v1/usage.",
    "docs": "https://docs.brew.new/api-reference/api/credits",
    "details": {
      "cost": 2,
      "remaining": 0,
      "planKey": "free"
    }
  }
}
{
  "error": {
    "code": "INSUFFICIENT_PERMISSIONS",
    "type": "authorization_error",
    "message": "The caller does not have the required permission.",
    "suggestion": "Use an API key or session with the required permission.",
    "docs": "https://docs.brew.new/api-reference/api/authentication",
    "param": "emails"
  }
}
{
  "error": {
    "code": "EMAIL_NOT_FOUND",
    "type": "not_found",
    "message": "No email exists with id 'eml_welcome'.",
    "suggestion": "Verify the emailId via GET /v1/emails.",
    "docs": "https://docs.brew.new/api-reference/api/errors"
  }
}
{
  "error": {
    "code": "CONTENT_OPERATION_FAILED",
    "type": "invalid_request",
    "message": "accessibility-audit failed: the email has no rendered HTML yet.",
    "suggestion": "Poll GET /v1/emails?emailId= until status is complete, then retry.",
    "docs": "https://docs.brew.new/api-reference/api/errors"
  }
}
{
  "error": {
    "code": "RATE_LIMITED",
    "type": "rate_limit",
    "message": "Too many requests.",
    "suggestion": "Wait for the retry window before sending another request.",
    "docs": "https://docs.brew.new/api-reference/api/rate-limits",
    "retryAfter": 42
  }
}
{
  "error": {
    "code": "INTERNAL_ERROR",
    "type": "internal_error",
    "message": "An unexpected error occurred.",
    "suggestion": "Retry the request. If it keeps failing, contact support.",
    "docs": "https://docs.brew.new/api-reference/api/errors"
  }
}
{
  "error": {
    "code": "SERVICE_UNAVAILABLE",
    "type": "service_unavailable",
    "message": "Your credit balance could not be verified because a billing dependency is temporarily unavailable.",
    "suggestion": "Retry the request after a short delay.",
    "docs": "https://docs.brew.new/api-reference/api/credits",
    "retryAfter": 2
  }
}

Authorizations

Authorization
string
header
default:Bearer brew_your_api_key
required

Send your Brew API key as Authorization: Bearer brew_xxx.

Path Parameters

emailId
string
required

Design id returned by POST /v1/emails and listed by GET /v1/emails.

Required string length: 1 - 64
Example:

"eml_2SmZOWV3ZQ7W5x6g3m4p"

Response

The audit result.

score
integer
required
Required range: 0 <= x <= 100
summary
object
required
issues
object[]
required