API ReferenceJobs
Poll Job Status
Check the status of an async job and retrieve results when complete.
GET /api/v1/jobs/{id}
Check the status of an async job. When the job is complete, the result is included in the response.
Path Parameters
| Parameter | Type | Description |
|---|---|---|
id | string | The job ID returned by the async endpoint |
Example Request
curl https://api.usesoke.ai/api/v1/jobs/job_abc123def456 \
-H "X-Soke-Key: sk_live_your_api_key"Response (Processing)
{
"success": true,
"data": {
"jobId": "job_abc123def456",
"status": "processing",
"progress": 60
}
}Response (Completed)
{
"success": true,
"data": {
"jobId": "job_abc123def456",
"status": "completed",
"result": {
// Operation-specific results
}
}
}Response (Failed)
{
"success": true,
"data": {
"jobId": "job_abc123def456",
"status": "failed",
"error": {
"code": "PROCESSING_ERROR",
"message": "Failed to process the request."
}
}
}Job Statuses
| Status | Description |
|---|---|
queued | Waiting to be processed |
processing | Currently running |
completed | Finished — results in data.result |
failed | Failed — error in data.error |
See Async Jobs for polling best practices.