Crevior API

API Documentation

Use the Crevior API to create article generation tasks and retrieve generated article results from your own backend system.

The public API uses short English enum values such as en, zh, us, and cn. Internally, Crevior maps them to the workflow parameters required by the article generation engine.

Base URL

https://crevior.com

Authentication

All API requests require an API key. You can find your private API key in your dashboard after logging in.

X-API-Key: YOUR_API_KEY

Bearer authentication is also accepted:

Authorization: Bearer YOUR_API_KEY

Keep your API key private. Do not expose it in frontend JavaScript, mobile apps, browser code, or public repositories.

1. Create Article Generation Task

This endpoint creates a new article generation task. The API returns a task number immediately. Article generation runs asynchronously.

Endpoint

POST https://crevior.com/api/articles/generate

Headers

Content-Type: application/json
X-API-Key: YOUR_API_KEY

Request Body

{
  "keyword": "women shoes",
  "language": "en",
  "market": "us",
  "wordRange": "1000-2000",
  "tone": "info",
  "readability": "middle",
  "perspective": "second",
  "genFaq": true,
  "genKeyTakeaways": true
}

Parameter	Type	Required	Description
keyword	string	Yes	Main SEO keyword or article topic. Max 300 characters.
language	enum	No	Allowed values: en = English, zh = Chinese. Default: en.
market	enum	No	Allowed values: us = United States, cn = China. Default: us.
wordRange	enum	No	Allowed values: 800-1000, 1000-2000, 2000-3000. Default: 1000-2000.
tone	enum	No	Allowed values: info, formal, casual, persuasive, inspiring, fun. Default: info.
readability	enum	No	Allowed values: middle, high, college. Default: middle.
perspective	enum	No	Allowed values: first, second, third. Default: second.
genFaq	boolean	No	Whether to generate FAQ content. Default: true.
genKeyTakeaways	boolean	No	Whether to generate key takeaways. Default: true.

Enum Values

Field	Allowed Values
language	en, zh
market	us, cn
wordRange	800-1000, 1000-2000, 2000-3000
tone	info, formal, casual, persuasive, inspiring, fun
readability	middle, high, college
perspective	first, second, third

Success Response

{
  "success": true,
  "task_no": "AT20260630121200123",
  "status": "Pending",
  "estimated_words": 2000,
  "request": {
    "keyword": "women shoes",
    "language": "en",
    "market": "us",
    "word_range": "1000-2000",
    "tone": "info",
    "readability": "middle",
    "perspective": "second"
  }
}

Validation Error Response

{
  "success": false,
  "message": "Invalid market. Allowed values: us, cn.",
  "allowed_values": {
    "language": ["en", "zh"],
    "market": ["us", "cn"],
    "wordRange": ["800-1000", "1000-2000", "2000-3000"],
    "tone": ["info", "formal", "casual", "persuasive", "inspiring", "fun"],
    "readability": ["middle", "high", "college"],
    "perspective": ["first", "second", "third"]
  }
}

2. Query Article Task Result

Use this endpoint to check task status. When the status is Completed, the response includes the generated article.

Endpoint

GET https://crevior.com/api/articles/tasks/{taskNo}

Headers

X-API-Key: YOUR_API_KEY

Processing Response

{
  "success": true,
  "task": {
    "task_no": "AT20260630121200123",
    "keyword": "women shoes",
    "language": "en",
    "word_range": "1000-2000",
    "status": "Processing",
    "article_id": null,
    "used_words": 0,
    "error_message": null,
    "created_at": "2026-06-30T12:12:00",
    "completed_at": null
  },
  "article": null
}

Completed Response

{
  "success": true,
  "task": {
    "task_no": "AT20260630121200123",
    "keyword": "women shoes",
    "language": "en",
    "word_range": "1000-2000",
    "status": "Completed",
    "article_id": 123,
    "used_words": 1580,
    "error_message": null,
    "created_at": "2026-06-30T12:12:00",
    "completed_at": "2026-06-30T12:18:00"
  },
  "article": {
    "id": 123,
    "title": "The Ultimate Women's Shoes Guide",
    "keyword": "women shoes",
    "language": "en",
    "meta_title": "The Ultimate Women's Shoes Guide",
    "meta_description": "Find the best women's shoes for comfort, style, and daily wear.",
    "content_markdown": "# The Ultimate Women's Shoes Guide\n\nMarkdown article content...",
    "content_html": "<h2>The Ultimate Women's Shoes Guide</h2><p>HTML article content...</p>",
    "used_words": 1580,
    "created_at": "2026-06-30T12:18:00"
  }
}

Content Fields

content_markdown is the original Markdown content. Use it if you want to edit the article, store it in your CMS, transform it yourself, or publish it through a Markdown-based workflow.

content_html is the rendered HTML content. Use it if you want to display the article directly in a web page or import it into an HTML-based CMS.

The API returns an HTML article fragment, not a full HTML document with <html>, <head>, and <body>.

Failed Response

{
  "success": true,
  "task": {
    "task_no": "AT20260630121200123",
    "keyword": "women shoes",
    "language": "en",
    "word_range": "1000-2000",
    "status": "Failed",
    "article_id": null,
    "used_words": 0,
    "error_message": "We couldn’t generate this article. Please try again later.",
    "created_at": "2026-06-30T12:12:00",
    "completed_at": "2026-06-30T12:20:00"
  },
  "article": null
}

Status Values

Status	Meaning
Pending	The task has been created and is waiting to be submitted.
Processing	The task has been submitted and is being generated.
Completed	The article has been generated successfully.
Failed	The task failed. Check error_message for a safe user-facing message.

cURL Examples

Create Task

curl -X POST "https://crevior.com/api/articles/generate" \
  -H "Content-Type: application/json" \
  -H "X-API-Key: YOUR_API_KEY" \
  -d '{
    "keyword": "women shoes",
    "language": "en",
    "market": "us",
    "wordRange": "1000-2000",
    "tone": "info",
    "readability": "middle",
    "perspective": "second",
    "genFaq": true,
    "genKeyTakeaways": true
  }'

Query Task

curl -X GET "https://crevior.com/api/articles/tasks/AT20260630121200123" \
  -H "X-API-Key: YOUR_API_KEY"