Create production brief
curl --request POST \
--url https://api.sigmora.org/v1/research/briefs \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"analysisId": "ana_3b9f02",
"topic": "Budgeting on your first salary",
"audience": "Graduates starting their first job",
"targetPlatform": "shorts"
}
'import requests
url = "https://api.sigmora.org/v1/research/briefs"
payload = {
"analysisId": "ana_3b9f02",
"topic": "Budgeting on your first salary",
"audience": "Graduates starting their first job",
"targetPlatform": "shorts"
}
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({
analysisId: 'ana_3b9f02',
topic: 'Budgeting on your first salary',
audience: 'Graduates starting their first job',
targetPlatform: 'shorts'
})
};
fetch('https://api.sigmora.org/v1/research/briefs', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));{
"success": true,
"brief": {
"analysisId": "<string>",
"topic": "<string>",
"audience": "<string>",
"targetPlatform": "<string>",
"suggestedHook": "<string>",
"beats": [
{
"order": 0,
"reference": {
"startSeconds": 1,
"endSeconds": 1,
"text": "<string>",
"source": "speech"
},
"suggestion": "<string>"
}
],
"sourceReferences": [
{
"url": "<string>",
"analyzedAt": "<string>"
}
],
"method": "<string>",
"adaptationRequest": {
"sourceTitle": "<string>",
"sourcePlatform": "<string>",
"targetPlatform": "<string>",
"pattern": "<string>",
"hookType": "<string>",
"niche": "<string>"
},
"productionPrompt": "<string>"
}
}{
"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"
}Create production brief
Build a production brief from your saved analysis. Free; does not generate or publish media.
POST
/
v1
/
research
/
briefs
Create production brief
curl --request POST \
--url https://api.sigmora.org/v1/research/briefs \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"analysisId": "ana_3b9f02",
"topic": "Budgeting on your first salary",
"audience": "Graduates starting their first job",
"targetPlatform": "shorts"
}
'import requests
url = "https://api.sigmora.org/v1/research/briefs"
payload = {
"analysisId": "ana_3b9f02",
"topic": "Budgeting on your first salary",
"audience": "Graduates starting their first job",
"targetPlatform": "shorts"
}
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({
analysisId: 'ana_3b9f02',
topic: 'Budgeting on your first salary',
audience: 'Graduates starting their first job',
targetPlatform: 'shorts'
})
};
fetch('https://api.sigmora.org/v1/research/briefs', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));{
"success": true,
"brief": {
"analysisId": "<string>",
"topic": "<string>",
"audience": "<string>",
"targetPlatform": "<string>",
"suggestedHook": "<string>",
"beats": [
{
"order": 0,
"reference": {
"startSeconds": 1,
"endSeconds": 1,
"text": "<string>",
"source": "speech"
},
"suggestion": "<string>"
}
],
"sourceReferences": [
{
"url": "<string>",
"analyzedAt": "<string>"
}
],
"method": "<string>",
"adaptationRequest": {
"sourceTitle": "<string>",
"sourcePlatform": "<string>",
"targetPlatform": "<string>",
"pattern": "<string>",
"hookType": "<string>",
"niche": "<string>"
},
"productionPrompt": "<string>"
}
}{
"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
Saved video analysis id returned by POST /v1/video/analyze or GET /v1/video/analyses/{analysisId}.
Required string length:
1 - 100The original subject the new production brief should cover.
Required string length:
3 - 200The intended viewer group for the new production brief.
Required string length:
3 - 200Target short-form platform. Defaults to shorts.
Available options:
tiktok, reels, shorts