Tasks
Tasks represent article generation jobs. You create a task with your inputs, and the pipeline runs in the background.Create task
POST /api/v1/tasks
Start a new article generation task.
| Field | Type | Required | Description |
|---|---|---|---|
user_prompt | string | Yes | Article topic and instructions (1—1,000 characters) |
keywords | array of strings | No | Target keywords (max 10) |
reference_links | array of strings | No | Reference URLs (max 5) |
uploaded_files | array | No | Uploaded file metadata (PDF, DOCX, CSV, XLSX, TXT) |
min_words | integer | No | Minimum word count (100—10,000) |
max_words | integer | No | Maximum word count (100—10,000) |
202 Accepted with task_id and status pending.
The generation pipeline runs in the background: web research, reference extraction, file processing, outline, drafting, and SEO optimization.
List tasks
GET /api/v1/tasks
List your generation tasks.
| Param | Type | Description |
|---|---|---|
status | string | Filter by status: pending, processing, completed, failed, cancelled |
limit | integer | Results per page (1—100) |
offset | integer | Pagination offset |
Get task
GET /api/v1/tasks/:task_id
Get the status and details of a specific task.
Cancel task
DELETE /api/v1/tasks/:task_id
Cancel a pending or processing task.
Get task articles
GET /api/v1/tasks/:task_id/articles
Get all articles generated by a task.
Articles
Articles are the output of completed generation tasks.List articles
GET /api/v1/articles
List your generated articles with pagination.
| Param | Type | Description |
|---|---|---|
publication_status | string | Filter: draft, published, or archived |
page | integer | Page number |
page_size | integer | Results per page |
Get article
GET /api/v1/articles/:article_id
Get the full article content and metadata.
Update article
PATCH /api/v1/articles/:article_id
Update an article’s content or metadata.
published records the publication timestamp.
Delete article
DELETE /api/v1/articles/:article_id
Permanently delete an article.
Task statuses
| Status | Meaning |
|---|---|
pending | Task created, waiting to start |
processing | Pipeline is running |
completed | Article generated successfully |
failed | An error occurred during generation |
cancelled | Task was cancelled by the user |
Error codes
| Code | Description |
|---|---|
VALIDATION_ERROR | Invalid input parameters |
TASK_NOT_FOUND | Task ID does not exist or you don’t have access |
ARTICLE_NOT_FOUND | Article ID does not exist or you don’t have access |
LLM_ERROR | AI model error during generation |
WORKFLOW_ERROR | Pipeline step failed |
DATABASE_ERROR | Storage error |
RATE_LIMIT_ERROR | Too many concurrent requests |