Skip to content
SegmentationAPI

Get async segmentation job status

GET
/v1/jobs/{jobId}
curl --request GET \
  --url https://api.segmentationapi.com/v1/jobs/example \
  --header 'Authorization: Bearer <token>'

Return the current job status and per-task state. This response does not include masks. Poll until status is success or failed, then call retrieveJobResult or createJobDownload.

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
jobId
required
string

Async job identifier.

Responses

Section titled “Responses”

200

Section titled “200”

Current async job status

Media typeapplication/json
object
jobId
required
string
type
required
string
Allowed values: image video
processingMode
required
string
Allowed values: single batch video
status
required
string
Allowed values: queued processing success failed
totalItems
required
integer
>= 1
createdAt
required
string format: date-time
updatedAt
required
string format: date-time
error
string
nullable
tasks
required

Per-task results for the job

Array<object>
object
taskId
required
string
status
required
string
Allowed values: queued processing success failed
error
string
nullable
Example
{
  "jobId": "job-abc-987",
  "type": "image",
  "processingMode": "batch",
  "status": "processing",
  "totalItems": 2,
  "createdAt": "2026-08-03T12:00:00Z",
  "updatedAt": "2026-08-03T12:01:00Z",
  "tasks": [
    {
      "taskId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890.png",
      "status": "processing"
    },
    {
      "taskId": "b2c3d4e5-f6a7-8901-bcde-f12345678901.jpg",
      "status": "success"
    }
  ]
}

401

Section titled “401”

Authentication is missing, invalid, or expired

Media typeapplication/json
object
error
required
string
message
string
remainingTokens
integer
requestedTokens
integer
>= 1
expiresAt
string format: date-time
activeJobId
string
upgradeUrl
string format: uri
retryAfterSeconds
integer
>= 1
Examplegenerated
{
  "error": "example",
  "message": "example",
  "remainingTokens": 1,
  "requestedTokens": 1,
  "expiresAt": "2026-04-15T12:00:00Z",
  "activeJobId": "example",
  "upgradeUrl": "https://example.com",
  "retryAfterSeconds": 1
}

404

Section titled “404”

The requested resource was not found

Media typeapplication/json
object
error
required
string
message
string
remainingTokens
integer
requestedTokens
integer
>= 1
expiresAt
string format: date-time
activeJobId
string
upgradeUrl
string format: uri
retryAfterSeconds
integer
>= 1
Examplegenerated
{
  "error": "example",
  "message": "example",
  "remainingTokens": 1,
  "requestedTokens": 1,
  "expiresAt": "2026-04-15T12:00:00Z",
  "activeJobId": "example",
  "upgradeUrl": "https://example.com",
  "retryAfterSeconds": 1
}

500

Section titled “500”

Internal server error

Media typeapplication/json
object
error
required
string
message
string
remainingTokens
integer
requestedTokens
integer
>= 1
expiresAt
string format: date-time
activeJobId
string
upgradeUrl
string format: uri
retryAfterSeconds
integer
>= 1
Examplegenerated
{
  "error": "example",
  "message": "example",
  "remainingTokens": 1,
  "requestedTokens": 1,
  "expiresAt": "2026-04-15T12:00:00Z",
  "activeJobId": "example",
  "upgradeUrl": "https://example.com",
  "retryAfterSeconds": 1
}