Agent

Create a standing instruction

Leaves a standing instruction for the shopper, bounded on every side: reorder an item every interval_days (7–365, at most 12 times), or watch for it to come back in stock (back_in_stock) or to reach a price (price_drop) — always at or below max_unit_price per unit. When the condition holds, Galactic Core prepares a hosted checkout intent for the shopper, sends the agent.mandate.triggered webhook event with its confirmation link, and emails the shopper that link under the store’s own name. The shopper confirms; nothing is paid without them, and a prepared checkout stays open for 48 hours. Requires the shopper’s credential and personalization consent. A shopper can keep at most 10 with one store; a mandate pauses if consent is withdrawn.

POST

agent

mandates

curl --request POST \
  --url https://api.tybritelabs.com/v1/agent/me/mandates \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "kind": "reorder",
  "variant_id": "fbe89cdf-90a3-4050-a43b-e4c42302484a",
  "quantity": 2,
  "max_unit_price": 53,
  "interval_days": 30,
  "max_triggers": 6,
  "shipping_address": {
    "name": "John Doe",
    "line1": "350 Fifth Avenue",
    "city": "New York",
    "state": "NY",
    "postal_code": "10118",
    "country": "US"
  }
}
'

import requests

url = "https://api.tybritelabs.com/v1/agent/me/mandates"

payload = {
    "kind": "reorder",
    "variant_id": "fbe89cdf-90a3-4050-a43b-e4c42302484a",
    "quantity": 2,
    "max_unit_price": 53,
    "interval_days": 30,
    "max_triggers": 6,
    "shipping_address": {
        "name": "John Doe",
        "line1": "350 Fifth Avenue",
        "city": "New York",
        "state": "NY",
        "postal_code": "10118",
        "country": "US"
    }
}
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({
    kind: 'reorder',
    variant_id: 'fbe89cdf-90a3-4050-a43b-e4c42302484a',
    quantity: 2,
    max_unit_price: 53,
    interval_days: 30,
    max_triggers: 6,
    shipping_address: {
      name: 'John Doe',
      line1: '350 Fifth Avenue',
      city: 'New York',
      state: 'NY',
      postal_code: '10118',
      country: 'US'
    }
  })
};

fetch('https://api.tybritelabs.com/v1/agent/me/mandates', 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.tybritelabs.com/v1/agent/me/mandates",
  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([
    'kind' => 'reorder',
    'variant_id' => 'fbe89cdf-90a3-4050-a43b-e4c42302484a',
    'quantity' => 2,
    'max_unit_price' => 53,
    'interval_days' => 30,
    'max_triggers' => 6,
    'shipping_address' => [
        'name' => 'John Doe',
        'line1' => '350 Fifth Avenue',
        'city' => 'New York',
        'state' => 'NY',
        'postal_code' => '10118',
        'country' => 'US'
    ]
  ]),
  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://api.tybritelabs.com/v1/agent/me/mandates"

	payload := strings.NewReader("{\n  \"kind\": \"reorder\",\n  \"variant_id\": \"fbe89cdf-90a3-4050-a43b-e4c42302484a\",\n  \"quantity\": 2,\n  \"max_unit_price\": 53,\n  \"interval_days\": 30,\n  \"max_triggers\": 6,\n  \"shipping_address\": {\n    \"name\": \"John Doe\",\n    \"line1\": \"350 Fifth Avenue\",\n    \"city\": \"New York\",\n    \"state\": \"NY\",\n    \"postal_code\": \"10118\",\n    \"country\": \"US\"\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://api.tybritelabs.com/v1/agent/me/mandates")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"kind\": \"reorder\",\n  \"variant_id\": \"fbe89cdf-90a3-4050-a43b-e4c42302484a\",\n  \"quantity\": 2,\n  \"max_unit_price\": 53,\n  \"interval_days\": 30,\n  \"max_triggers\": 6,\n  \"shipping_address\": {\n    \"name\": \"John Doe\",\n    \"line1\": \"350 Fifth Avenue\",\n    \"city\": \"New York\",\n    \"state\": \"NY\",\n    \"postal_code\": \"10118\",\n    \"country\": \"US\"\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.tybritelabs.com/v1/agent/me/mandates")

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  \"kind\": \"reorder\",\n  \"variant_id\": \"fbe89cdf-90a3-4050-a43b-e4c42302484a\",\n  \"quantity\": 2,\n  \"max_unit_price\": 53,\n  \"interval_days\": 30,\n  \"max_triggers\": 6,\n  \"shipping_address\": {\n    \"name\": \"John Doe\",\n    \"line1\": \"350 Fifth Avenue\",\n    \"city\": \"New York\",\n    \"state\": \"NY\",\n    \"postal_code\": \"10118\",\n    \"country\": \"US\"\n  }\n}"

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

{
  "data": {
    "id": "15629aa5-301f-4be2-8e87-e93e01f6c05f",
    "kind": "reorder",
    "status": "active",
    "status_reason": null,
    "product_id": "289533e8-f5b6-4d4f-bb23-2127875feb70",
    "variant_id": "fbe89cdf-90a3-4050-a43b-e4c42302484a",
    "quantity": 2,
    "max_unit_price": 53,
    "currency": "EUR",
    "interval_days": 30,
    "max_triggers": 6,
    "trigger_count": 0,
    "shipping_address": {
      "city": "New York",
      "name": "John Doe",
      "line1": "350 Fifth Avenue",
      "state": "NY",
      "country": "US",
      "postal_code": "10118"
    },
    "next_check_at": "2026-10-31T11:25:06.898103+00:00",
    "last_triggered_at": null,
    "last_intent_id": null,
    "expires_at": "2027-03-30T11:25:06.864+00:00",
    "created_at": "2026-10-01T11:25:06.898103+00:00"
  },
  "evidence": [
    {
      "source": "pricing",
      "operation": "GET /v1/prices/products/{id}",
      "id": "fbe89cdf-90a3-4050-a43b-e4c42302484a",
      "field": "resolved_price"
    },
    {
      "source": "promotions",
      "operation": "POST /v1/promotions/calculate-best",
      "field": "discount"
    },
    {
      "source": "shipping",
      "operation": "shipping quote",
      "field": "fee"
    },
    {
      "source": "tax",
      "operation": "POST /v1/tax/preview",
      "field": "tax_amount"
    },
    {
      "source": "agent",
      "id": "15629aa5-301f-4be2-8e87-e93e01f6c05f",
      "field": "mandate"
    }
  ],
  "computed_at": "2026-10-01T11:25:06.929Z",
  "currency": "EUR",
  "environment": "sandbox"
}

{
  "error": {
    "code": "invalid_request",
    "message": "A reorder needs interval_days from 7 to 365"
  }
}

{
  "error": {
    "code": "unauthorized",
    "message": "Missing or invalid Authorization header"
  }
}

{
  "error": {
    "code": "consent_required",
    "message": "The shopper has not granted personalisation. Ask them to, then call POST /v1/agent/me/consent."
  }
}

{
  "error": {
    "code": "not_found",
    "message": "Resource not found"
  }
}

{
  "error": {
    "code": "mandate_limit",
    "message": "A shopper can keep at most 10 standing instructions with this store",
    "details": {
      "limit": 10
    }
  }
}

{
  "error": {
    "code": "rate_limited",
    "message": "Too many requests for this API key. Please slow down and try again shortly.",
    "remaining": 0,
    "reset": 1706198400
  }
}

{
  "error": {
    "code": "server_error",
    "message": "An unexpected error occurred"
  }
}

Authorizations

Authorization

string

header

required

API Key Authentication

Use your API key in the Authorization header:

Authorization: Bearer tybrite_sk_live_YOUR_KEY

Key Types:

Secret Keys (Server-Side Only):

Format: tybrite_sk_live_* (production) or tybrite_sk_test_* (sandbox)
Full read/write access to all endpoints
⚠️ NEVER expose in client-side code or public repositories
Required for: every write a shopper does not make for themselves, authentication, payment verification, AI recommendations

Publishable Keys (Client-Safe):

Format: tybrite_pk_live_* (production) or tybrite_pk_test_* (sandbox)
Catalogue reads, plus the actions a shopper takes for themselves
✅ Safe for client-side JavaScript, mobile apps, and public code
Allowed for: browsing products, search, CMS content, pricing queries, cart and wishlist, reviews, storefront events, and the Agent API's quotes, cart drafts and checkout intents

Endpoint-Specific Requirements:

Authentication endpoints (/v1/auth/*): Secret key required
Payment verification (POST /v1/payments/verify): Secret key required
AI Recommendations (POST /v1/recommendations): Secret key required
Semantic Search (POST /v1/search): Both key types allowed (read-only operation)
Shopper actions (cart, wishlist, reviews, storefront events, Agent API quotes, cart drafts and checkout intents): Both key types allowed
All other write operations: Secret key required
All read operations: Both key types allowed

Using a publishable key for restricted operations returns 403 Forbidden.

Headers

x-auth-token

string

Customer session token from POST /v1/auth/login or POST /v1/auth/verify-otp. Provide exactly one of x-auth-token, x-external-auth, or x-idp-token.

x-external-auth

string

Bring-your-own-auth assertion identifying the customer. Provide exactly one of x-auth-token, x-external-auth, or x-idp-token.

x-idp-token

string

A raw token from the store's own identity provider, verified by the store's configured Auth verifier. Provide exactly one of x-auth-token, x-external-auth, or x-idp-token.

Body

application/json

kind

enum<string>

required

Available options:

reorder,

price_drop,

back_in_stock

variant_id

string<uuid>

required

max_unit_price

number

required

The most the shopper will pay per unit, in the store's currency.

shipping_address

object

required

Where to deliver: line1 (or latitude/longitude) and country are required.

Show child attributes

quantity

integer

Defaults to 1.

Required range: 1 <= x <= 10

interval_days

integer

Required for reorder; not allowed otherwise.

Required range: 7 <= x <= 365

max_triggers

integer

reorder only: how many times it may fire. Defaults to 1.

Required range: 1 <= x <= 12

expires_in_days

integer

Defaults to 180.

Required range: 1 <= x <= 365

Response

The standing instruction was created

data

object

required

Show child attributes

evidence

object[]

required

computed_at

string<date-time>

required

environment

enum<string>

required

Available options:

production,

sandbox

currency

string | null

Create a standing instruction

curl --request POST \
  --url https://api.tybritelabs.com/v1/agent/me/mandates \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "kind": "reorder",
  "variant_id": "fbe89cdf-90a3-4050-a43b-e4c42302484a",
  "quantity": 2,
  "max_unit_price": 53,
  "interval_days": 30,
  "max_triggers": 6,
  "shipping_address": {
    "name": "John Doe",
    "line1": "350 Fifth Avenue",
    "city": "New York",
    "state": "NY",
    "postal_code": "10118",
    "country": "US"
  }
}
'

import requests

url = "https://api.tybritelabs.com/v1/agent/me/mandates"

payload = {
    "kind": "reorder",
    "variant_id": "fbe89cdf-90a3-4050-a43b-e4c42302484a",
    "quantity": 2,
    "max_unit_price": 53,
    "interval_days": 30,
    "max_triggers": 6,
    "shipping_address": {
        "name": "John Doe",
        "line1": "350 Fifth Avenue",
        "city": "New York",
        "state": "NY",
        "postal_code": "10118",
        "country": "US"
    }
}
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({
    kind: 'reorder',
    variant_id: 'fbe89cdf-90a3-4050-a43b-e4c42302484a',
    quantity: 2,
    max_unit_price: 53,
    interval_days: 30,
    max_triggers: 6,
    shipping_address: {
      name: 'John Doe',
      line1: '350 Fifth Avenue',
      city: 'New York',
      state: 'NY',
      postal_code: '10118',
      country: 'US'
    }
  })
};

fetch('https://api.tybritelabs.com/v1/agent/me/mandates', 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.tybritelabs.com/v1/agent/me/mandates",
  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([
    'kind' => 'reorder',
    'variant_id' => 'fbe89cdf-90a3-4050-a43b-e4c42302484a',
    'quantity' => 2,
    'max_unit_price' => 53,
    'interval_days' => 30,
    'max_triggers' => 6,
    'shipping_address' => [
        'name' => 'John Doe',
        'line1' => '350 Fifth Avenue',
        'city' => 'New York',
        'state' => 'NY',
        'postal_code' => '10118',
        'country' => 'US'
    ]
  ]),
  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://api.tybritelabs.com/v1/agent/me/mandates"

	payload := strings.NewReader("{\n  \"kind\": \"reorder\",\n  \"variant_id\": \"fbe89cdf-90a3-4050-a43b-e4c42302484a\",\n  \"quantity\": 2,\n  \"max_unit_price\": 53,\n  \"interval_days\": 30,\n  \"max_triggers\": 6,\n  \"shipping_address\": {\n    \"name\": \"John Doe\",\n    \"line1\": \"350 Fifth Avenue\",\n    \"city\": \"New York\",\n    \"state\": \"NY\",\n    \"postal_code\": \"10118\",\n    \"country\": \"US\"\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://api.tybritelabs.com/v1/agent/me/mandates")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"kind\": \"reorder\",\n  \"variant_id\": \"fbe89cdf-90a3-4050-a43b-e4c42302484a\",\n  \"quantity\": 2,\n  \"max_unit_price\": 53,\n  \"interval_days\": 30,\n  \"max_triggers\": 6,\n  \"shipping_address\": {\n    \"name\": \"John Doe\",\n    \"line1\": \"350 Fifth Avenue\",\n    \"city\": \"New York\",\n    \"state\": \"NY\",\n    \"postal_code\": \"10118\",\n    \"country\": \"US\"\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.tybritelabs.com/v1/agent/me/mandates")

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  \"kind\": \"reorder\",\n  \"variant_id\": \"fbe89cdf-90a3-4050-a43b-e4c42302484a\",\n  \"quantity\": 2,\n  \"max_unit_price\": 53,\n  \"interval_days\": 30,\n  \"max_triggers\": 6,\n  \"shipping_address\": {\n    \"name\": \"John Doe\",\n    \"line1\": \"350 Fifth Avenue\",\n    \"city\": \"New York\",\n    \"state\": \"NY\",\n    \"postal_code\": \"10118\",\n    \"country\": \"US\"\n  }\n}"

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

{
  "data": {
    "id": "15629aa5-301f-4be2-8e87-e93e01f6c05f",
    "kind": "reorder",
    "status": "active",
    "status_reason": null,
    "product_id": "289533e8-f5b6-4d4f-bb23-2127875feb70",
    "variant_id": "fbe89cdf-90a3-4050-a43b-e4c42302484a",
    "quantity": 2,
    "max_unit_price": 53,
    "currency": "EUR",
    "interval_days": 30,
    "max_triggers": 6,
    "trigger_count": 0,
    "shipping_address": {
      "city": "New York",
      "name": "John Doe",
      "line1": "350 Fifth Avenue",
      "state": "NY",
      "country": "US",
      "postal_code": "10118"
    },
    "next_check_at": "2026-10-31T11:25:06.898103+00:00",
    "last_triggered_at": null,
    "last_intent_id": null,
    "expires_at": "2027-03-30T11:25:06.864+00:00",
    "created_at": "2026-10-01T11:25:06.898103+00:00"
  },
  "evidence": [
    {
      "source": "pricing",
      "operation": "GET /v1/prices/products/{id}",
      "id": "fbe89cdf-90a3-4050-a43b-e4c42302484a",
      "field": "resolved_price"
    },
    {
      "source": "promotions",
      "operation": "POST /v1/promotions/calculate-best",
      "field": "discount"
    },
    {
      "source": "shipping",
      "operation": "shipping quote",
      "field": "fee"
    },
    {
      "source": "tax",
      "operation": "POST /v1/tax/preview",
      "field": "tax_amount"
    },
    {
      "source": "agent",
      "id": "15629aa5-301f-4be2-8e87-e93e01f6c05f",
      "field": "mandate"
    }
  ],
  "computed_at": "2026-10-01T11:25:06.929Z",
  "currency": "EUR",
  "environment": "sandbox"
}

{
  "error": {
    "code": "invalid_request",
    "message": "A reorder needs interval_days from 7 to 365"
  }
}

{
  "error": {
    "code": "unauthorized",
    "message": "Missing or invalid Authorization header"
  }
}

{
  "error": {
    "code": "consent_required",
    "message": "The shopper has not granted personalisation. Ask them to, then call POST /v1/agent/me/consent."
  }
}

{
  "error": {
    "code": "not_found",
    "message": "Resource not found"
  }
}

{
  "error": {
    "code": "mandate_limit",
    "message": "A shopper can keep at most 10 standing instructions with this store",
    "details": {
      "limit": 10
    }
  }
}

{
  "error": {
    "code": "rate_limited",
    "message": "Too many requests for this API key. Please slow down and try again shortly.",
    "remaining": 0,
    "reset": 1706198400
  }
}

{
  "error": {
    "code": "server_error",
    "message": "An unexpected error occurred"
  }
}

Reference

System

Store

Products

Taxonomy

Orders

Payments

Cart & Wishlist

Marketplace

Recommendations

Discovery

Events

Tax

Analytics

Agent

Search

Authentication

Customers

Gift Cards

Promotions

Campaigns

CMS

Pricing

Messaging

Shipping

GC Connect

Reviews

Returns

Disputes

B2B

Webhooks

Ingestion

Feeds

Sandbox

Create a standing instruction

Authorizations

Headers

Body

Response