API Documentation

Access Forest SEO programmatically with our REST API. Automate content generation, manage keywords, and integrate Forest SEO into your workflows.

API Resources

---

Quick Start

1. Get Your API Key

Generate an API key from your Forest SEO dashboard:

# Navigate to Settings → API Keys
# Click "Create New API Key"
# Copy and securely store your key

2. Make Your First Request

# Test authentication
curl -X GET https://api.forestseo.com/v1/projects \
  -H "Authorization: API-Key YOUR_API_KEY_HERE"

3. Generate Content

# Create content from a keyword
curl -X POST https://api.forestseo.com/v1/content/generate \
  -H "Authorization: API-Key YOUR_API_KEY_HERE" \
  -H "X-Project-ID: your-project-id" \
  -H "Content-Type: application/json" \
  -d '{
    "keyword": "how to train a puppy",
    "language": "en"
  }'

---

API Capabilities

📝 Content Management

• Generate Content - Create SEO-optimized articles from keywords
• List Content - Retrieve all generated content
• Get Content - Fetch specific content by ID
• Update Content - Edit content before publishing
• Delete Content - Remove unwanted content

🎯 Keyword Operations

• Add Keywords - Import keywords individually or in bulk
• List Keywords - Retrieve all keywords with metadata
• Create Clusters - Group related keywords
• Manage Schedules - Automate content generation

🔌 Integration Control

• List Integrations - Get connected platforms
• Test Connection - Verify integration health
• Publish Content - Send content to connected platforms

📊 Analytics & Monitoring

• Usage Stats - Track API usage and rate limits
• Content Performance - Monitor published content metrics
• Billing Info - Check wallet balance and usage

---

Authentication

All API requests require an API key in the Authorization header:

Authorization: API-Key YOUR_API_KEY_HERE

API keys are tied to your account and have full access to your projects. Keep them secure and rotate regularly.

Learn more about authentication →

---

Base URL

https://api.forestseo.com/v1

All endpoints are versioned and use HTTPS for secure communication.

---

Rate Limits

• Free Tier - 100 requests/hour
• Pro Plan - 1,000 requests/hour
• Enterprise - Custom limits available

Rate limit headers are included in all responses:

X-RateLimit-Limit: 1000
X-RateLimit-Remaining: 999
X-RateLimit-Reset: 1640000000

---

Response Format

All API responses use JSON format and return data directly:

Success Response (Single Resource)

{
  "id": "content_123",
  "title": "How to Train a Puppy",
  "status": "draft",
  "slug": "how-to-train-a-puppy",
  "created_at": "2025-12-15T10:30:00Z",
  "updated_at": "2025-12-15T10:30:00Z"
}

Paginated Response (List)

{
  "items": [
    {
      "id": "content_123",
      "title": "How to Train a Puppy",
      "status": "draft"
    }
  ],
  "total": 100,
  "page": 1,
  "size": 20,
  "pages": 5
}

Error Response

Validation errors:

{
  "detail": [
    {
      "loc": ["body", "title"],
      "msg": "field required",
      "type": "value_error.missing"
    }
  ]
}

General errors:

{
  "detail": "Not found"
}

---

Interactive Documentation

Explore all endpoints with our OpenAPI-powered interactive docs:

---

Code Examples

Examples available in multiple languages:

• cURL - Command-line testing
• Python - Using requests library
• JavaScript - Using fetch or axios
• PHP - Using Guzzle or cURL

View all examples in API Endpoints →

---

Need Help?

• Troubleshooting - Common API issues
• Support - Contact our team
• Tutorials - Learn by doing
• Features - Explore platform capabilities