Get prompt answers
curl --request GET \
--url https://services.deepsmith.ai/core/api/external/v1/visibility/prompts/{prompt}/answers \
--header 'Authorization: Bearer <token>'import requests
url = "https://services.deepsmith.ai/core/api/external/v1/visibility/prompts/{prompt}/answers"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://services.deepsmith.ai/core/api/external/v1/visibility/prompts/{prompt}/answers', 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://services.deepsmith.ai/core/api/external/v1/visibility/prompts/{prompt}/answers",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://services.deepsmith.ai/core/api/external/v1/visibility/prompts/{prompt}/answers"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://services.deepsmith.ai/core/api/external/v1/visibility/prompts/{prompt}/answers")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://services.deepsmith.ai/core/api/external/v1/visibility/prompts/{prompt}/answers")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"code": 123,
"messages": "<string>",
"data": {
"range": "30d",
"prompt": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"text": "<string>",
"status": "<string>"
},
"answers": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"platform": "chatgpt",
"status": "COLLECTED",
"collected_at": "2023-11-07T05:31:56Z",
"preview": "<string>",
"brand_mentioned": true,
"brand_cited": true,
"competitor_found": true,
"error_message": "<string>"
}
]
}
}{
"code": 4022,
"messages": "Invalid, revoked or expired API key.",
"data": null
}{
"code": 4023,
"messages": "This API key does not have the scope required for this request.",
"data": {
"required": [
"visibility:read"
],
"missing": [
"visibility:read"
]
}
}AI visibility
Get prompt answers
The answers AI platforms gave for a prompt, newest first, up to 200. Compact by default; full=1 adds the answer
text, citations, brand mention excerpts and detected competitors. Requires visibility:read.
GET
/
visibility
/
prompts
/
{prompt}
/
answers
Get prompt answers
curl --request GET \
--url https://services.deepsmith.ai/core/api/external/v1/visibility/prompts/{prompt}/answers \
--header 'Authorization: Bearer <token>'import requests
url = "https://services.deepsmith.ai/core/api/external/v1/visibility/prompts/{prompt}/answers"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://services.deepsmith.ai/core/api/external/v1/visibility/prompts/{prompt}/answers', 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://services.deepsmith.ai/core/api/external/v1/visibility/prompts/{prompt}/answers",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://services.deepsmith.ai/core/api/external/v1/visibility/prompts/{prompt}/answers"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://services.deepsmith.ai/core/api/external/v1/visibility/prompts/{prompt}/answers")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://services.deepsmith.ai/core/api/external/v1/visibility/prompts/{prompt}/answers")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"code": 123,
"messages": "<string>",
"data": {
"range": "30d",
"prompt": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"text": "<string>",
"status": "<string>"
},
"answers": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"platform": "chatgpt",
"status": "COLLECTED",
"collected_at": "2023-11-07T05:31:56Z",
"preview": "<string>",
"brand_mentioned": true,
"brand_cited": true,
"competitor_found": true,
"error_message": "<string>"
}
]
}
}{
"code": 4022,
"messages": "Invalid, revoked or expired API key.",
"data": null
}{
"code": 4023,
"messages": "This API key does not have the scope required for this request.",
"data": {
"required": [
"visibility:read"
],
"missing": [
"visibility:read"
]
}
}Authorizations
bearerAuthapiKeyHeader
Your API key: Authorization: Bearer API Key Value
Path Parameters
A prompt ID from GET /visibility/prompts.
Query Parameters
The period to report on. The previous period of the same length is returned for comparison.
Available options:
7d, 30d, 90d Available options:
chatgpt, google_ai_overview, perplexity, gemini, grok, claude A single day, YYYY-MM-DD.