Create or reuse an async job archive download

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.

Authentication

AuthorizationBearer

Unrestricted secret sk_live_... or Cognito access token in Authorization: Bearer ...

Path parameters

jobIdstringRequired

Async job identifier.

Response

Archive download request accepted

jobIdstring

statusenum

expiresAtdatetime or null

downloadUrlstring or nullformat: "uri"

retryAfterSecondsinteger or null

errorstring or null

Errors

401

Unauthorized Error

404

Not Found Error

409

Conflict Error

500

Internal Server Error

1	import { SegmentationAPIClient } from "@segmentationapi/sdk";
2
3	async function main() {
4	const client = new SegmentationAPIClient({
5	token: "YOUR_TOKEN_HERE",
6	});
7	await client.jobs.createJobDownload({
8	jobId: "jobId",
9	});
10	}
11	main();

1	{
2	"jobId": "string",
3	"status": "pending",
4	"expiresAt": "2024-01-15T09:30:00Z",
5	"downloadUrl": "string",
6	"retryAfterSeconds": 1,
7	"error": "string"
8	}