Retrieve a completed segmentation job result

GET

https://api.segmentationapi.com/v1/jobs/:jobId/result

GET

/v1/jobs/:jobId/result

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.retrieveJobResult({
8         jobId: "jobId",
9     });
10 }
11 main();

1 {
2   "manifest": {
3     "type": "image",
4     "items": [
5       {
6         "taskId": "string",
7         "inputId": "string",
8         "units": 1,
9         "generatedAt": "2024-01-15T09:30:00Z",
10         "masks": [
11           {
12             "maskIndex": 1,
13             "confidence": 1.1,
14             "url": "string"
15           }
16         ],
17         "previewUrl": "string"
18       }
19     ],
20     "jobId": "string",
21     "prompts": [
22       "string"
23     ]
24   },
25   "assets": [
26     {
27       "key": "string",
28       "url": "string"
29     }
30   ],
31   "expiresIn": 1
32 }

Returns the result manifest with short-lived signed URLs for owned output assets.

Authentication

AuthorizationBearer

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

Path parameters

jobIdstringRequired

Async job identifier.

Response

Completed result manifest and signed assets

manifestobject

assetslist of objects

expiresIninteger>=60

Errors

401

Unauthorized Error

404

Not Found Error

409

Conflict Error

500

Internal Server Error