Preview discovery intent
curl --request POST \
--url https://api.sigmora.org/v1/discovery/preview \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"intent": "Budgeting habits that help first-job earners build an emergency fund.",
"keywords": [
"first salary budget",
"emergency fund tips"
],
"platforms": [
"youtube_shorts",
"tiktok"
]
}
'import requests
url = "https://api.sigmora.org/v1/discovery/preview"
payload = {
"intent": "Budgeting habits that help first-job earners build an emergency fund.",
"keywords": ["first salary budget", "emergency fund tips"],
"platforms": ["youtube_shorts", "tiktok"]
}
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({
intent: 'Budgeting habits that help first-job earners build an emergency fund.',
keywords: ['first salary budget', 'emergency fund tips'],
platforms: ['youtube_shorts', 'tiktok']
})
};
fetch('https://api.sigmora.org/v1/discovery/preview', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));{
"success": true,
"preview": {
"intent": "<string>",
"keywords": [
"<string>"
],
"excludeKeywords": [
"<string>"
],
"queries": [
{
"platform": "youtube_shorts",
"terms": [
"<string>"
]
}
],
"quality": {
"passes": true,
"issues": [
"<string>"
],
"method": "<string>"
},
"costCredits": 0,
"createsResources": false,
"configPatch": {
"intent": "<string>",
"keywords": [],
"excludeKeywords": [],
"platforms": [
"youtube_shorts"
]
}
}
}{
"success": false,
"error": "<string>",
"code": "invalid_request",
"details": "<unknown>",
"requestId": "<string>",
"timestamp": "2023-11-07T05:31:56Z"
}{
"success": false,
"error": "<string>",
"code": "invalid_request",
"details": "<unknown>",
"requestId": "<string>",
"timestamp": "2023-11-07T05:31:56Z"
}{
"success": false,
"error": "<string>",
"code": "invalid_request",
"details": "<unknown>",
"requestId": "<string>",
"timestamp": "2023-11-07T05:31:56Z"
}{
"success": false,
"error": "<string>",
"code": "invalid_request",
"details": "<unknown>",
"requestId": "<string>",
"timestamp": "2023-11-07T05:31:56Z"
}{
"success": false,
"error": "<string>",
"code": "invalid_request",
"details": "<unknown>",
"requestId": "<string>",
"timestamp": "2023-11-07T05:31:56Z"
}{
"success": false,
"error": "<string>",
"code": "invalid_request",
"details": "<unknown>",
"requestId": "<string>",
"timestamp": "2023-11-07T05:31:56Z"
}{
"success": false,
"error": "<string>",
"code": "invalid_request",
"details": "<unknown>",
"requestId": "<string>",
"timestamp": "2023-11-07T05:31:56Z"
}Preview discovery intent
Preview an intent and validate search phrases without collecting or charging.
POST
/
v1
/
discovery
/
preview
Preview discovery intent
curl --request POST \
--url https://api.sigmora.org/v1/discovery/preview \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"intent": "Budgeting habits that help first-job earners build an emergency fund.",
"keywords": [
"first salary budget",
"emergency fund tips"
],
"platforms": [
"youtube_shorts",
"tiktok"
]
}
'import requests
url = "https://api.sigmora.org/v1/discovery/preview"
payload = {
"intent": "Budgeting habits that help first-job earners build an emergency fund.",
"keywords": ["first salary budget", "emergency fund tips"],
"platforms": ["youtube_shorts", "tiktok"]
}
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({
intent: 'Budgeting habits that help first-job earners build an emergency fund.',
keywords: ['first salary budget', 'emergency fund tips'],
platforms: ['youtube_shorts', 'tiktok']
})
};
fetch('https://api.sigmora.org/v1/discovery/preview', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));{
"success": true,
"preview": {
"intent": "<string>",
"keywords": [
"<string>"
],
"excludeKeywords": [
"<string>"
],
"queries": [
{
"platform": "youtube_shorts",
"terms": [
"<string>"
]
}
],
"quality": {
"passes": true,
"issues": [
"<string>"
],
"method": "<string>"
},
"costCredits": 0,
"createsResources": false,
"configPatch": {
"intent": "<string>",
"keywords": [],
"excludeKeywords": [],
"platforms": [
"youtube_shorts"
]
}
}
}{
"success": false,
"error": "<string>",
"code": "invalid_request",
"details": "<unknown>",
"requestId": "<string>",
"timestamp": "2023-11-07T05:31:56Z"
}{
"success": false,
"error": "<string>",
"code": "invalid_request",
"details": "<unknown>",
"requestId": "<string>",
"timestamp": "2023-11-07T05:31:56Z"
}{
"success": false,
"error": "<string>",
"code": "invalid_request",
"details": "<unknown>",
"requestId": "<string>",
"timestamp": "2023-11-07T05:31:56Z"
}{
"success": false,
"error": "<string>",
"code": "invalid_request",
"details": "<unknown>",
"requestId": "<string>",
"timestamp": "2023-11-07T05:31:56Z"
}{
"success": false,
"error": "<string>",
"code": "invalid_request",
"details": "<unknown>",
"requestId": "<string>",
"timestamp": "2023-11-07T05:31:56Z"
}{
"success": false,
"error": "<string>",
"code": "invalid_request",
"details": "<unknown>",
"requestId": "<string>",
"timestamp": "2023-11-07T05:31:56Z"
}{
"success": false,
"error": "<string>",
"code": "invalid_request",
"details": "<unknown>",
"requestId": "<string>",
"timestamp": "2023-11-07T05:31:56Z"
}Authorizations
A workspace API key.
Body
application/json
The audience outcome or content opportunity to research, in at least 10 characters.
Required string length:
10 - 500Optional seed search phrases. Send at most 12; defaults to an empty list.
Maximum array length:
12Required string length:
2 - 120Optional phrases to exclude from search results. Send at most 20; defaults to an empty list.
Maximum array length:
20Required string length:
2 - 120Platforms to search. Defaults to youtube_shorts.
Required array length:
1 - 10 elementsAvailable options:
youtube_shorts, instagram_reels, facebook_reels, tiktok, twitter, reddit, news, medium, google_news, google_web