Create an asynchronous segmentation job (image or video)

Queue an image or video segmentation job from previously uploaded task IDs and text prompts. The job runs asynchronously. Poll retrieveJob until status is success, then fetch masks with retrieveJobResult or createJobDownload. Auth is required; there is no anonymous API.

Authentication

AuthorizationBearer

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

Request

This endpoint expects an object.

imageobjectRequired

videoobjectRequired

Response

Job accepted

jobIdstring

typeenum

totalItemsinteger>=1

trialobjectOptional

Errors

400

Bad Request Error

401

Unauthorized Error

402

Payment Required Error

403

Forbidden Error

409

Conflict Error

500

Internal Server Error

502

Bad Gateway Error

503

Service Unavailable 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.createJob({
8	type: "image",
9	prompts: [
10	"string",
11	],
12	tasks: [
13	"a1b2c3d4-e5f6-7890-abcd-ef1234567890.png",
14	"b2c3d4e5-f6a7-8901-bcde-f12345678901.jpg",
15	],
16	});
17	}
18	main();