API Reference
Build custom integrations and automate your content workflow with the ScribePilot API.
Base URL
https://www.scribepilot.ai/api/v1
Quick Example
JavaScript
// Start async blog generation
const response = await fetch('https://www.scribepilot.ai/api/v1/generate', {
method: 'POST',
headers: {
'Authorization': 'Bearer YOUR_API_KEY',
'Content-Type': 'application/json',
},
body: JSON.stringify({
topic: 'The Future of AI in Content Marketing',
targetWordCount: 1500,
tone: 'professional',
quality: 'premium', // or 'economy' for budget-friendly (10x fewer credits)
}),
});
const { runId, creditsReserved, statusUrl } = await response.json();
// Poll for completion
const status = await fetch(statusUrl, {
headers: { 'Authorization': 'Bearer YOUR_API_KEY' },
});
console.log(await status.json()); // { status, progress, result }Available Endpoints
| Method | Endpoint | Description |
|---|---|---|
| POST | /api/v1/generate | Start async blog generation (returns runId) |
| GET | /api/v1/generate/status | Poll for generation progress |
| POST | /api/v1/generate/cancel | Cancel in-progress generation |
| GET | /api/v1/credits | Get credit balance and pricing |
| GET | /api/v1/posts | List all generated posts |
| GET | /api/v1/posts/:id | Get a specific post by ID |
| PATCH | /api/v1/posts/:id | Update a post (e.g. publish) |
| DELETE | /api/v1/posts/:id | Delete a post |
Generation Options
Complete list of preset values accepted by POST /api/v1/generate.
| Option | Values | Notes |
|---|---|---|
| tone | autoprofessionalconversationalauthoritativeeducationalpersuasivecustom string | Defaults to professional. Use a custom string like "witty but professional" when presets do not fit. |
| quality | premiumstandardeconomy | Defaults to standard. Premium uses Opus at 30 credits/word, standard uses Sonnet at 20, and economy uses Haiku at 10. |
| citationMode | nonebasicacademic | Defaults to none. |
| targetWordCount | 100–5000 | Defaults to 1500. Values outside the supported range are clamped. |
| maxAttempts | 1–5 | Defaults to 5 rewrite attempts. |
| length (legacy) | shortmediumlong | Maps to targetWordCount values of 800, 1500, and 2500. |
| category | TechnicalAI & Machine LearningBusinessMarketingDevelopmentCloud & InfrastructureSecurityDesignProductivityCareerGeneralcustom string | Free-text category used for organization and generation context. |
Rate Limits
| Plan | Requests per Hour |
|---|---|
| Starter | 10 |
| Pro | 100 |
| Growth | 500 |
| Agency | 1,000 |
Rate limits are applied per API key. Create multiple keys to segment your usage.
Need help with the API?
Our team is ready to assist with your integration.