curl --request POST \
--url https://data.otterly.ai/v1/workspaces/{id}/prompts \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"prompts": [
"best running shoes",
"best trail shoes"
],
"country": "us",
"tagIds": []
}
'import requests
url = "https://data.otterly.ai/v1/workspaces/{id}/prompts"
payload = {
"prompts": ["best running shoes", "best trail shoes"],
"country": "us",
"tagIds": []
}
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({prompts: ['best running shoes', 'best trail shoes'], country: 'us', tagIds: []})
};
fetch('https://data.otterly.ai/v1/workspaces/{id}/prompts', 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://data.otterly.ai/v1/workspaces/{id}/prompts",
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([
'prompts' => [
'best running shoes',
'best trail shoes'
],
'country' => 'us',
'tagIds' => [
]
]),
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://data.otterly.ai/v1/workspaces/{id}/prompts"
payload := strings.NewReader("{\n \"prompts\": [\n \"best running shoes\",\n \"best trail shoes\"\n ],\n \"country\": \"us\",\n \"tagIds\": []\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://data.otterly.ai/v1/workspaces/{id}/prompts")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"prompts\": [\n \"best running shoes\",\n \"best trail shoes\"\n ],\n \"country\": \"us\",\n \"tagIds\": []\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://data.otterly.ai/v1/workspaces/{id}/prompts")
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 \"prompts\": [\n \"best running shoes\",\n \"best trail shoes\"\n ],\n \"country\": \"us\",\n \"tagIds\": []\n}"
response = http.request(request)
puts response.read_body{
"items": [
{
"id": "01HX7K2YV9D3M8N0G6Q5R4S3T2",
"prompt": "best running shoes",
"country": "us",
"tagIds": [],
"brandReportIds": [],
"createdDate": "2026-07-14T10:00:00.000Z"
}
]
}{
"promptsCount": 50,
"message": "Prompts processing started"
}{
"message": "Validation failed",
"target": "query",
"errors": [
{
"path": "country",
"message": "Required",
"code": "invalid_type"
}
]
}{
"message": "Report not found"
}{
"message": "Report not found"
}{
"message": "Some of the prompts already exist in the workspace",
"duplicatedPrompts": [
"best running shoes"
]
}{
"message": "Report not found"
}Create prompts in a workspace
Creates one prompt (prompt) or several (prompts) in the workspace and starts monitoring them, exactly like creation in the UI (including search-volume computation). Up to 5 prompts are created synchronously (201 with the created items); larger batches are processed asynchronously (202 with a processing summary). The whole batch is validated against the workspace’s remaining prompt allocation up front — nothing is created if it would exceed the limit.
curl --request POST \
--url https://data.otterly.ai/v1/workspaces/{id}/prompts \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"prompts": [
"best running shoes",
"best trail shoes"
],
"country": "us",
"tagIds": []
}
'import requests
url = "https://data.otterly.ai/v1/workspaces/{id}/prompts"
payload = {
"prompts": ["best running shoes", "best trail shoes"],
"country": "us",
"tagIds": []
}
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({prompts: ['best running shoes', 'best trail shoes'], country: 'us', tagIds: []})
};
fetch('https://data.otterly.ai/v1/workspaces/{id}/prompts', 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://data.otterly.ai/v1/workspaces/{id}/prompts",
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([
'prompts' => [
'best running shoes',
'best trail shoes'
],
'country' => 'us',
'tagIds' => [
]
]),
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://data.otterly.ai/v1/workspaces/{id}/prompts"
payload := strings.NewReader("{\n \"prompts\": [\n \"best running shoes\",\n \"best trail shoes\"\n ],\n \"country\": \"us\",\n \"tagIds\": []\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://data.otterly.ai/v1/workspaces/{id}/prompts")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"prompts\": [\n \"best running shoes\",\n \"best trail shoes\"\n ],\n \"country\": \"us\",\n \"tagIds\": []\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://data.otterly.ai/v1/workspaces/{id}/prompts")
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 \"prompts\": [\n \"best running shoes\",\n \"best trail shoes\"\n ],\n \"country\": \"us\",\n \"tagIds\": []\n}"
response = http.request(request)
puts response.read_body{
"items": [
{
"id": "01HX7K2YV9D3M8N0G6Q5R4S3T2",
"prompt": "best running shoes",
"country": "us",
"tagIds": [],
"brandReportIds": [],
"createdDate": "2026-07-14T10:00:00.000Z"
}
]
}{
"promptsCount": 50,
"message": "Prompts processing started"
}{
"message": "Validation failed",
"target": "query",
"errors": [
{
"path": "country",
"message": "Required",
"code": "invalid_type"
}
]
}{
"message": "Report not found"
}{
"message": "Report not found"
}{
"message": "Some of the prompts already exist in the workspace",
"duplicatedPrompts": [
"best running shoes"
]
}{
"message": "Report not found"
}Authorizations
Provide your API key as a Bearer token: Authorization: Bearer YOUR_API_KEY.
Path Parameters
Workspace identifier.
1"01HX7K2YV9D3M8N0G6Q5R4S3T2"
Body
Prompt texts to create (same country, tags and brand reports for all). Pass a single-item array to create one prompt.
11Country the prompts are monitored in. Lowercase ISO 3166-1 alpha-2; use uk for the United Kingdom. Immutable after creation.
^[a-z]{2}$Optional tag IDs to assign to every created prompt.
1Optional brand report IDs to add every created prompt to.
1Response
The created prompts.
Show child attributes
Show child attributes