Create one or more Content Briefs

curl --request POST \
  --url https://www.getsurfaced.ai/api/v1/briefs \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'X-Workspace-Id: <x-workspace-id>' \
  --data '
{
  "briefs": [
    {
      "title": "<string>",
      "keyword": "<string>",
      "persona": "<string>",
      "region": "<string>",
      "language": "<string>",
      "intent": "<string>",
      "tags": [
        "<string>"
      ],
      "notes": "<string>",
      "category": "<string>",
      "articleStructure": "<string>",
      "culturalTone": "<string>",
      "formality": "<string>",
      "addressFormality": "<string>",
      "wordCount": {
        "min": 123,
        "target": 123,
        "max": 123
      },
      "requiredSections": [
        "<string>"
      ],
      "blockPreferences": {},
      "templateId": "<string>",
      "faqPosition": "<string>",
      "cta": {},
      "targetRegions": [
        "<string>"
      ],
      "targetMarkets": [
        "<unknown>"
      ],
      "locales": [
        "<string>"
      ],
      "locale": "<string>",
      "idea_text": "<string>",
      "primary_keyword": "<string>",
      "input_tags": [
        "<string>"
      ],
      "article_structure": "<string>",
      "cultural_tone": "<string>",
      "address_formality": "<string>",
      "word_count_min": 123,
      "word_count_target": 123,
      "word_count_max": 123,
      "required_sections": [
        "<string>"
      ],
      "block_preferences": {},
      "template_id": "<string>",
      "faq_position": "<string>",
      "target_regions": [
        "<string>"
      ],
      "target_markets": [
        "<unknown>"
      ]
    }
  ],
  "source": "<string>"
}
'

import requests

url = "https://www.getsurfaced.ai/api/v1/briefs"

payload = {
    "briefs": [
        {
            "title": "<string>",
            "keyword": "<string>",
            "persona": "<string>",
            "region": "<string>",
            "language": "<string>",
            "intent": "<string>",
            "tags": ["<string>"],
            "notes": "<string>",
            "category": "<string>",
            "articleStructure": "<string>",
            "culturalTone": "<string>",
            "formality": "<string>",
            "addressFormality": "<string>",
            "wordCount": {
                "min": 123,
                "target": 123,
                "max": 123
            },
            "requiredSections": ["<string>"],
            "blockPreferences": {},
            "templateId": "<string>",
            "faqPosition": "<string>",
            "cta": {},
            "targetRegions": ["<string>"],
            "targetMarkets": ["<unknown>"],
            "locales": ["<string>"],
            "locale": "<string>",
            "idea_text": "<string>",
            "primary_keyword": "<string>",
            "input_tags": ["<string>"],
            "article_structure": "<string>",
            "cultural_tone": "<string>",
            "address_formality": "<string>",
            "word_count_min": 123,
            "word_count_target": 123,
            "word_count_max": 123,
            "required_sections": ["<string>"],
            "block_preferences": {},
            "template_id": "<string>",
            "faq_position": "<string>",
            "target_regions": ["<string>"],
            "target_markets": ["<unknown>"]
        }
    ],
    "source": "<string>"
}
headers = {
    "X-Workspace-Id": "<x-workspace-id>",
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {
    'X-Workspace-Id': '<x-workspace-id>',
    Authorization: 'Bearer <token>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    briefs: [
      {
        title: '<string>',
        keyword: '<string>',
        persona: '<string>',
        region: '<string>',
        language: '<string>',
        intent: '<string>',
        tags: ['<string>'],
        notes: '<string>',
        category: '<string>',
        articleStructure: '<string>',
        culturalTone: '<string>',
        formality: '<string>',
        addressFormality: '<string>',
        wordCount: {min: 123, target: 123, max: 123},
        requiredSections: ['<string>'],
        blockPreferences: {},
        templateId: '<string>',
        faqPosition: '<string>',
        cta: {},
        targetRegions: ['<string>'],
        targetMarkets: ['<unknown>'],
        locales: ['<string>'],
        locale: '<string>',
        idea_text: '<string>',
        primary_keyword: '<string>',
        input_tags: ['<string>'],
        article_structure: '<string>',
        cultural_tone: '<string>',
        address_formality: '<string>',
        word_count_min: 123,
        word_count_target: 123,
        word_count_max: 123,
        required_sections: ['<string>'],
        block_preferences: {},
        template_id: '<string>',
        faq_position: '<string>',
        target_regions: ['<string>'],
        target_markets: ['<unknown>']
      }
    ],
    source: '<string>'
  })
};

fetch('https://www.getsurfaced.ai/api/v1/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://www.getsurfaced.ai/api/v1/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([
    'briefs' => [
        [
                'title' => '<string>',
                'keyword' => '<string>',
                'persona' => '<string>',
                'region' => '<string>',
                'language' => '<string>',
                'intent' => '<string>',
                'tags' => [
                                '<string>'
                ],
                'notes' => '<string>',
                'category' => '<string>',
                'articleStructure' => '<string>',
                'culturalTone' => '<string>',
                'formality' => '<string>',
                'addressFormality' => '<string>',
                'wordCount' => [
                                'min' => 123,
                                'target' => 123,
                                'max' => 123
                ],
                'requiredSections' => [
                                '<string>'
                ],
                'blockPreferences' => [
                                
                ],
                'templateId' => '<string>',
                'faqPosition' => '<string>',
                'cta' => [
                                
                ],
                'targetRegions' => [
                                '<string>'
                ],
                'targetMarkets' => [
                                '<unknown>'
                ],
                'locales' => [
                                '<string>'
                ],
                'locale' => '<string>',
                'idea_text' => '<string>',
                'primary_keyword' => '<string>',
                'input_tags' => [
                                '<string>'
                ],
                'article_structure' => '<string>',
                'cultural_tone' => '<string>',
                'address_formality' => '<string>',
                'word_count_min' => 123,
                'word_count_target' => 123,
                'word_count_max' => 123,
                'required_sections' => [
                                '<string>'
                ],
                'block_preferences' => [
                                
                ],
                'template_id' => '<string>',
                'faq_position' => '<string>',
                'target_regions' => [
                                '<string>'
                ],
                'target_markets' => [
                                '<unknown>'
                ]
        ]
    ],
    'source' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json",
    "X-Workspace-Id: <x-workspace-id>"
  ],
]);

$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://www.getsurfaced.ai/api/v1/briefs"

	payload := strings.NewReader("{\n  \"briefs\": [\n    {\n      \"title\": \"<string>\",\n      \"keyword\": \"<string>\",\n      \"persona\": \"<string>\",\n      \"region\": \"<string>\",\n      \"language\": \"<string>\",\n      \"intent\": \"<string>\",\n      \"tags\": [\n        \"<string>\"\n      ],\n      \"notes\": \"<string>\",\n      \"category\": \"<string>\",\n      \"articleStructure\": \"<string>\",\n      \"culturalTone\": \"<string>\",\n      \"formality\": \"<string>\",\n      \"addressFormality\": \"<string>\",\n      \"wordCount\": {\n        \"min\": 123,\n        \"target\": 123,\n        \"max\": 123\n      },\n      \"requiredSections\": [\n        \"<string>\"\n      ],\n      \"blockPreferences\": {},\n      \"templateId\": \"<string>\",\n      \"faqPosition\": \"<string>\",\n      \"cta\": {},\n      \"targetRegions\": [\n        \"<string>\"\n      ],\n      \"targetMarkets\": [\n        \"<unknown>\"\n      ],\n      \"locales\": [\n        \"<string>\"\n      ],\n      \"locale\": \"<string>\",\n      \"idea_text\": \"<string>\",\n      \"primary_keyword\": \"<string>\",\n      \"input_tags\": [\n        \"<string>\"\n      ],\n      \"article_structure\": \"<string>\",\n      \"cultural_tone\": \"<string>\",\n      \"address_formality\": \"<string>\",\n      \"word_count_min\": 123,\n      \"word_count_target\": 123,\n      \"word_count_max\": 123,\n      \"required_sections\": [\n        \"<string>\"\n      ],\n      \"block_preferences\": {},\n      \"template_id\": \"<string>\",\n      \"faq_position\": \"<string>\",\n      \"target_regions\": [\n        \"<string>\"\n      ],\n      \"target_markets\": [\n        \"<unknown>\"\n      ]\n    }\n  ],\n  \"source\": \"<string>\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("X-Workspace-Id", "<x-workspace-id>")
	req.Header.Add("Authorization", "Bearer <token>")
	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://www.getsurfaced.ai/api/v1/briefs")
  .header("X-Workspace-Id", "<x-workspace-id>")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"briefs\": [\n    {\n      \"title\": \"<string>\",\n      \"keyword\": \"<string>\",\n      \"persona\": \"<string>\",\n      \"region\": \"<string>\",\n      \"language\": \"<string>\",\n      \"intent\": \"<string>\",\n      \"tags\": [\n        \"<string>\"\n      ],\n      \"notes\": \"<string>\",\n      \"category\": \"<string>\",\n      \"articleStructure\": \"<string>\",\n      \"culturalTone\": \"<string>\",\n      \"formality\": \"<string>\",\n      \"addressFormality\": \"<string>\",\n      \"wordCount\": {\n        \"min\": 123,\n        \"target\": 123,\n        \"max\": 123\n      },\n      \"requiredSections\": [\n        \"<string>\"\n      ],\n      \"blockPreferences\": {},\n      \"templateId\": \"<string>\",\n      \"faqPosition\": \"<string>\",\n      \"cta\": {},\n      \"targetRegions\": [\n        \"<string>\"\n      ],\n      \"targetMarkets\": [\n        \"<unknown>\"\n      ],\n      \"locales\": [\n        \"<string>\"\n      ],\n      \"locale\": \"<string>\",\n      \"idea_text\": \"<string>\",\n      \"primary_keyword\": \"<string>\",\n      \"input_tags\": [\n        \"<string>\"\n      ],\n      \"article_structure\": \"<string>\",\n      \"cultural_tone\": \"<string>\",\n      \"address_formality\": \"<string>\",\n      \"word_count_min\": 123,\n      \"word_count_target\": 123,\n      \"word_count_max\": 123,\n      \"required_sections\": [\n        \"<string>\"\n      ],\n      \"block_preferences\": {},\n      \"template_id\": \"<string>\",\n      \"faq_position\": \"<string>\",\n      \"target_regions\": [\n        \"<string>\"\n      ],\n      \"target_markets\": [\n        \"<unknown>\"\n      ]\n    }\n  ],\n  \"source\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://www.getsurfaced.ai/api/v1/briefs")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["X-Workspace-Id"] = '<x-workspace-id>'
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"briefs\": [\n    {\n      \"title\": \"<string>\",\n      \"keyword\": \"<string>\",\n      \"persona\": \"<string>\",\n      \"region\": \"<string>\",\n      \"language\": \"<string>\",\n      \"intent\": \"<string>\",\n      \"tags\": [\n        \"<string>\"\n      ],\n      \"notes\": \"<string>\",\n      \"category\": \"<string>\",\n      \"articleStructure\": \"<string>\",\n      \"culturalTone\": \"<string>\",\n      \"formality\": \"<string>\",\n      \"addressFormality\": \"<string>\",\n      \"wordCount\": {\n        \"min\": 123,\n        \"target\": 123,\n        \"max\": 123\n      },\n      \"requiredSections\": [\n        \"<string>\"\n      ],\n      \"blockPreferences\": {},\n      \"templateId\": \"<string>\",\n      \"faqPosition\": \"<string>\",\n      \"cta\": {},\n      \"targetRegions\": [\n        \"<string>\"\n      ],\n      \"targetMarkets\": [\n        \"<unknown>\"\n      ],\n      \"locales\": [\n        \"<string>\"\n      ],\n      \"locale\": \"<string>\",\n      \"idea_text\": \"<string>\",\n      \"primary_keyword\": \"<string>\",\n      \"input_tags\": [\n        \"<string>\"\n      ],\n      \"article_structure\": \"<string>\",\n      \"cultural_tone\": \"<string>\",\n      \"address_formality\": \"<string>\",\n      \"word_count_min\": 123,\n      \"word_count_target\": 123,\n      \"word_count_max\": 123,\n      \"required_sections\": [\n        \"<string>\"\n      ],\n      \"block_preferences\": {},\n      \"template_id\": \"<string>\",\n      \"faq_position\": \"<string>\",\n      \"target_regions\": [\n        \"<string>\"\n      ],\n      \"target_markets\": [\n        \"<unknown>\"\n      ]\n    }\n  ],\n  \"source\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body

{
  "data": {
    "created": [
      {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "title": "<string>",
        "keyword": "<string>",
        "persona": "<string>",
        "region": "<string>",
        "language": "<string>",
        "intent": "<string>",
        "tags": [
          "<string>"
        ],
        "notes": "<string>",
        "category": "<string>",
        "source": "<string>",
        "position": 123,
        "status": "draft",
        "locked": true,
        "run": {
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "state": "queued",
          "paused": true,
          "executionMode": "<string>",
          "latestActivityAt": "2023-11-07T05:31:56Z",
          "targets": [
            {
              "marketRef": "<string>",
              "language": "<string>",
              "locale": "<string>",
              "state": "queued",
              "articleId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
            }
          ]
        },
        "markets": [
          {
            "marketRef": "<string>",
            "name": "<string>",
            "countries": [
              "<string>"
            ],
            "language": "<string>"
          }
        ],
        "content": {
          "articleStructure": "<string>",
          "culturalTone": "<string>",
          "formality": "<string>",
          "addressFormality": "<string>",
          "wordCount": {
            "min": 123,
            "target": 123,
            "max": 123
          },
          "requiredSections": [
            "<string>"
          ],
          "blockPreferences": {},
          "templateId": "<string>",
          "faqPosition": "<string>",
          "cta": {},
          "targetRegions": [
            "<string>"
          ]
        },
        "gap": {
          "gapIds": [
            "<string>"
          ],
          "suggestionId": "<string>",
          "targetScope": "<unknown>"
        },
        "createdAt": "2023-11-07T05:31:56Z",
        "updatedAt": "2023-11-07T05:31:56Z",
        "workspace_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "state": "pending",
        "input_tags": [
          "<string>"
        ],
        "metadata": {},
        "source_suggestion_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "source_gap_ids": [
          "<string>"
        ],
        "article_structure": "<string>",
        "cultural_tone": "<string>",
        "formality": "<string>",
        "address_formality": "<string>",
        "word_count_min": 123,
        "word_count_target": 123,
        "word_count_max": 123,
        "required_sections": [
          "<string>"
        ],
        "block_preferences": {},
        "template_id": "<string>",
        "faq_position": "<string>",
        "cta": {},
        "target_regions": [
          "<string>"
        ],
        "target_markets": [
          "<unknown>"
        ],
        "locale": "<string>",
        "locales": [
          "<string>"
        ],
        "cultural_overrides": {},
        "idea_text": "<string>",
        "primary_keyword": "<string>",
        "created_at": "2023-11-07T05:31:56Z",
        "updated_at": "2023-11-07T05:31:56Z"
      }
    ],
    "count": 123
  }
}

{
  "error": {
    "code": "UNAUTHORIZED",
    "message": "<string>",
    "details": {}
  }
}

{
  "error": {
    "code": "UNAUTHORIZED",
    "message": "<string>",
    "details": {}
  }
}

{
  "error": {
    "code": "UNAUTHORIZED",
    "message": "<string>",
    "details": {}
  }
}

{
  "error": {
    "code": "UNAUTHORIZED",
    "message": "<string>",
    "details": {}
  }
}

{
  "error": {
    "code": "UNAUTHORIZED",
    "message": "<string>",
    "details": {}
  }
}

{
  "error": {
    "code": "UNAUTHORIZED",
    "message": "<string>",
    "details": {}
  }
}

{
  "error": {
    "code": "UNAUTHORIZED",
    "message": "<string>",
    "details": {}
  }
}

{
  "error": {
    "code": "UNAUTHORIZED",
    "message": "<string>",
    "details": {}
  }
}

Content

Create one or more Content Briefs

Creates Content Briefs in the active workspace; each is returned as a draft. Fields are camelCase. The legacy snake_case names (idea_text, primary_keyword, …) are still accepted until the API sunset; one field sent under both names with different values is a 422, as is an unknown field. Send an Idempotency-Key (a UUID) so a retry after a lost response returns the same Briefs instead of creating them twice; reusing a key for different Briefs is a 409. A key that is not a UUID, or one on more than 100 Briefs, is ignored with an IGNORED_HEADER warning. Start writing a Brief with POST /briefs/{id}/run.

POST

briefs

curl --request POST \
  --url https://www.getsurfaced.ai/api/v1/briefs \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'X-Workspace-Id: <x-workspace-id>' \
  --data '
{
  "briefs": [
    {
      "title": "<string>",
      "keyword": "<string>",
      "persona": "<string>",
      "region": "<string>",
      "language": "<string>",
      "intent": "<string>",
      "tags": [
        "<string>"
      ],
      "notes": "<string>",
      "category": "<string>",
      "articleStructure": "<string>",
      "culturalTone": "<string>",
      "formality": "<string>",
      "addressFormality": "<string>",
      "wordCount": {
        "min": 123,
        "target": 123,
        "max": 123
      },
      "requiredSections": [
        "<string>"
      ],
      "blockPreferences": {},
      "templateId": "<string>",
      "faqPosition": "<string>",
      "cta": {},
      "targetRegions": [
        "<string>"
      ],
      "targetMarkets": [
        "<unknown>"
      ],
      "locales": [
        "<string>"
      ],
      "locale": "<string>",
      "idea_text": "<string>",
      "primary_keyword": "<string>",
      "input_tags": [
        "<string>"
      ],
      "article_structure": "<string>",
      "cultural_tone": "<string>",
      "address_formality": "<string>",
      "word_count_min": 123,
      "word_count_target": 123,
      "word_count_max": 123,
      "required_sections": [
        "<string>"
      ],
      "block_preferences": {},
      "template_id": "<string>",
      "faq_position": "<string>",
      "target_regions": [
        "<string>"
      ],
      "target_markets": [
        "<unknown>"
      ]
    }
  ],
  "source": "<string>"
}
'

import requests

url = "https://www.getsurfaced.ai/api/v1/briefs"

payload = {
    "briefs": [
        {
            "title": "<string>",
            "keyword": "<string>",
            "persona": "<string>",
            "region": "<string>",
            "language": "<string>",
            "intent": "<string>",
            "tags": ["<string>"],
            "notes": "<string>",
            "category": "<string>",
            "articleStructure": "<string>",
            "culturalTone": "<string>",
            "formality": "<string>",
            "addressFormality": "<string>",
            "wordCount": {
                "min": 123,
                "target": 123,
                "max": 123
            },
            "requiredSections": ["<string>"],
            "blockPreferences": {},
            "templateId": "<string>",
            "faqPosition": "<string>",
            "cta": {},
            "targetRegions": ["<string>"],
            "targetMarkets": ["<unknown>"],
            "locales": ["<string>"],
            "locale": "<string>",
            "idea_text": "<string>",
            "primary_keyword": "<string>",
            "input_tags": ["<string>"],
            "article_structure": "<string>",
            "cultural_tone": "<string>",
            "address_formality": "<string>",
            "word_count_min": 123,
            "word_count_target": 123,
            "word_count_max": 123,
            "required_sections": ["<string>"],
            "block_preferences": {},
            "template_id": "<string>",
            "faq_position": "<string>",
            "target_regions": ["<string>"],
            "target_markets": ["<unknown>"]
        }
    ],
    "source": "<string>"
}
headers = {
    "X-Workspace-Id": "<x-workspace-id>",
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {
    'X-Workspace-Id': '<x-workspace-id>',
    Authorization: 'Bearer <token>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    briefs: [
      {
        title: '<string>',
        keyword: '<string>',
        persona: '<string>',
        region: '<string>',
        language: '<string>',
        intent: '<string>',
        tags: ['<string>'],
        notes: '<string>',
        category: '<string>',
        articleStructure: '<string>',
        culturalTone: '<string>',
        formality: '<string>',
        addressFormality: '<string>',
        wordCount: {min: 123, target: 123, max: 123},
        requiredSections: ['<string>'],
        blockPreferences: {},
        templateId: '<string>',
        faqPosition: '<string>',
        cta: {},
        targetRegions: ['<string>'],
        targetMarkets: ['<unknown>'],
        locales: ['<string>'],
        locale: '<string>',
        idea_text: '<string>',
        primary_keyword: '<string>',
        input_tags: ['<string>'],
        article_structure: '<string>',
        cultural_tone: '<string>',
        address_formality: '<string>',
        word_count_min: 123,
        word_count_target: 123,
        word_count_max: 123,
        required_sections: ['<string>'],
        block_preferences: {},
        template_id: '<string>',
        faq_position: '<string>',
        target_regions: ['<string>'],
        target_markets: ['<unknown>']
      }
    ],
    source: '<string>'
  })
};

fetch('https://www.getsurfaced.ai/api/v1/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://www.getsurfaced.ai/api/v1/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([
    'briefs' => [
        [
                'title' => '<string>',
                'keyword' => '<string>',
                'persona' => '<string>',
                'region' => '<string>',
                'language' => '<string>',
                'intent' => '<string>',
                'tags' => [
                                '<string>'
                ],
                'notes' => '<string>',
                'category' => '<string>',
                'articleStructure' => '<string>',
                'culturalTone' => '<string>',
                'formality' => '<string>',
                'addressFormality' => '<string>',
                'wordCount' => [
                                'min' => 123,
                                'target' => 123,
                                'max' => 123
                ],
                'requiredSections' => [
                                '<string>'
                ],
                'blockPreferences' => [
                                
                ],
                'templateId' => '<string>',
                'faqPosition' => '<string>',
                'cta' => [
                                
                ],
                'targetRegions' => [
                                '<string>'
                ],
                'targetMarkets' => [
                                '<unknown>'
                ],
                'locales' => [
                                '<string>'
                ],
                'locale' => '<string>',
                'idea_text' => '<string>',
                'primary_keyword' => '<string>',
                'input_tags' => [
                                '<string>'
                ],
                'article_structure' => '<string>',
                'cultural_tone' => '<string>',
                'address_formality' => '<string>',
                'word_count_min' => 123,
                'word_count_target' => 123,
                'word_count_max' => 123,
                'required_sections' => [
                                '<string>'
                ],
                'block_preferences' => [
                                
                ],
                'template_id' => '<string>',
                'faq_position' => '<string>',
                'target_regions' => [
                                '<string>'
                ],
                'target_markets' => [
                                '<unknown>'
                ]
        ]
    ],
    'source' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json",
    "X-Workspace-Id: <x-workspace-id>"
  ],
]);

$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://www.getsurfaced.ai/api/v1/briefs"

	payload := strings.NewReader("{\n  \"briefs\": [\n    {\n      \"title\": \"<string>\",\n      \"keyword\": \"<string>\",\n      \"persona\": \"<string>\",\n      \"region\": \"<string>\",\n      \"language\": \"<string>\",\n      \"intent\": \"<string>\",\n      \"tags\": [\n        \"<string>\"\n      ],\n      \"notes\": \"<string>\",\n      \"category\": \"<string>\",\n      \"articleStructure\": \"<string>\",\n      \"culturalTone\": \"<string>\",\n      \"formality\": \"<string>\",\n      \"addressFormality\": \"<string>\",\n      \"wordCount\": {\n        \"min\": 123,\n        \"target\": 123,\n        \"max\": 123\n      },\n      \"requiredSections\": [\n        \"<string>\"\n      ],\n      \"blockPreferences\": {},\n      \"templateId\": \"<string>\",\n      \"faqPosition\": \"<string>\",\n      \"cta\": {},\n      \"targetRegions\": [\n        \"<string>\"\n      ],\n      \"targetMarkets\": [\n        \"<unknown>\"\n      ],\n      \"locales\": [\n        \"<string>\"\n      ],\n      \"locale\": \"<string>\",\n      \"idea_text\": \"<string>\",\n      \"primary_keyword\": \"<string>\",\n      \"input_tags\": [\n        \"<string>\"\n      ],\n      \"article_structure\": \"<string>\",\n      \"cultural_tone\": \"<string>\",\n      \"address_formality\": \"<string>\",\n      \"word_count_min\": 123,\n      \"word_count_target\": 123,\n      \"word_count_max\": 123,\n      \"required_sections\": [\n        \"<string>\"\n      ],\n      \"block_preferences\": {},\n      \"template_id\": \"<string>\",\n      \"faq_position\": \"<string>\",\n      \"target_regions\": [\n        \"<string>\"\n      ],\n      \"target_markets\": [\n        \"<unknown>\"\n      ]\n    }\n  ],\n  \"source\": \"<string>\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("X-Workspace-Id", "<x-workspace-id>")
	req.Header.Add("Authorization", "Bearer <token>")
	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://www.getsurfaced.ai/api/v1/briefs")
  .header("X-Workspace-Id", "<x-workspace-id>")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"briefs\": [\n    {\n      \"title\": \"<string>\",\n      \"keyword\": \"<string>\",\n      \"persona\": \"<string>\",\n      \"region\": \"<string>\",\n      \"language\": \"<string>\",\n      \"intent\": \"<string>\",\n      \"tags\": [\n        \"<string>\"\n      ],\n      \"notes\": \"<string>\",\n      \"category\": \"<string>\",\n      \"articleStructure\": \"<string>\",\n      \"culturalTone\": \"<string>\",\n      \"formality\": \"<string>\",\n      \"addressFormality\": \"<string>\",\n      \"wordCount\": {\n        \"min\": 123,\n        \"target\": 123,\n        \"max\": 123\n      },\n      \"requiredSections\": [\n        \"<string>\"\n      ],\n      \"blockPreferences\": {},\n      \"templateId\": \"<string>\",\n      \"faqPosition\": \"<string>\",\n      \"cta\": {},\n      \"targetRegions\": [\n        \"<string>\"\n      ],\n      \"targetMarkets\": [\n        \"<unknown>\"\n      ],\n      \"locales\": [\n        \"<string>\"\n      ],\n      \"locale\": \"<string>\",\n      \"idea_text\": \"<string>\",\n      \"primary_keyword\": \"<string>\",\n      \"input_tags\": [\n        \"<string>\"\n      ],\n      \"article_structure\": \"<string>\",\n      \"cultural_tone\": \"<string>\",\n      \"address_formality\": \"<string>\",\n      \"word_count_min\": 123,\n      \"word_count_target\": 123,\n      \"word_count_max\": 123,\n      \"required_sections\": [\n        \"<string>\"\n      ],\n      \"block_preferences\": {},\n      \"template_id\": \"<string>\",\n      \"faq_position\": \"<string>\",\n      \"target_regions\": [\n        \"<string>\"\n      ],\n      \"target_markets\": [\n        \"<unknown>\"\n      ]\n    }\n  ],\n  \"source\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://www.getsurfaced.ai/api/v1/briefs")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["X-Workspace-Id"] = '<x-workspace-id>'
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"briefs\": [\n    {\n      \"title\": \"<string>\",\n      \"keyword\": \"<string>\",\n      \"persona\": \"<string>\",\n      \"region\": \"<string>\",\n      \"language\": \"<string>\",\n      \"intent\": \"<string>\",\n      \"tags\": [\n        \"<string>\"\n      ],\n      \"notes\": \"<string>\",\n      \"category\": \"<string>\",\n      \"articleStructure\": \"<string>\",\n      \"culturalTone\": \"<string>\",\n      \"formality\": \"<string>\",\n      \"addressFormality\": \"<string>\",\n      \"wordCount\": {\n        \"min\": 123,\n        \"target\": 123,\n        \"max\": 123\n      },\n      \"requiredSections\": [\n        \"<string>\"\n      ],\n      \"blockPreferences\": {},\n      \"templateId\": \"<string>\",\n      \"faqPosition\": \"<string>\",\n      \"cta\": {},\n      \"targetRegions\": [\n        \"<string>\"\n      ],\n      \"targetMarkets\": [\n        \"<unknown>\"\n      ],\n      \"locales\": [\n        \"<string>\"\n      ],\n      \"locale\": \"<string>\",\n      \"idea_text\": \"<string>\",\n      \"primary_keyword\": \"<string>\",\n      \"input_tags\": [\n        \"<string>\"\n      ],\n      \"article_structure\": \"<string>\",\n      \"cultural_tone\": \"<string>\",\n      \"address_formality\": \"<string>\",\n      \"word_count_min\": 123,\n      \"word_count_target\": 123,\n      \"word_count_max\": 123,\n      \"required_sections\": [\n        \"<string>\"\n      ],\n      \"block_preferences\": {},\n      \"template_id\": \"<string>\",\n      \"faq_position\": \"<string>\",\n      \"target_regions\": [\n        \"<string>\"\n      ],\n      \"target_markets\": [\n        \"<unknown>\"\n      ]\n    }\n  ],\n  \"source\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body

{
  "data": {
    "created": [
      {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "title": "<string>",
        "keyword": "<string>",
        "persona": "<string>",
        "region": "<string>",
        "language": "<string>",
        "intent": "<string>",
        "tags": [
          "<string>"
        ],
        "notes": "<string>",
        "category": "<string>",
        "source": "<string>",
        "position": 123,
        "status": "draft",
        "locked": true,
        "run": {
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "state": "queued",
          "paused": true,
          "executionMode": "<string>",
          "latestActivityAt": "2023-11-07T05:31:56Z",
          "targets": [
            {
              "marketRef": "<string>",
              "language": "<string>",
              "locale": "<string>",
              "state": "queued",
              "articleId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
            }
          ]
        },
        "markets": [
          {
            "marketRef": "<string>",
            "name": "<string>",
            "countries": [
              "<string>"
            ],
            "language": "<string>"
          }
        ],
        "content": {
          "articleStructure": "<string>",
          "culturalTone": "<string>",
          "formality": "<string>",
          "addressFormality": "<string>",
          "wordCount": {
            "min": 123,
            "target": 123,
            "max": 123
          },
          "requiredSections": [
            "<string>"
          ],
          "blockPreferences": {},
          "templateId": "<string>",
          "faqPosition": "<string>",
          "cta": {},
          "targetRegions": [
            "<string>"
          ]
        },
        "gap": {
          "gapIds": [
            "<string>"
          ],
          "suggestionId": "<string>",
          "targetScope": "<unknown>"
        },
        "createdAt": "2023-11-07T05:31:56Z",
        "updatedAt": "2023-11-07T05:31:56Z",
        "workspace_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "state": "pending",
        "input_tags": [
          "<string>"
        ],
        "metadata": {},
        "source_suggestion_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "source_gap_ids": [
          "<string>"
        ],
        "article_structure": "<string>",
        "cultural_tone": "<string>",
        "formality": "<string>",
        "address_formality": "<string>",
        "word_count_min": 123,
        "word_count_target": 123,
        "word_count_max": 123,
        "required_sections": [
          "<string>"
        ],
        "block_preferences": {},
        "template_id": "<string>",
        "faq_position": "<string>",
        "cta": {},
        "target_regions": [
          "<string>"
        ],
        "target_markets": [
          "<unknown>"
        ],
        "locale": "<string>",
        "locales": [
          "<string>"
        ],
        "cultural_overrides": {},
        "idea_text": "<string>",
        "primary_keyword": "<string>",
        "created_at": "2023-11-07T05:31:56Z",
        "updated_at": "2023-11-07T05:31:56Z"
      }
    ],
    "count": 123
  }
}

{
  "error": {
    "code": "UNAUTHORIZED",
    "message": "<string>",
    "details": {}
  }
}

{
  "error": {
    "code": "UNAUTHORIZED",
    "message": "<string>",
    "details": {}
  }
}

{
  "error": {
    "code": "UNAUTHORIZED",
    "message": "<string>",
    "details": {}
  }
}

{
  "error": {
    "code": "UNAUTHORIZED",
    "message": "<string>",
    "details": {}
  }
}

{
  "error": {
    "code": "UNAUTHORIZED",
    "message": "<string>",
    "details": {}
  }
}

{
  "error": {
    "code": "UNAUTHORIZED",
    "message": "<string>",
    "details": {}
  }
}

{
  "error": {
    "code": "UNAUTHORIZED",
    "message": "<string>",
    "details": {}
  }
}

{
  "error": {
    "code": "UNAUTHORIZED",
    "message": "<string>",
    "details": {}
  }
}

Authorizations

Authorization

string

header

required

API key (sk_live_...) created at https://www.getsurfaced.ai/app/settings/account/api-keys

Headers

X-Workspace-Id

string<uuid>

required

UUID of the workspace to act in. Take it from GET /me (workspaces[].id). A key scoped to specific workspaces is rejected with 403 WORKSPACE_NOT_ALLOWED for any other id; a missing header is 400 WORKSPACE_REQUIRED.

Idempotency-Key

string

UUID. A retry with the same key replays the first create instead of repeating it. Ignored, with an IGNORED_HEADER warning, when it is not a UUID or the request has more than 100 Briefs.

Body

application/json

briefs

object[]

required

Minimum array length: 1

Show child attributes

source

string

manual, csv, api or automation; default api

Response

Content Briefs created

data

object

required

Show child attributes

Public API

Partner API

Create one or more Content Briefs

Authorizations

Headers

Body

Response