Skip to main content
POST
/
api
/
public
/
product
/
upsert
/
{promptBlockId}
Upsert products
curl --request POST \
  --url https://api.example.com/api/public/product/upsert/{promptBlockId} \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <x-api-key>' \
  --data '
[
  {
    "name": "<string>",
    "description": "<string>",
    "type": "shopify",
    "currency": "CLP",
    "price": 1,
    "external_id": "<string>",
    "metadata": [
      {
        "key": "<string>",
        "value": "<string>"
      }
    ],
    "file_url": "<string>"
  }
]
'

Headers

​
x-api-key
string
required

API key needed to authorize the request

Path Parameters

​
promptBlockId
string
required

The prompt block ID to upsert the products

Body

application/json

The payload to send with the products

​
name
string
required
Minimum string length: 1
​
description
string
required

In the description you only need to add words that help the AI do a semantic search, avoide placing here prices, links or other type of data that is not natural language

Required string length: 1 - 8192
​
type
enum<string>
required
Available options:
shopify,
vambe,
woocommerce,
axis,
vtex,
jumpseller
​
currency
enum<string>
required
Available options:
CLP,
USD,
MXN,
BRL,
UF,
ARS,
COP,
UYU,
PEN,
EUR,
HNL
​
price
number
required
Required range: x > 0
​
external_id
string
required
​
metadata
object[]
required
​
file_url
string

Response

Products upserted successfully.