ai.check.prompts

ai.check.prompts

Credits: 1/entry returned
Creates a list of the most relevant prompts in which the given BRANDS are mentioned or the given DOMAINS are cited in the AI answer. Brands and domains are passed directly by the caller — either as a single value or as a JSON array of up to 100 entries per parameter; at least one of the two parameters is required. The number of prompts can be controlled with the limit parameter. Further adjustments can be made using the model and country parameters, which define the AI model and the country used for the analysis.

Result

The result contains the prompts that are most relevant to the given brands and/or domains. Each entry includes the prompt itself, the AI model that generated the response, the generated message (answer text), and the country of the output.

GET-Parameters

Parameters (Mandatory)

api_key
STRING
Your personal API key. This key is used to authenticate your requests. You can obtain it here.

Parameters (Optional)

brands
STRING
One or more brand names to analyse for AI mentions. Accepts a single value (e.g. sistrix) or a JSON array of up to 100 brands (e.g. ["sistrix","nike"]). At least one of the brands or domains parameters must be provided. The singular alias brand is also accepted.
domains
STRING
One or more domains to analyse for AI citations. Accepts a single value (e.g. sistrix.de) or a JSON array of up to 100 domains (e.g. ["sistrix.de","sistrix.com"]). At least one of the brands or domains parameters must be provided. The singular alias domain is also accepted.
model
STRING
Defines the model for which the method will be executed. If no model is specified, results for all AI models will be returned. This can also be explicitly set by using the value all.
country
STRING
Defines the country for which the results will be returned. The parameter follows ISO 3166-1 alpha-2 (e.g., Germany = DE). If no country is specified, results for all countries will be displayed.
limit
INTEGER
Specifies the number of reults for each page. Adjust this value to control the number of results returned on each page. By default, this parameter is set to 100.
page
INTEGER
Specifies which set of recources to return. This allows you to choose a specific page of results, with the number of results for each page determined by the limit parameter.
format
STRING
Specifies whether the response will be returned in XML or JSON format. By default, the result will be in XML format.
To be able to use the API documentation with real data, you have to create an API key in your account.
EXAMPLE
$baseUrl = "https://api.sistrix.com/ai.check.prompts";

$post = [



];

$curl = curl_init();

curl_setopt($curl, CURLOPT_URL, $baseUrl);

curl_setopt($curl, CURLOPT_POSTFIELDS, $post);

curl_setopt($curl, CURLOPT_RETURNTRANSFER, 1);

$response = curl_exec($curl);

curl_close($curl);
import requests

baseUrl = 'https://api.sistrix.com/ai.check.prompts'

post = {



}

response = requests.post(baseUrl, post)

data = response.text
curl https://api.sistrix.com/ai.check.prompts \


let baseUrl = 'https://api.sistrix.com/ai.check.prompts';

let form = new FormData();



fetch(baseUrl, {

    method: 'POST',

    body: form

}).then(function(response){

    return response.text();

}).then(function(data){

    //data contains the results of the request

})