Sign In Get API Key
DEVELOPER DOCUMENTATION

BriefCraft REST API Reference

Programmatically execute network audits, extract TTFB latency, detect broken links, and synthesize Autonomous Remediation Briefs™ directly inside your CI/CD pipelines and client platforms.

Base URL

All production requests must be made over HTTPS. Plain HTTP requests are redirected.

https://briefcraftai.com/api

Authentication

API access is included in the Agency plan. Generate a key in Dashboard → Developer REST API (keys start with bc_live_ and are shown once), then send it in the Authorization header:

Authorization: Bearer bc_live_YOUR_API_KEY

Rotating a key in the dashboard immediately disables the previous one. Requests made with a key count toward your 10,000 requests / month.

POST

/api/audit

Executes a real-time HTTP crawler audit of the target URL, measures TTFB latency, verifies SSL protocol, checks internal links, and returns a BriefCraft Autonomous Remediation Brief™ in the aiPlan field.

Request Payload (JSON)

{ "url": "https://briefcraftai.com" }

cURL Example

curl -X POST https://briefcraftai.com/api/audit \ -H "Authorization: Bearer bc_live_YOUR_API_KEY" \ -H "Content-Type: application/json" \ -d '{"url": "https://briefcraftai.com"}'

Response (JSON)

{ "success": true, "data": { "url": "https://briefcraftai.com", "domain": "briefcraftai.com", "score": 94, "ttfbMs": 142, "status": 200, "isHttps": true, "headings": { "h1Count": 1, "h2Count": 8 }, "links": { "internalCount": 54, "deadLinks": [] } }, "aiPlan": { "scoreAssessment": "Optimal technical baseline detected.", "optimizedHead": { "suggestedTitle": "BriefCraft AI – Technical SEO & Directory Launch Suite" }, "criticalFixes": [], "quickWins": ["Implement WebP image optimization"] } }
GET

/api/directories

Retrieves the full catalog of high-DR startup directories and SaaS launchboards with live Ahrefs DR, pricing, and submission URLs.

curl -X GET https://briefcraftai.com/api/directories
POST

/api/ai/pitch-generator

Synthesizes multi-platform launch assets with the BriefCraft Autonomous Launch Synthesizer (Product Hunt tagline, directory elevator pitch, Show HN body, and founder launch day comment).

{ "name": "BriefCraft AI", "url": "https://briefcraft.ai", "description": "Automated technical crawler and SEO intelligence suite.", "audience": "Founders, agencies, and webmasters" }

Rate Limits & Quotas

Live audits count against your plan's monthly quota, which resets on the 1st of each month (UTC). When the quota is used up, POST /api/audit returns HTTP 403 with "code": "QUOTA_EXCEEDED".

  • • Free: 3 audits / month
  • • Starter: 25 audits / month
  • • Professional: 100 audits / month
  • • Agency: 250 audits / month, REST API access up to 10,000 requests / month