curl --request POST \
--url https://brew.new/api/v1/payload-contracts/infer \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"example": {
"email": "jane@example.com",
"order": {
"total": 9.5,
"placedAt": "2026-04-08T12:00:00.000Z"
}
}
}
'import requests
url = "https://brew.new/api/v1/payload-contracts/infer"
payload = { "example": {
"email": "jane@example.com",
"order": {
"total": 9.5,
"placedAt": "2026-04-08T12:00:00.000Z"
}
} }
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({
example: {
email: 'jane@example.com',
order: {total: 9.5, placedAt: '2026-04-08T12:00:00.000Z'}
}
})
};
fetch('https://brew.new/api/v1/payload-contracts/infer', 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/payload-contracts/infer",
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([
'example' => [
'email' => 'jane@example.com',
'order' => [
'total' => 9.5,
'placedAt' => '2026-04-08T12:00:00.000Z'
]
]
]),
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/payload-contracts/infer"
payload := strings.NewReader("{\n \"example\": {\n \"email\": \"jane@example.com\",\n \"order\": {\n \"total\": 9.5,\n \"placedAt\": \"2026-04-08T12:00:00.000Z\"\n }\n }\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/payload-contracts/infer")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"example\": {\n \"email\": \"jane@example.com\",\n \"order\": {\n \"total\": 9.5,\n \"placedAt\": \"2026-04-08T12:00:00.000Z\"\n }\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://brew.new/api/v1/payload-contracts/infer")
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 \"example\": {\n \"email\": \"jane@example.com\",\n \"order\": {\n \"total\": 9.5,\n \"placedAt\": \"2026-04-08T12:00:00.000Z\"\n }\n }\n}"
response = http.request(request)
puts response.read_body{
"fields": [
{
"key": "email",
"type": "string",
"required": true
},
{
"key": "order",
"type": "object",
"required": true,
"children": [
{
"key": "total",
"type": "float",
"required": true
},
{
"key": "placedAt",
"type": "date",
"required": true
}
]
}
],
"issues": []
}{
"error": {
"code": "INVALID_REQUEST",
"type": "invalid_request",
"message": "Request validation failed.",
"suggestion": "Fix the field reported in `param` and retry.",
"docs": "https://docs.brew.new/api-reference/api/errors",
"param": "example"
}
}{
"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_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": "automations"
}
}{
"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"
}
}Infer a payload contract from an example
Drafts a contract from a real example payload: paste the JSON your system sends and get back typed fields — integers and floats split automatically, full ISO timestamps become date, object/array shapes are walked recursively. Every inferred field is required: true (relax explicitly).
Spots inference cannot type (nulls, empty arrays) degrade honestly and are listed in issues with the offending path. Nothing is saved: review the draft, then PUT it to …/triggers/{triggerEventId}/contract.
curl --request POST \
--url https://brew.new/api/v1/payload-contracts/infer \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"example": {
"email": "jane@example.com",
"order": {
"total": 9.5,
"placedAt": "2026-04-08T12:00:00.000Z"
}
}
}
'import requests
url = "https://brew.new/api/v1/payload-contracts/infer"
payload = { "example": {
"email": "jane@example.com",
"order": {
"total": 9.5,
"placedAt": "2026-04-08T12:00:00.000Z"
}
} }
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({
example: {
email: 'jane@example.com',
order: {total: 9.5, placedAt: '2026-04-08T12:00:00.000Z'}
}
})
};
fetch('https://brew.new/api/v1/payload-contracts/infer', 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/payload-contracts/infer",
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([
'example' => [
'email' => 'jane@example.com',
'order' => [
'total' => 9.5,
'placedAt' => '2026-04-08T12:00:00.000Z'
]
]
]),
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/payload-contracts/infer"
payload := strings.NewReader("{\n \"example\": {\n \"email\": \"jane@example.com\",\n \"order\": {\n \"total\": 9.5,\n \"placedAt\": \"2026-04-08T12:00:00.000Z\"\n }\n }\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/payload-contracts/infer")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"example\": {\n \"email\": \"jane@example.com\",\n \"order\": {\n \"total\": 9.5,\n \"placedAt\": \"2026-04-08T12:00:00.000Z\"\n }\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://brew.new/api/v1/payload-contracts/infer")
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 \"example\": {\n \"email\": \"jane@example.com\",\n \"order\": {\n \"total\": 9.5,\n \"placedAt\": \"2026-04-08T12:00:00.000Z\"\n }\n }\n}"
response = http.request(request)
puts response.read_body{
"fields": [
{
"key": "email",
"type": "string",
"required": true
},
{
"key": "order",
"type": "object",
"required": true,
"children": [
{
"key": "total",
"type": "float",
"required": true
},
{
"key": "placedAt",
"type": "date",
"required": true
}
]
}
],
"issues": []
}{
"error": {
"code": "INVALID_REQUEST",
"type": "invalid_request",
"message": "Request validation failed.",
"suggestion": "Fix the field reported in `param` and retry.",
"docs": "https://docs.brew.new/api-reference/api/errors",
"param": "example"
}
}{
"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_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": "automations"
}
}{
"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"
}
}Authorizations
Send your Brew API key as Authorization: Bearer brew_xxx.
Headers
The brand this request acts on. REQUIRED for organization-scoped credentials (otherwise 400 BRAND_ID_REQUIRED — there is no default brand); list ids with GET /v1/brands. Brand-scoped credentials may omit it, and sending a different brand returns 403 BRAND_SCOPE_MISMATCH. A brand outside your organization returns 404 BRAND_NOT_FOUND.
1 - 64Body
Was this page helpful?