The ScribePilot API is organized around REST. Our API has predictable resource-oriented URLs, accepts form-encoded request bodies, returns JSON-encoded responses, and uses standard HTTP response codes, authentication, and verbs.

POST/v1/generate

Start Generation

Start async blog post generation. Returns a runId and statusUrl immediately. Poll the statusUrl for progress.

GET/v1/generate/status?runId={runId}

Get Generation Status

Poll for generation progress using the runId from POST /generate. Returns status, currentStep, and progress (0-100). Use the statusUrl from the POST response for best results.

POST/v1/generate/cancel

Cancel Generation

Cancel an in-progress generation. Reserved credits are refunded.

GET/v1/credits

Get Credit Balance

Get your current credit balance and pricing information.

GET/v1/posts

List Posts

Retrieve a list of all generated posts with their status and metadata.

GET/v1/posts/{id}

Get Post

Retrieve the full content and details of a specific post.

PATCH/v1/posts/{id}

Update Post

Update a post (e.g., change status to published).

DELETE/v1/posts/{id}

Delete Post

Permanently delete a post.

Base URL

https://www.scribepilot.ai/api

Endpoints