Generate an AI product description
curl --request POST \
--url https://production-api.puppetvendors.com/products/ai/description \
--header 'Content-Type: application/json' \
--header 'x-access-token: <api-key>' \
--data '
{
"title": "<string>",
"productType": "<string>",
"tags": [],
"features": [
"<string>"
],
"imageContext": "<string>",
"merchantCustomPrompt": "<string>"
}
'import requests
url = "https://production-api.puppetvendors.com/products/ai/description"
payload = {
"title": "<string>",
"productType": "<string>",
"tags": [],
"features": ["<string>"],
"imageContext": "<string>",
"merchantCustomPrompt": "<string>"
}
headers = {
"x-access-token": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'x-access-token': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
title: '<string>',
productType: '<string>',
tags: [],
features: ['<string>'],
imageContext: '<string>',
merchantCustomPrompt: '<string>'
})
};
fetch('https://production-api.puppetvendors.com/products/ai/description', 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://production-api.puppetvendors.com/products/ai/description",
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([
'title' => '<string>',
'productType' => '<string>',
'tags' => [
],
'features' => [
'<string>'
],
'imageContext' => '<string>',
'merchantCustomPrompt' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-access-token: <api-key>"
],
]);
$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://production-api.puppetvendors.com/products/ai/description"
payload := strings.NewReader("{\n \"title\": \"<string>\",\n \"productType\": \"<string>\",\n \"tags\": [],\n \"features\": [\n \"<string>\"\n ],\n \"imageContext\": \"<string>\",\n \"merchantCustomPrompt\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-access-token", "<api-key>")
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://production-api.puppetvendors.com/products/ai/description")
.header("x-access-token", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"title\": \"<string>\",\n \"productType\": \"<string>\",\n \"tags\": [],\n \"features\": [\n \"<string>\"\n ],\n \"imageContext\": \"<string>\",\n \"merchantCustomPrompt\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://production-api.puppetvendors.com/products/ai/description")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-access-token"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"title\": \"<string>\",\n \"productType\": \"<string>\",\n \"tags\": [],\n \"features\": [\n \"<string>\"\n ],\n \"imageContext\": \"<string>\",\n \"merchantCustomPrompt\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"data": "<unknown>"
}{
"success": false,
"error": {
"message": "Resource not found",
"code": "NOT_FOUND",
"errorId": "err_1783365360839_j281w7b",
"details": {}
}
}{
"success": false,
"error": {
"message": "Resource not found",
"code": "NOT_FOUND",
"errorId": "err_1783365360839_j281w7b",
"details": {}
}
}{
"success": false,
"error": {
"message": "Resource not found",
"code": "NOT_FOUND",
"errorId": "err_1783365360839_j281w7b",
"details": {}
}
}{
"success": false,
"error": {
"message": "Resource not found",
"code": "NOT_FOUND",
"errorId": "err_1783365360839_j281w7b",
"details": {}
}
}{
"success": false,
"error": {
"message": "Resource not found",
"code": "NOT_FOUND",
"errorId": "err_1783365360839_j281w7b",
"details": {}
}
}Products
Generate an AI product description
Write a product description with AI. Uses your store’s AI credits. Returns 403 FEATURE_DISABLED when AI descriptions are turned off. Requires the admin:products:write permission.
POST
/
products
/
ai
/
description
Generate an AI product description
curl --request POST \
--url https://production-api.puppetvendors.com/products/ai/description \
--header 'Content-Type: application/json' \
--header 'x-access-token: <api-key>' \
--data '
{
"title": "<string>",
"productType": "<string>",
"tags": [],
"features": [
"<string>"
],
"imageContext": "<string>",
"merchantCustomPrompt": "<string>"
}
'import requests
url = "https://production-api.puppetvendors.com/products/ai/description"
payload = {
"title": "<string>",
"productType": "<string>",
"tags": [],
"features": ["<string>"],
"imageContext": "<string>",
"merchantCustomPrompt": "<string>"
}
headers = {
"x-access-token": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'x-access-token': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
title: '<string>',
productType: '<string>',
tags: [],
features: ['<string>'],
imageContext: '<string>',
merchantCustomPrompt: '<string>'
})
};
fetch('https://production-api.puppetvendors.com/products/ai/description', 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://production-api.puppetvendors.com/products/ai/description",
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([
'title' => '<string>',
'productType' => '<string>',
'tags' => [
],
'features' => [
'<string>'
],
'imageContext' => '<string>',
'merchantCustomPrompt' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-access-token: <api-key>"
],
]);
$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://production-api.puppetvendors.com/products/ai/description"
payload := strings.NewReader("{\n \"title\": \"<string>\",\n \"productType\": \"<string>\",\n \"tags\": [],\n \"features\": [\n \"<string>\"\n ],\n \"imageContext\": \"<string>\",\n \"merchantCustomPrompt\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-access-token", "<api-key>")
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://production-api.puppetvendors.com/products/ai/description")
.header("x-access-token", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"title\": \"<string>\",\n \"productType\": \"<string>\",\n \"tags\": [],\n \"features\": [\n \"<string>\"\n ],\n \"imageContext\": \"<string>\",\n \"merchantCustomPrompt\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://production-api.puppetvendors.com/products/ai/description")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-access-token"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"title\": \"<string>\",\n \"productType\": \"<string>\",\n \"tags\": [],\n \"features\": [\n \"<string>\"\n ],\n \"imageContext\": \"<string>\",\n \"merchantCustomPrompt\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"data": "<unknown>"
}{
"success": false,
"error": {
"message": "Resource not found",
"code": "NOT_FOUND",
"errorId": "err_1783365360839_j281w7b",
"details": {}
}
}{
"success": false,
"error": {
"message": "Resource not found",
"code": "NOT_FOUND",
"errorId": "err_1783365360839_j281w7b",
"details": {}
}
}{
"success": false,
"error": {
"message": "Resource not found",
"code": "NOT_FOUND",
"errorId": "err_1783365360839_j281w7b",
"details": {}
}
}{
"success": false,
"error": {
"message": "Resource not found",
"code": "NOT_FOUND",
"errorId": "err_1783365360839_j281w7b",
"details": {}
}
}{
"success": false,
"error": {
"message": "Resource not found",
"code": "NOT_FOUND",
"errorId": "err_1783365360839_j281w7b",
"details": {}
}
}Authorizations
JWT minted from a merchant API key (mk_live_…) by POST /authenticate. Send the token value directly, with no "Bearer" prefix. Tokens last 14 days and can be renewed at POST /refresh-token; revoking the key refuses the next request made with any token minted from it.
Body
application/json
Was this page helpful?