Skip to content
Brainpercent LogoAPI Docs
Dashboard

Quick Start

Get up and running with the Brainpercent API in under 5 minutes.

Step 1: Create an API Key

Go to Developer Settings in your dashboard and create a new API key. Copy the key — it will only be shown once.

Step 2: Make Your First Request

Let's list your articles to verify everything works:

curl https://brainpercent.app/api/v1/articles \
  -H "Authorization: Bearer bp_your_api_key_here"

Step 3: Check the Response

A successful response returns your articles with pagination metadata:

200Response
{
  "success": true,
  "data": [
    {
      "id": "550e8400-e29b-41d4-a716-446655440000",
      "title": "10 SEO Tips for 2026",
      "slug": "10-seo-tips-2026",
      "status": "published",
      "meta_description": "Discover the top SEO strategies for 2026...",
      "created_at": "2026-01-15T10:30:00Z",
      "updated_at": "2026-01-20T14:00:00Z",
      "project_id": null
    }
  ],
  "pagination": {
    "total": 1,
    "page": 1,
    "limit": 20,
    "total_pages": 1,
    "has_more": false
  },
  "meta": {
    "timestamp": "2026-02-01T00:00:00Z"
  }
}

Step 4: Generate an Article

Now generate your first article via the API:

curl -X POST https://brainpercent.app/api/v1/articles/generate \
  -H "Authorization: Bearer bp_your_api_key_here" \
  -H "Content-Type: application/json" \
  -d '{
    "topic": "The Future of AI in Content Marketing",
    "keywords": ["AI", "content marketing", "SEO"],
    "tone": "professional",
    "length": "long"
  }'
202Generation started
{
  "success": true,
  "data": {
    "article_id": "550e8400-e29b-41d4-a716-446655440001",
    "status": "generating"
  },
  "meta": {
    "timestamp": "2026-02-01T00:00:00Z"
  }
}

Step 5: Generate Social Content

Create social media posts from your article. This generates platform-optimized content for Twitter and LinkedIn:

curl -X POST https://brainpercent.app/api/v1/social/generate \
  -H "Authorization: Bearer bp_your_api_key_here" \
  -H "Content-Type: application/json" \
  -d '{
    "source_url": "https://brainpercent.app/articles/the-future-of-ai-in-content-marketing",
    "platforms": ["twitter", "linkedin"],
    "tone": "professional"
  }'
202Social content generation started
{
  "success": true,
  "data": {
    "items": [
      {
        "id": "d5b2f9c3-a0e4-5f8b-c6d7-2e3f4a5b6c7d",
        "platform": "twitter",
        "status": "generating"
      },
      {
        "id": "e6c3a0d4-b1f5-6a9c-d7e8-3f4a5b6c7d8e",
        "platform": "linkedin",
        "status": "generating"
      }
    ],
    "status": "generating",
    "credits_charged": 18
  }
}

Step 6: Check Your Credit Balance

Monitor your credit usage to plan your content generation:

curl https://brainpercent.app/api/v1/user/credits \
  -H "Authorization: Bearer bp_your_api_key_here"
200Credit balance
{
  "success": true,
  "data": {
    "available_credits": 792,
    "subscription_credits": 1000,
    "purchased_credits": 0,
    "credits_used_this_month": 208,
    "plan": "Pro",
    "current_period_end": "2026-03-01T00:00:00Z"
  }
}

Step 7: Monitor API Usage

Track your API requests and rate limit status:

curl https://brainpercent.app/api/v1/user/usage \
  -H "Authorization: Bearer bp_your_api_key_here"

Next Steps