Topics & Prompts
Batch create topics & prompts
Create multiple topics and prompts in a single request.
POST
/
v1
/
brands
/
{brandId}
/
topics-prompts
/
batch
Batch create topics & prompts
curl --request POST \
--url https://api.example.com/v1/brands/{brandId}/topics-prompts/batch \
--header 'Content-Type: application/json' \
--data '
{
"topics": [
{}
]
}
'import requests
url = "https://api.example.com/v1/brands/{brandId}/topics-prompts/batch"
payload = { "topics": [{}] }
headers = {"Content-Type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({topics: [{}]})
};
fetch('https://api.example.com/v1/brands/{brandId}/topics-prompts/batch', 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/v1/brands/{brandId}/topics-prompts/batch",
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([
'topics' => [
[
]
]
]),
CURLOPT_HTTPHEADER => [
"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.example.com/v1/brands/{brandId}/topics-prompts/batch"
payload := strings.NewReader("{\n \"topics\": [\n {}\n ]\n}")
req, _ := http.NewRequest("POST", url, payload)
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/v1/brands/{brandId}/topics-prompts/batch")
.header("Content-Type", "application/json")
.body("{\n \"topics\": [\n {}\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/v1/brands/{brandId}/topics-prompts/batch")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"topics\": [\n {}\n ]\n}"
response = http.request(request)
puts response.read_bodyThe recommended way to add prompts. One call can create new topics, add prompts to those new topics, and also add prompts to existing topics — all at once.
Path parameters
Brand UUID. Obtain from List brands.
Request body
Array of topics. Each topic can be new (provide
name) or existing (provide id).Show TopicInput — new topic
Show TopicInput — new topic
Show TopicInput — existing topic
Show TopicInput — existing topic
Show PromptInput
Show PromptInput
Request
curl -s -X POST \
-H "x-spotlight-api-key: YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"topics": [
{
"name": "Pricing",
"prompts": [
{ "text": "How does the pricing compare to alternatives?", "customerJourney": "consideration" },
{ "text": "Is there a free tier available?" }
]
},
{
"id": "existing-topic-uuid",
"prompts": [
{ "text": "What do customers say about support response times?" }
]
}
]
}' \
"https://app.get-spotlight.com/api/v1/brands/BRAND_ID/topics-prompts/batch"
import requests
payload = {
"topics": [
{
"name": "Pricing",
"prompts": [
{"text": "How does the pricing compare to alternatives?", "customerJourney": "consideration"},
],
},
{
"id": "existing-topic-uuid",
"prompts": [{"text": "What do customers say about support?"}],
},
]
}
r = requests.post(
"https://app.get-spotlight.com/api/v1/brands/BRAND_ID/topics-prompts/batch",
headers={"x-spotlight-api-key": "YOUR_API_KEY"},
json=payload,
)
print(r.json())
Response
{
"topics": [
{ "id": "new-topic-uuid", "name": "Pricing", "prompts": [] }
],
"remainingSlots": 87,
"promptLimit": 100,
"orgWideLimit": 500,
"orgTotalPrompts": 413
}
Errors
409 — prompt limit exceeded:
{
"message": "Prompt limit exceeded",
"code": "prompt_limit_exceeded",
"remainingSlots": 0,
"promptLimit": 100,
"orgWideLimit": 500,
"orgTotalPrompts": 500
}
⌘I
Batch create topics & prompts
curl --request POST \
--url https://api.example.com/v1/brands/{brandId}/topics-prompts/batch \
--header 'Content-Type: application/json' \
--data '
{
"topics": [
{}
]
}
'import requests
url = "https://api.example.com/v1/brands/{brandId}/topics-prompts/batch"
payload = { "topics": [{}] }
headers = {"Content-Type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({topics: [{}]})
};
fetch('https://api.example.com/v1/brands/{brandId}/topics-prompts/batch', 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/v1/brands/{brandId}/topics-prompts/batch",
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([
'topics' => [
[
]
]
]),
CURLOPT_HTTPHEADER => [
"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.example.com/v1/brands/{brandId}/topics-prompts/batch"
payload := strings.NewReader("{\n \"topics\": [\n {}\n ]\n}")
req, _ := http.NewRequest("POST", url, payload)
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/v1/brands/{brandId}/topics-prompts/batch")
.header("Content-Type", "application/json")
.body("{\n \"topics\": [\n {}\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/v1/brands/{brandId}/topics-prompts/batch")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"topics\": [\n {}\n ]\n}"
response = http.request(request)
puts response.read_body