SEO Content Brief API

Looking for a Content Brief API?

With the thruuu API, you can:

• Create comprehensive SEO briefs using real-time SERP data and AI
• Generate briefs with titles, descriptions, headings, word counts, search intent, frequent terms, and more
• Perform bulk brief creation
• Use templates to structure brief elements and API output
• Add custom prompts to guide the brief creation process

If you’re looking to scale your content production, you’re in the right place.

With thruuu, you have:

• A powerful content brief generator
• An API that leverages real-time Google data and AI to create SEO content briefs

Let’s dive into getting started with the thruuu Content Brief API.

Getting Started with the thruuu Content Brief API

This guide covers how to access the Content Brief API endpoints, make API calls, and work with the returned data.

Note: If you don’t yet have an account and API key, please read this page first.

Request Builder

In the API dashboard, you’ll find the Request Builder—a helpful tool for structuring your API requests correctly.

We recommend using it as you familiarize yourself with the API to ensure proper setup.

Making Your First Call to the Content Brief API

This endpoint allows you to create content briefs in bulk based on provided keywords and parameters. It analyzes the SERPs for the given keywords and generates content briefs using a specified template.

To call the endpoint, make the following HTTP request:

POST https://api.thruuu.com/api/v2/briefs

Request Headers:

{
    "Content-Type": "application/json",
    "Authorization": "Bearer YOUR_API_TOKEN"
}

Request Body:

{
    "keywords": [
        "what is a content brief",
        "seo tools"
    ],
    "parameters": {
        "search_engine": "google.com",
        "location": null,
        "country": "US",
        "language": "en",
        "device": "desktop",
        "search_volume": true,
        "num": 20,
        "analyze_content": true,
        "analyze_headings": true
    },
    "template_id": "<ID>",
    "outline_prompt_id": "<ID>",
    "reference": "<REF>"
}

Explanation of Key Parameters:

• keywords (Required): List of keywords for which briefs should be generated.
• parameters.search_engine: The search engine to use (default: “google.com”).
• parameters.location: Location data to refine the search (e.g., “New York, NY”); set to null if not applicable.
• parameters.country: Country code for the search (e.g., “US”).
• parameters.language: Language code for the search (e.g., “en”).
• parameters.device: Type of device for the search (e.g., “desktop” or “mobile”).
• parameters.search_volume: Whether to include search volume data (true or false).
• parameters.num: Number of results to analyze (1–100).
• parameters.analyze_content: Whether to analyze the page content (true or false).
• parameters.analyze_headings: Whether to analyze the page headings (true or false).
• template_id: ID of the template used for generating content briefs.
• outline_prompt_id: ID of the prompt used to outline the content brief.
• reference (Optional): Custom reference ID for tracking purposes.
  

API Response

Upon successfully initiating a bulk request, you’ll receive the following response:

{
   "message": "Bulk API initiated successfully",
   "success": true,
   "id": "670a7acabcfc2555366172ea",
   "credits": {
       "free": 5,
       "paid": 0,
       "sub": 500
   }
}

• id: Unique ID of the process.
• credits: Shows remaining credits.

Since the process can take longer than 30 seconds, the thruuu API will notify your webhook endpoint with a JSON object containing the results.

Setting Up a Webhook Endpoint

Below is an example in NodeJS to configure an HTTP POST endpoint to receive data from the thruuu API.

const express = require('express');
const app = express();
 
// Match the raw body to content type application/json
// If you are using Express v4 - v4.16 you need to use body-parser, not express, to retrieve the request body

app.post('/test-webhook', express.json({ type: 'application/json', limit: '50MB' }), async (req, res) => {
 console.log('request from thruuu is coming');
 if (req.body !== undefined && req.body.data !== undefined) {
   console.log(`event type:${req.body.data.eventType}`);
   console.log(`data: ${req.body.data}`);
 }
 // Return a response to acknowledge receipt of the event
 res.json({ received: true });
});
 
app.listen(8000, () => console.log('Running on port 8000'));

Results

Once your webhook receives a notification, you’ll get a response with the data in the following format:

{
  "eventType": "bulk-brief",
  "id": "670a9411a237576baf4a7135",
  "briefs": [
    {
      "id": "670a9426f5a0ccf086712534",
      "label": "brief example",
      "keyword": "brief example",
      "status": "Draft",
      "relatedSERP": "<SERP ID>",
      "contentBlock": [/* Array data here */],
      "creationDate": "2024-10-12T15:22:14.360Z",
      "modificationDate": "2024-10-12T15:22:14.360Z"
    }
  ]
}

Key Elements

• eventType: Specifies this is a "bulk-brief" event.
• id: Process ID for this request.
• briefs: Array of brief objects, each generated for a keyword:
  • id: Unique ID of the brief.
  • label: Label for the brief.
  • keyword: Keyword the brief was generated for.
  • status: Current status of the brief (e.g., "Draft").
  • relatedSERP: ID of related SERP data.
  • contentBlock: Array of content blocks generated for the brief.
  • creationDate: Creation date of the brief.
  • modificationDate: Last modification date of the brief.

Detailed Content Block Data Object

The contentBlock array contains elements from the brief template, such as Writer Directive, Article Summary, and Outline. Each element includes detailed information.

To learn more about the Content Block Object and inner objects, read this document.

The Content Brief API offers additional endpoints to retrieve all the content brief, template and outline.

Get List of Content Briefs

Endpoint

• URL: https://api.thruuu.com/api/v2/briefs
• Method: GET

Description

Returns a paginated list of content briefs created by the user. Each brief includes summary information such as its unique ID and label.

Query Parameters

• page: The page number for pagination (optional, default: 1).
• itemsPerPage: The number of items per page (optional, default: 100).

Example Request

GET /api/v2/briefs?page=1&itemsPerPage=20

Get a Single Content Brief by ID

Endpoint

• URL: https://api.thruuu.com/api/v2/briefs/:id
• Method: GET

Description

Retrieves detailed information for a single content brief by its unique ID.

Path Parameter

• id: The unique identifier for the content brief you want to retrieve.

Example Request:

GET /api/v2/briefs/<brief_id>

Get List of Brief Templates

Endpoint

• URL: https://api.thruuu.com/api/v2/brief-templates
• Method: GET

Description

Retrieves a list of available brief templates, including each template’s unique ID and label.

Get List of Outline Formats

Endpoint

• URL: https://api.thruuu.com/api/v2/brief-outline-formats
• Method: GET

Description

Retrieves a list of available outline formats, including each format’s unique ID and name.