curl --request GET \
--url https://{cluster}.cognitedata.com/api/v1/projects/{project}/context/vision/segment/{jobId} \
--header 'Authorization: Bearer <token>'{
"status": "Queued",
"createdTime": 1730204346000,
"startTime": 1730204346000,
"statusTime": 1730204346000,
"jobId": 123,
"items": [
{
"fileId": 1234,
"segments": [
{
"score": 0.8,
"polygons": [
{
"vertices": [
{
"x": 0.5,
"y": 0.5,
"confidence": null
}
],
"confidence": null
}
]
}
],
"fileExternalId": "1234"
}
],
"prompt": {
"points": [
{
"x": 0.8,
"y": 0.8,
"label": 1
}
],
"boundingBox": {
"xMin": 0.1,
"yMin": 0.2,
"xMax": 0.5,
"yMax": 0.6
}
},
"errorMessage": null,
"failedItems": [
{
"errorMessage": "<string>",
"items": [
{
"fileId": 1234,
"fileExternalId": "1234",
"fileInstanceId": {
"space": "space",
"externalId": "externalId"
}
}
]
}
]
}Required capabilities:
filesAcl:READ
Retrieve results from a segmentation job on an image.
curl --request GET \
--url https://{cluster}.cognitedata.com/api/v1/projects/{project}/context/vision/segment/{jobId} \
--header 'Authorization: Bearer <token>'{
"status": "Queued",
"createdTime": 1730204346000,
"startTime": 1730204346000,
"statusTime": 1730204346000,
"jobId": 123,
"items": [
{
"fileId": 1234,
"segments": [
{
"score": 0.8,
"polygons": [
{
"vertices": [
{
"x": 0.5,
"y": 0.5,
"confidence": null
}
],
"confidence": null
}
]
}
],
"fileExternalId": "1234"
}
],
"prompt": {
"points": [
{
"x": 0.8,
"y": 0.8,
"label": 1
}
],
"boundingBox": {
"xMin": 0.1,
"yMin": 0.2,
"xMax": 0.5,
"yMax": 0.6
}
},
"errorMessage": null,
"failedItems": [
{
"errorMessage": "<string>",
"items": [
{
"fileId": 1234,
"fileExternalId": "1234",
"fileInstanceId": {
"space": "space",
"externalId": "externalId"
}
}
]
}
]
}Access token issued by the CDF project's configured identity provider. Access token must be an OpenID Connect token, and the project must be configured to accept OpenID Connect tokens. Use a header key of 'Authorization' with a value of 'Bearer $accesstoken'. The token can be obtained through any flow supported by the identity provider.
cdf version header. Use this to specify the requested CDF release.
"alpha"
Contextualization job ID.
123
Success
The status of the job.
Queued, Running, Completed, Failed The number of milliseconds since 00:00:00 Thursday, 1 January 1970, Coordinated Universal Time (UTC), minus leap seconds.
x >= 01730204346000
The number of milliseconds since 00:00:00 Thursday, 1 January 1970, Coordinated Universal Time (UTC), minus leap seconds.
x >= 01730204346000
The number of milliseconds since 00:00:00 Thursday, 1 January 1970, Coordinated Universal Time (UTC), minus leap seconds.
x >= 01730204346000
Contextualization job ID.
123
List of file IDs and their corresponding predictions.
Show child attributes
Input prompt used to segment the image.
Show child attributes
If the job failed, some more information about the error cause.
null
Show child attributes
Was this page helpful?