API Reference

Complete API reference for Rampify's MCP server and REST API.

API Documentation

Authentication - API keys, security, and best practices
MCP Tools - Complete reference for all MCP tools

Quick Start

1. Generate API Key

Get your API key from the dashboard settings:

# Your key will look like this
sk_live_abc123def456...

2. Set Environment Variable

export RAMPIFY_API_KEY=sk_live_abc123...

3. Make Your First Request

curl https://api.rampify.ai/v1/mcp/get-seo-context \
  -H "Authorization: Bearer $RAMPIFY_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"domain": "example.com"}'

Available Endpoints

MCP Tools

All MCP tools are available via REST API:

POST /v1/mcp/get-seo-context - Get SEO context for a domain
POST /v1/mcp/scan-site - Trigger site scan
POST /v1/mcp/generate-meta - Generate meta tags
POST /v1/mcp/check-before-deploy - Pre-deployment checks (Starter+)
POST /v1/mcp/suggest-internal-links - Internal linking suggestions (Pro)

See MCP Tools Reference for details.

Rate Limits

Tier	Requests/Hour	Scans/Day
Free	100	1
Starter	1,000	10
Pro	10,000	Unlimited

Authentication

All requests require API key authentication:

Authorization: Bearer sk_live_abc123...

See Authentication Guide for details.

Error Handling

Errors follow this format:

{
  "error": {
    "type": "authentication_error",
    "message": "Invalid API key",
    "details": {}
  }
}

Common error types:

authentication_error - Invalid API key
rate_limit_error - Too many requests
validation_error - Invalid parameters
not_found_error - Resource not found
tier_required_error - Feature requires upgrade