RankStudio API

Integrate AI search optimization into your workflow with the RankStudio API.

Note: API access is available for Enterprise customers only.

curl https://api.rankstudio.net/v1/articles \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json"

{
  "status": "success",
  "data": {
    "articles": [...]
  }
}

API Overview

The RankStudio API allows you to:

Create and manage content requests programmatically
Retrieve article status and content
Access analytics and performance data
Manage your account and team
Receive webhook notifications for events

Technology

RESTful API with JSON responses

Authentication

API key-based authentication

Protocol

HTTPS only (TLS 1.3)

Getting Started

Get API Access

API access is included with Enterprise plans.

Contact Enterprise Sales

Generate API Key

Once you have Enterprise access:

Log in to your dashboard
Go to Account Settings → API
Click "Generate New API Key"
Store your key securely (shown only once)

Make Your First Request

curl https://api.rankstudio.net/v1/articles \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json"

API Endpoints

Articles

GET/v1/articles

Retrieve all articles for your account.

Parameters:

status (optional): Filter by status
limit (optional): Number of results (default: 20, max: 100)
offset (optional): Pagination offset

GET/v1/articles/{article_id}

Retrieve details for a specific article.

POST/v1/articles

Request a new article.

Parameters:

topic (required): Article topic/title
description (optional): Additional context
target_keywords (optional): Array of keywords
priority (optional): normal, high (default: normal)

PATCH/v1/articles/{article_id}

Update article metadata or request revisions.

DELETE/v1/articles/{article_id}

Delete an article (pending or draft only).

Analytics

GET/v1/analytics

Retrieve performance analytics.

Parameters:

start_date (optional): Start date (ISO 8601)
end_date (optional): End date (ISO 8601)
metric (optional): Specific metric to retrieve

Account

GET/v1/account

Retrieve account details and usage.

GET/v1/account/usage

Retrieve detailed usage statistics.

Webhooks

Receive real-time notifications when events occur

Supported Events

•article.created - New article requested
•article.in_progress - Article creation started
•article.completed - Article ready for review
•article.published - Article marked as published
•account.usage_alert - Usage threshold reached

Webhook Setup

Go to Account Settings → Webhooks
Add webhook URL
Select events to receive
Save configuration

Example Webhook Payload:

{
  "event": "article.completed",
  "timestamp": "2025-10-10T15:30:00Z",
  "data": {
    "article_id": "art_123abc",
    "title": "Understanding AI Search Optimization",
    "status": "completed"
  }
}

SDKs & Libraries

Official SDKs for popular programming languages

JavaScript/Node.js

npm install @rankstudio/node

Python

pip install rankstudio

Ruby

gem install rankstudio

PHP

composer require rankstudio/php

Node.js Example

const RankStudio = require('@rankstudio/node');

const client = new RankStudio('YOUR_API_KEY');

// Create article
const article = await client.articles.create({
  topic: 'AI Search Optimization Best Practices',
  description: 'Comprehensive guide for marketers'
});

console.log('Article created:', article.id);

// List articles
const articles = await client.articles.list({
  status: 'completed',
  limit: 10
});

console.log('Completed articles:', articles.length);

Rate Limits & Quotas

Request Limits

• Hourly: 1,000 requests
• Daily: 10,000 requests
• Custom limits available

Monitoring

Check rate limit headers in every response:

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

Security

API Key Security

Best Practices:

• Store keys in environment variables
• Never commit keys to repositories
• Rotate keys regularly
• Use separate keys per environment
• Revoke compromised keys immediately

Encryption

• All API traffic over HTTPS (TLS 1.3)
• Perfect forward secrecy
• No mixed content allowed

FAQ

Q: Is the API included in all plans?

A: No, API access is only available for Enterprise customers.

Q: What's the API uptime SLA?

A: 99.9% uptime guaranteed for Enterprise customers.

Q: Can I use the API for testing?

A: Yes, Enterprise customers can use separate API keys for testing and production.

Q: Are there any usage costs beyond my plan?

A: No, API usage is included in your Enterprise plan.

Q: Can I request custom endpoints?

A: Yes, contact your account manager for custom endpoint requests.

Q: How do I report API bugs?

A: Email [email protected] with details and example requests.

Get API Access

API access is available for Enterprise customers.

Contact Enterprise Sales Email: [email protected]

Resources

Enterprise Plans|Security Practices|Terms of Service|Contact Support

API Version: v1

Base URL: https://api.rankstudio.net/v1