Post Intent Find And Add

curl --request POST \
  --url https://api.example.com/api/agent/intent/find-and-add \
  --header 'Content-Type: application/json' \
  --header 'X-Site-ID: <x-site-id>' \
  --data '
{
  "query": "<string>",
  "quantity": 1,
  "max_unit_price_cents": 5000000
}
'

import requests

url = "https://api.example.com/api/agent/intent/find-and-add"

payload = {
    "query": "<string>",
    "quantity": 1,
    "max_unit_price_cents": 5000000
}
headers = {
    "X-Site-ID": "<x-site-id>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {'X-Site-ID': '<x-site-id>', 'Content-Type': 'application/json'},
  body: JSON.stringify({query: '<string>', quantity: 1, max_unit_price_cents: 5000000})
};

fetch('https://api.example.com/api/agent/intent/find-and-add', 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.example.com/api/agent/intent/find-and-add",
  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([
    'query' => '<string>',
    'quantity' => 1,
    'max_unit_price_cents' => 5000000
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "X-Site-ID: <x-site-id>"
  ],
]);

$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.example.com/api/agent/intent/find-and-add"

	payload := strings.NewReader("{\n  \"query\": \"<string>\",\n  \"quantity\": 1,\n  \"max_unit_price_cents\": 5000000\n}")

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

	req.Header.Add("X-Site-ID", "<x-site-id>")
	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.example.com/api/agent/intent/find-and-add")
  .header("X-Site-ID", "<x-site-id>")
  .header("Content-Type", "application/json")
  .body("{\n  \"query\": \"<string>\",\n  \"quantity\": 1,\n  \"max_unit_price_cents\": 5000000\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.example.com/api/agent/intent/find-and-add")

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

request = Net::HTTP::Post.new(url)
request["X-Site-ID"] = '<x-site-id>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"query\": \"<string>\",\n  \"quantity\": 1,\n  \"max_unit_price_cents\": 5000000\n}"

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

{
  "cart": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "currency": "<string>",
    "items": [
      {
        "variant_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "product_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "product_name": "<string>",
        "quantity": 123,
        "price_cents": 123,
        "line_total_cents": 123,
        "variant_name": "<string>",
        "sku": "<string>"
      }
    ],
    "subtotal_cents": 123,
    "item_count": 123,
    "summary_for_llm": "<string>"
  },
  "chosen": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "name": "<string>",
    "slug": "<string>",
    "description": "<string>",
    "vendor": "<string>",
    "product_type": "<string>",
    "tags": [
      "<string>"
    ],
    "image_url": "<string>",
    "price_min_cents": 123,
    "price_max_cents": 123,
    "currency": "<string>",
    "in_stock": true,
    "total_inventory": 123,
    "variant_count": 123,
    "variants": [
      {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "title": "<string>",
        "price_cents": 123,
        "options": {},
        "inventory_quantity": 123,
        "in_stock": true,
        "sku": "<string>"
      }
    ],
    "summary_for_llm": "<string>"
  },
  "chosen_variant_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "quantity_added": 123,
  "match_reasons": [
    "<string>"
  ],
  "reasoning": "<string>"
}

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>",
      "input": "<unknown>",
      "ctx": {}
    }
  ]
}

POST

api

agent

intent

find-and-add

Post Intent Find And Add

curl --request POST \
  --url https://api.example.com/api/agent/intent/find-and-add \
  --header 'Content-Type: application/json' \
  --header 'X-Site-ID: <x-site-id>' \
  --data '
{
  "query": "<string>",
  "quantity": 1,
  "max_unit_price_cents": 5000000
}
'

import requests

url = "https://api.example.com/api/agent/intent/find-and-add"

payload = {
    "query": "<string>",
    "quantity": 1,
    "max_unit_price_cents": 5000000
}
headers = {
    "X-Site-ID": "<x-site-id>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {'X-Site-ID': '<x-site-id>', 'Content-Type': 'application/json'},
  body: JSON.stringify({query: '<string>', quantity: 1, max_unit_price_cents: 5000000})
};

fetch('https://api.example.com/api/agent/intent/find-and-add', 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.example.com/api/agent/intent/find-and-add",
  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([
    'query' => '<string>',
    'quantity' => 1,
    'max_unit_price_cents' => 5000000
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "X-Site-ID: <x-site-id>"
  ],
]);

$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.example.com/api/agent/intent/find-and-add"

	payload := strings.NewReader("{\n  \"query\": \"<string>\",\n  \"quantity\": 1,\n  \"max_unit_price_cents\": 5000000\n}")

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

	req.Header.Add("X-Site-ID", "<x-site-id>")
	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.example.com/api/agent/intent/find-and-add")
  .header("X-Site-ID", "<x-site-id>")
  .header("Content-Type", "application/json")
  .body("{\n  \"query\": \"<string>\",\n  \"quantity\": 1,\n  \"max_unit_price_cents\": 5000000\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.example.com/api/agent/intent/find-and-add")

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

request = Net::HTTP::Post.new(url)
request["X-Site-ID"] = '<x-site-id>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"query\": \"<string>\",\n  \"quantity\": 1,\n  \"max_unit_price_cents\": 5000000\n}"

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

{
  "cart": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "currency": "<string>",
    "items": [
      {
        "variant_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "product_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "product_name": "<string>",
        "quantity": 123,
        "price_cents": 123,
        "line_total_cents": 123,
        "variant_name": "<string>",
        "sku": "<string>"
      }
    ],
    "subtotal_cents": 123,
    "item_count": 123,
    "summary_for_llm": "<string>"
  },
  "chosen": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "name": "<string>",
    "slug": "<string>",
    "description": "<string>",
    "vendor": "<string>",
    "product_type": "<string>",
    "tags": [
      "<string>"
    ],
    "image_url": "<string>",
    "price_min_cents": 123,
    "price_max_cents": 123,
    "currency": "<string>",
    "in_stock": true,
    "total_inventory": 123,
    "variant_count": 123,
    "variants": [
      {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "title": "<string>",
        "price_cents": 123,
        "options": {},
        "inventory_quantity": 123,
        "in_stock": true,
        "sku": "<string>"
      }
    ],
    "summary_for_llm": "<string>"
  },
  "chosen_variant_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "quantity_added": 123,
  "match_reasons": [
    "<string>"
  ],
  "reasoning": "<string>"
}

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>",
      "input": "<unknown>",
      "ctx": {}
    }
  ]
}

Headers

X-Site-ID

string

required

authorization

string | null

Body

application/json

Agent → Stella: POST /api/agent/intent/find-and-add.

Run a natural-language intent through the search engine, pick the best match (top-ranked, in-stock, cheapest variant by default), and put it in a fresh cart owned by the agent's customer.

query

string

required

Required string length: 1 - 512

quantity

integer

default:1

Number of units to add. Capped at 10 — agents that need bulk should call find-and-add multiple times so each decision shows up in the audit trail.

Required range: 1 <= x <= 10

max_unit_price_cents

integer | null

Optional ceiling — if the cheapest matching variant exceeds this, the call returns 404 with no_affordable_match instead of adding it. Use to enforce 'under £30' style intents.

Required range: 0 <= x <= 10000000

Response

Successful Response

Response shape for POST /api/agent/intent/find-and-add.

Includes the chosen product + variant so the agent doesn't need a follow-up call to render a confirmation message; the cart summary makes the impact visible at a glance.

cart

AgentCart · object

required

LLM-shape cart snapshot. Mirrors the storefront cart but in integer-cents currency and with summary_for_llm for the one-line agent-readable digest.

Show child attributes

chosen

AgentCatalogProduct · object

required

LLM-shape product.

summary_for_llm is the single-paragraph natural-language summary an LLM can read to decide if this matches a user's intent. The structured fields below it are for follow-up calls (cart adds, detail renders) and reasoning attribution. Keep this shape FLAT — LLMs handle nesting poorly.

Show child attributes

chosen_variant_id

string<uuid>

required

quantity_added

integer

required

match_reasons

string[]

required

reasoning

string

required

Dashboard

Storefront

Sync

Sync v1

Webhooks

Agent

API Reference

Post Intent Find And Add

Headers

Body

Response