Articles

Generate one SEO article

Enqueues end-to-end generation of ONE article for a topic and/or primary keyword (at least one required; the other is derived). Returns 202 with an article_id to poll at GET /v1/articles/{article_id}. The article is research-grounded, QA-checked, and returned as draft markdown — it is NEVER auto-published (fetch the content and publish it yourself). Only one API article may generate per project at a time (409 article_in_progress). Sandbox trial: 2 articles per key, watermarked as draft-only. Non-sandbox projects: included with an active subscription; without one, LIVE keys pay per unit from the prepaid credit balance (article_generated = 15 credits — 402 insufficient_credits when the balance is short; credit-funded articles stay draft-only). Typical completion: 10–30 minutes; poll every 60s.

post/v1/projects/{projectId}/articles

Request

  • Base URL: https://serp-agent.com
  • URL: https://serp-agent.com/v1/projects/{projectId}/articles
  • Auth: HTTP bearer

Path parameters

projectIdstring required

Project id.

Headers

Idempotency-Keystring

Any unique string (max 200 chars). Retrying a request with the same key replays the stored response verbatim (with header Idempotent-Replayed: true) instead of re-executing — including one-time secrets in the original body. Keys are scoped per account (per client IP on the unauthenticated signup) and pruned after 24h. Reusing a key on a different endpoint returns 409 idempotency_conflict.

Request body

topicstring

Working title / topic. Placed verbatim as the article's planned title.

primary_keywordstring

Target keyword. Derived from topic (lowercased) when omitted.

Response

Article generation queued. Poll the poll path.

article_idstring required
status'queued' required
pollstring required

Path to poll: GET /v1/articles/{article_id}.

Changes

No recorded changes to this operation across all 1 revision of this API.