Skip to main content
GET
/
context
/
diagram
/
convert
/
{jobId}
Get the results for converting an engineering diagram to an image
curl --request GET \
  --url https://{cluster}.cognitedata.com/api/v1/projects/{project}/context/diagram/convert/{jobId} \
  --header 'Authorization: Bearer <token>'
{
  "jobId": 123,
  "createdTime": 1730204346000,
  "startTime": 1730204346000,
  "statusTime": 1730204346000,
  "items": [
    {
      "fileId": 1234,
      "results": [
        {
          "page": 1,
          "svgUrl": "https://storage.googleapis.com/cluster/1234/PH-ME-P-0004-001.svg",
          "pngUrl": "https://storage.googleapis.com/cluster/1234/PH-ME-P-0004-001.png"
        }
      ],
      "fileExternalId": "1234",
      "fileInstanceId": {
        "space": "space",
        "externalId": "externalId"
      }
    }
  ],
  "errorMessage": null,
  "grayscale": true
}

Documentation Index

Fetch the complete documentation index at: https://docs.cognite.com/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
Authorization
string
header
required

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.

Path Parameters

​
jobId
integer<int64>
required

Contextualization job ID.

Example:

123

Response

Success

​
jobId
integer<int64>
required

Contextualization job ID.

Example:

123

​
status
enum<string>
required

The status of the job.

Available options:
Queued,
Running,
Completed,
Failed
​
createdTime
integer<int64>
required

The number of milliseconds since 00:00:00 Thursday, 1 January 1970, Coordinated Universal Time (UTC), minus leap seconds.

Required range: x >= 0
Example:

1730204346000

​
startTime
integer<int64>
required

The number of milliseconds since 00:00:00 Thursday, 1 January 1970, Coordinated Universal Time (UTC), minus leap seconds.

Required range: x >= 0
Example:

1730204346000

​
statusTime
integer<int64>
required

The number of milliseconds since 00:00:00 Thursday, 1 January 1970, Coordinated Universal Time (UTC), minus leap seconds.

Required range: x >= 0
Example:

1730204346000

​
items
object[]

An array of converted results, returned when the job finished or failed partially.

​
errorMessage
string

If the job failed, some more information about the error cause.

Example:

null

​
grayscale
boolean
default:true

Return the SVG version in grayscale colors only (reduces the file size).

Example:

true

Last modified on June 2, 2026