Skip to main content
The Content Editor API provides AI-powered content analysis and optimization suggestions.

Analyze Content

This endpoint requires authentication.

POST /api/v1/tools/content-editor/analyze

Analyze content text for a target keyword and receive optimization recommendations.
text
string
required
The content text to analyze (HTML or plain text)
keyword
string
required
The target keyword to optimize for

Response

score
integer
Overall optimization score (0-100)
summary
string
Brief summary of the analysis results
pillars
object
Detailed scoring across key optimization pillars
suggestions
array
List of actionable optimization suggestions
missing_entities
array
List of important entities or topics missing from the content

Example Request

curl -X POST https://api.example.com/api/v1/tools/content-editor/analyze \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "text": "<h1>SEO Best Practices</h1><p>Search engine optimization is crucial for online visibility...</p>",
    "keyword": "SEO best practices"
  }'

Example Response

{
  "score": 78,
  "summary": "Good keyword usage and structure. Consider improving readability and adding related entities.",
  "pillars": {
    "keyword_usage": {
      "score": 85,
      "density": 2.3,
      "in_title": true,
      "in_headings": 2
    },
    "readability": {
      "score": 72,
      "avg_sentence_length": 18,
      "complex_words": 12
    },
    "structure": {
      "score": 80,
      "h1_count": 1,
      "h2_count": 4,
      "paragraph_count": 8
    },
    "entities": {
      "score": 65,
      "found": 8,
      "expected": 12
    }
  },
  "suggestions": [
    {
      "type": "keyword",
      "message": "Add target keyword to the first paragraph",
      "priority": "high"
    },
    {
      "type": "readability",
      "message": "Break down long sentences for better readability",
      "priority": "medium"
    },
    {
      "type": "structure",
      "message": "Add more H2 headings to improve content structure",
      "priority": "medium"
    }
  ],
  "missing_entities": [
    "meta tags",
    "backlinks",
    "page speed",
    "mobile optimization"
  ]
}

Use Cases

Real-time Content Optimization

Use this endpoint in a content editor UI to provide real-time feedback as users write:
// Debounced analysis on content change
const analyzeContent = async (text, keyword) => {
  const response = await fetch('/api/v1/tools/content-editor/analyze', {
    method: 'POST',
    headers: {
      'Authorization': `Bearer ${token}`,
      'Content-Type': 'application/json'
    },
    body: JSON.stringify({ text, keyword })
  });
  return response.json();
};

Bulk Content Audit

Analyze multiple pages to identify optimization opportunities across your site.

Error Codes

CodeDescription
401Missing or invalid authentication token
422Invalid request (missing text or keyword)
500Internal server error during analysis
The Content Editor API uses AI-powered natural language processing to analyze content quality and provide optimization suggestions.

Next Steps

Content Analysis

Advanced content analysis tools

Keywords API

Keyword research and suggestions

Build docs developers (and LLMs) love