Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.smartlyq.com/llms.txt

Use this file to discover all available pages before exploring further.

​
Overview

Some API operations (article generation, video creation, image generation) are asynchronous. Instead of returning the result immediately, the API returns a job_id that you poll until the result is ready.

​
Job lifecycle

POST /articles/generate
     │
     ▼
202 Accepted → { "job_id": "job_abc123", "status": "pending" }
     │
     ▼  (poll every 3-5 seconds)
GET /jobs/job_abc123
     │
     ├── { "status": "processing" }   ← still working
     ├── { "status": "completed", "result": { ... } }  ← done
     └── { "status": "failed", "error": { ... } }  ← error

​
Polling for results

curl https://api.smartlyq.com/v1/jobs/job_abc123 \
  -H "Authorization: Bearer sqk_live_xxxxxxxxxxxx"

​
Job statuses

StatusMeaning
pendingQueued, not yet started
processingActively running
completedDone — result field contains the output
failedError — error field explains what went wrong
cancelledJob was cancelled via POST /jobs/{job_id}/cancel

​
Webhooks (alternative)

Instead of polling, configure a webhook to receive a notification when the job completes.