Create a custom brief (triggers async brief generation)
curl --request POST \
--url https://core.cognizo.ai/api/v2/brands/{brand_id}/content_studio/briefs \
--header 'Content-Type: application/json' \
--header 'X-API-KEY: <api-key>' \
--data '
{
"audience_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"mode": "create",
"prompt_ids": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
],
"source_url": "<string>",
"title": "<string>",
"target_word_count": 123,
"additional_instructions": "<string>"
}
'import requests
url = "https://core.cognizo.ai/api/v2/brands/{brand_id}/content_studio/briefs"
payload = {
"audience_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"mode": "create",
"prompt_ids": ["3c90c3cc-0d44-4b50-8888-8dd25736052a"],
"source_url": "<string>",
"title": "<string>",
"target_word_count": 123,
"additional_instructions": "<string>"
}
headers = {
"X-API-KEY": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'X-API-KEY': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
audience_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
mode: 'create',
prompt_ids: ['3c90c3cc-0d44-4b50-8888-8dd25736052a'],
source_url: '<string>',
title: '<string>',
target_word_count: 123,
additional_instructions: '<string>'
})
};
fetch('https://core.cognizo.ai/api/v2/brands/{brand_id}/content_studio/briefs', 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://core.cognizo.ai/api/v2/brands/{brand_id}/content_studio/briefs",
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([
'audience_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'mode' => 'create',
'prompt_ids' => [
'3c90c3cc-0d44-4b50-8888-8dd25736052a'
],
'source_url' => '<string>',
'title' => '<string>',
'target_word_count' => 123,
'additional_instructions' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-API-KEY: <api-key>"
],
]);
$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://core.cognizo.ai/api/v2/brands/{brand_id}/content_studio/briefs"
payload := strings.NewReader("{\n \"audience_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"mode\": \"create\",\n \"prompt_ids\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ],\n \"source_url\": \"<string>\",\n \"title\": \"<string>\",\n \"target_word_count\": 123,\n \"additional_instructions\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("X-API-KEY", "<api-key>")
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://core.cognizo.ai/api/v2/brands/{brand_id}/content_studio/briefs")
.header("X-API-KEY", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"audience_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"mode\": \"create\",\n \"prompt_ids\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ],\n \"source_url\": \"<string>\",\n \"title\": \"<string>\",\n \"target_word_count\": 123,\n \"additional_instructions\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://core.cognizo.ai/api/v2/brands/{brand_id}/content_studio/briefs")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-API-KEY"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"audience_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"mode\": \"create\",\n \"prompt_ids\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ],\n \"source_url\": \"<string>\",\n \"title\": \"<string>\",\n \"target_word_count\": 123,\n \"additional_instructions\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"data": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"brand_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"audience_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"format": "how_to_guide",
"outline": {},
"metadata": {},
"state": "new",
"progress_pct": 123,
"audience_name": "<string>",
"topic_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"topic_name": "<string>",
"target_prompts": [
{
"prompt_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"prompt": "<string>",
"country_codes": [
"<string>"
]
}
],
"recommendation_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"recommendation": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"type": "social_post",
"suggested_title": "<string>"
},
"title": "<string>",
"mode": "create",
"source_url": "<string>",
"target_word_count": 123,
"additional_instructions": "<string>",
"brief_text": "<string>",
"article": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"state": "<string>",
"progress_pct": 123
},
"generation_error": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"deleted_at": "2023-11-07T05:31:56Z"
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"details": [
{
"field": "<string>",
"code": "<string>",
"message": "<string>"
}
]
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"details": [
{
"field": "<string>",
"code": "<string>",
"message": "<string>"
}
]
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"details": [
{
"field": "<string>",
"code": "<string>",
"message": "<string>"
}
]
}
}ContentStudio
Create a custom brief (triggers async brief generation)
POST
/
api
/
v2
/
brands
/
{brand_id}
/
content_studio
/
briefs
Create a custom brief (triggers async brief generation)
curl --request POST \
--url https://core.cognizo.ai/api/v2/brands/{brand_id}/content_studio/briefs \
--header 'Content-Type: application/json' \
--header 'X-API-KEY: <api-key>' \
--data '
{
"audience_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"mode": "create",
"prompt_ids": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
],
"source_url": "<string>",
"title": "<string>",
"target_word_count": 123,
"additional_instructions": "<string>"
}
'import requests
url = "https://core.cognizo.ai/api/v2/brands/{brand_id}/content_studio/briefs"
payload = {
"audience_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"mode": "create",
"prompt_ids": ["3c90c3cc-0d44-4b50-8888-8dd25736052a"],
"source_url": "<string>",
"title": "<string>",
"target_word_count": 123,
"additional_instructions": "<string>"
}
headers = {
"X-API-KEY": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'X-API-KEY': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
audience_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
mode: 'create',
prompt_ids: ['3c90c3cc-0d44-4b50-8888-8dd25736052a'],
source_url: '<string>',
title: '<string>',
target_word_count: 123,
additional_instructions: '<string>'
})
};
fetch('https://core.cognizo.ai/api/v2/brands/{brand_id}/content_studio/briefs', 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://core.cognizo.ai/api/v2/brands/{brand_id}/content_studio/briefs",
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([
'audience_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'mode' => 'create',
'prompt_ids' => [
'3c90c3cc-0d44-4b50-8888-8dd25736052a'
],
'source_url' => '<string>',
'title' => '<string>',
'target_word_count' => 123,
'additional_instructions' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-API-KEY: <api-key>"
],
]);
$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://core.cognizo.ai/api/v2/brands/{brand_id}/content_studio/briefs"
payload := strings.NewReader("{\n \"audience_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"mode\": \"create\",\n \"prompt_ids\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ],\n \"source_url\": \"<string>\",\n \"title\": \"<string>\",\n \"target_word_count\": 123,\n \"additional_instructions\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("X-API-KEY", "<api-key>")
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://core.cognizo.ai/api/v2/brands/{brand_id}/content_studio/briefs")
.header("X-API-KEY", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"audience_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"mode\": \"create\",\n \"prompt_ids\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ],\n \"source_url\": \"<string>\",\n \"title\": \"<string>\",\n \"target_word_count\": 123,\n \"additional_instructions\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://core.cognizo.ai/api/v2/brands/{brand_id}/content_studio/briefs")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-API-KEY"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"audience_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"mode\": \"create\",\n \"prompt_ids\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ],\n \"source_url\": \"<string>\",\n \"title\": \"<string>\",\n \"target_word_count\": 123,\n \"additional_instructions\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"data": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"brand_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"audience_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"format": "how_to_guide",
"outline": {},
"metadata": {},
"state": "new",
"progress_pct": 123,
"audience_name": "<string>",
"topic_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"topic_name": "<string>",
"target_prompts": [
{
"prompt_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"prompt": "<string>",
"country_codes": [
"<string>"
]
}
],
"recommendation_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"recommendation": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"type": "social_post",
"suggested_title": "<string>"
},
"title": "<string>",
"mode": "create",
"source_url": "<string>",
"target_word_count": 123,
"additional_instructions": "<string>",
"brief_text": "<string>",
"article": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"state": "<string>",
"progress_pct": 123
},
"generation_error": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"deleted_at": "2023-11-07T05:31:56Z"
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"details": [
{
"field": "<string>",
"code": "<string>",
"message": "<string>"
}
]
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"details": [
{
"field": "<string>",
"code": "<string>",
"message": "<string>"
}
]
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"details": [
{
"field": "<string>",
"code": "<string>",
"message": "<string>"
}
]
}
}Authorizations
Path Parameters
Body
application/json
Creation wizard input. Create mode needs prompt_ids[] (the UI expands topic checkboxes to prompt ids client-side); the anchor topic is derived server-side. Rewrite mode needs source_url instead.
Pre-fill from GET briefs/recommended_inputs
Available options:
how_to_guide, comparison, product_review, listicle, case_study, pricing_breakdown, alternative, article, opinion_piece, news_article, glossary_page, technical, features, documentation, service_page, product_page rewrite replaces an existing owned page (source_url required, selection optional); create is the net-new flow
Available options:
create, rewrite The selection — prompts tracked by the brand (topic checkboxes expand to their prompts client-side)
Rewrite mode only (required there): URL of a crawled owned page to rewrite
Optional — when omitted the brief generator derives a title (research / topic name / source page title)
Advanced settings free text — tone, angles, must-cover points; honored by research/outline/writing
Response
brief created, generation enqueued
Show child attributes
Show child attributes