Skip to content
SegmentationAPI

Create or reuse an async job archive download

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

Start or reuse a zip archive of a successful job’s outputs. Returns pending until the archive is built. The job must already be success; otherwise the API returns 409.

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
jobId
required
string

Async job identifier.

Responses

Section titled “Responses”

202

Section titled “202”

Archive download request accepted

Media typeapplication/json
object
jobId
required
string
status
required
string
Allowed values: pending processing ready failed
expiresAt
required
string format: date-time
nullable
downloadUrl
required
string format: uri
nullable
retryAfterSeconds
required
integer
nullable
error
required
string
nullable
Example
{
  "status": "pending"
}

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
}

409

Section titled “409”

Request conflicts with the current resource state

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
}