Skip to main content
GET
/
api
/
job-status
/
:jobId
Get Job Status
curl --request GET \
  --url https://api.example.com/api/job-status/:jobId
{
  "error": "Job ID is required"
}

Endpoint

GET /api/job-status/:jobId

Authentication

No authentication required.

Path Parameters

jobId
string
required
The unique identifier of the job returned from the content generation endpoint

Response

success
boolean
Indicates if the request was successful
data
object

Example Request

curl https://api.distylia.com/api/job-status/550e8400-e29b-41d4-a716-446655440000

Example Response

{
  "success": true,
  "data": {
    "id": "550e8400-e29b-41d4-a716-446655440000",
    "status": "processing",
    "type": "text",
    "format": "carousel",
    "filename": null,
    "progress": 45,
    "createdAt": "2024-01-08T10:30:00.000Z",
    "updatedAt": "2024-01-08T10:30:45.000Z",
    "errorMessage": null
  }
}

Status Values

StatusDescription
pendingJob is queued and waiting to start
processingJob is currently being processed
completedJob finished successfully
failedJob encountered an error

Polling Recommendations

  • Poll every 5-10 seconds for status updates
  • Stop polling once status is completed or failed
  • Use exponential backoff if implementing automatic polling

Error Responses

{
  "error": "Job ID is required"
}