How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
Cognite

Cognite Engineering diagrams API

The Engineering diagrams API from Cognite — 4 operation(s) for engineering diagrams.

Documentation Provider Profile APIs.io OpenAPI GitHub

Cognite Engineering diagrams API is one of 90 APIs that Cognite publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Engineering diagrams. The published artifact set on APIs.io includes an OpenAPI specification.

This API exposes 4 operations across 4 paths, and defines 34 schemas. It is described by OpenAPI 3.2.0, at version v1.

Requests are made against a single base URL, https://{cluster}.cognitedata.com/api/v1/projects/{project}.

4 operations 4 paths 34 schemas 2 GET2 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
v1
Base URL
https://api.cognitedata.com
Authentication
HTTP Bearer, OAuth 2.0, OAuth 2.0, OAuth 2.0, OpenID Connect
Contact
Cognite Support
Resource Areas
1

Authentication & Security 5

Cognite Engineering diagrams API declares 5 security schemes for authenticating requests. It accepts HTTP bearer tokens (OpenID Connect or OAuth2 token) (oidc-token). It supports OAuth 2.0 (oauth2-client-credentials) using the clientCredentials flow, exposing 1 scope. It supports OAuth 2.0 (oauth2-auth-code) using the authorizationCode flow, exposing 1 scope. It supports OAuth 2.0 (oauth2-open-industrial-data) using the clientCredentials flow, exposing 1 scope. It supports OpenID Connect (org-oidc-token) discovered at https://auth.cognite.com/.well-known/openid-configuration. By default, every request must be authenticated.

  • oidc-token — 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 acce…
  • oauth2-client-credentials — 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 acce…
  • oauth2-auth-code — 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 acce…
  • oauth2-open-industrial-data — Auth flow for Open Industrial Data. Get your client secret from https://hub.cognite.com/open-industrial-data-211.
  • org-oidc-token — Access token issued by the Cognite authorization server, and valid for the target organization. The token must be an OpenID Connect token, and it can be obtain…

Paths & Operations 4

Across 4 paths, the API surfaces 4 operations — 2 GET, 2 POST. Each is listed below with its method, path, parameters, and response codes.

Engineering diagrams 4
POST
/context/diagram/detect
Detect annotations in engineering diagrams
diagramDetect body → 200400
GET
/context/diagram/detect/{jobId}
Retrieve engineering diagram detect results
diagramDetectResults 1 param → 200400
POST
/context/diagram/convert
Convert a diagram to image format
diagramConvert body → 200400
GET
/context/diagram/convert/{jobId}
Get the results for converting an engineering diagram to an image
diagramConvertResults 1 param → 200400

Schemas 34

The contract defines 34 schemas that model the data the API accepts and returns. The most detailed are AllOfFileIdWithPageRange (5 properties), StatusSchema (5 properties), Error (4 properties), NewAnnotation (3 properties). Each schema is shown below with its type and property counts.

DiagramInstanceId
object
The instance id of a file in CDF. The file must have mimetype application/pdf, image/jpeg, image/png or image/tiff.
2 properties 2 required
BatchJobStatus
string
The status of the job.
DiagramFileExternalId
string
The external ID of a file in CDF. The file must have mimetype application/pdf, image/jpeg, image/png or image/tiff.
AllOfFileIdWithPageRange
object
5 properties 1 required
DiagramConvertRequestSchema
array
An array of files and annotations to create interactive diagrams.
DiagramConvertResultSchema
array
An array of converted results, returned when the job finished or failed partially.
EpochTimestamp
integer
The number of milliseconds since 00:00:00 Thursday, 1 January 1970, Coordinated Universal Time (UTC), minus leap seconds.
AllOfFileId
object
3 properties 1 required
PageRange
object
An inclusive range of up to 50 pages, starting at 1. For example, the first 10 pages are given by begin=1, end=10. Page ranges only apply to PDF files.
2 properties 2 required
DiagramFileId
integer
The ID of a file in CDF. The file must have mimetype application/pdf, image/jpeg, image/png or image/tiff.
DiagramDetectResultSchema
array
An array of detected results, returned when the job finished or failed partially.
DiagramSvgPngResultSchema
object
DiagramAnnotation
Annotation representing a detected entity.
Vertex
object
A vertex represents a 2D point in the image. The vertex coordinates are normalized.
2 properties 2 required
DiagramPartialMatch
boolean
Allow partial (fuzzy) matching of entities in the engineering diagrams. Creates a match only when it is possible to do so unambiguously.
NewAnnotation
object
3 properties 2 required
JobId
integer
Contextualization job ID.
Grayscale
boolean
Return the SVG version in grayscale colors only (reduces the file size).
InstanceSpace
string
FileReferenceWithPageRange
object
Either file id, external id or instance id, and optionally a page range. At most 50 pages can be queried.
1 property 3 required
DiagramConvertConfig
object
1 property
PageCount
integer
The total number of pages in the file, returned if page range was provided.
StatusSchema
object
5 properties 4 required
InstanceExternalId
string
DiagramMinTokens
integer
Each detected item must match the detected entity on at least this number of tokens. A token is a substring of consecutive letters or digits.
DiagramDetectConfig
object
3 properties
DiagramRegion
object
Shape and coordinates of the detected entity in the image.
2 properties 2 required
JobStatus
string
The status of the job.
Error
object
Cognite API error.
4 properties 2 required
OneOfFileId
object
An object containing file (external/instance) id. The file can have at most 50 pages.
3 required
DiagramDetectedEntities
array
A list of entities detected per annotation.
DiagramDetectEntities
array
A list of entities to look for. For example, all the assets under a root node. The searchField determines the strings that identify the entities.
DiagramSearchField
string
This field determines the string to search for and to identify object entities.
Page
integer
The page of the file where the annotations in annotations were detected.

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

cognite-engineering-diagrams-api-openapi.yml Raw ↑

Other APIs Cognite publishes across the network.

Cognite Data Fusion API
AE Profile APIs.io
Cognite 3D Asset Mapping API
AE Profile APIs.io
Cognite 3D Files API
AE Profile APIs.io
Cognite 3D Jobs API
AE Profile APIs.io
Cognite 3D Model Revisions API
AE Profile APIs.io
Cognite 3D Models API
AE Profile APIs.io
Cognite Annotations API
AE Profile APIs.io
Cognite Assets API
AE Profile APIs.io
Cognite Connections API
AE Profile APIs.io
Cognite Containers API
AE Profile APIs.io
Cognite Data models API
AE Profile APIs.io
Cognite Data point subscriptions API
AE Profile APIs.io
#Engineering diagrams
← Back to C APIs
API Details
ID
cognite:cognite-engineering-diagrams-api
Base URL
https://api.cognitedata.com
Docs
https://api-docs.cognite.com/
Provider
Cognite
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network
Work with this as data

Every API here is available over the API and to AI agents over MCP. APIs is not yet its own endpoint on the v1 API. Reach this content through network search and the tag graph, or the MCP server below.

Installs https://mcp.apievangelist.com/mcp in Claude, Cursor, VS Code and the rest — one button, every client.

MCP tools for apis
4 tools reach this content
  • search_api_evangelistSearch every content type across the network at once.
  • find_relatedThe shared-tag relevance graph — what else covers this.
  • get_tagEverything one tag labels, across all content types.
  • guide_topicPRO — a curated bundle for a topic: area, guidance, rules, papers, stories, services.
All tools & prompts
Call it yourself
curl for this page
Search the network for this 
curl "https://api.apievangelist.com/v1/search?q=cognite-engineering-diagrams-api&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/cognite-engineering-diagrams-api"

Discovery needs no key. Full bodies and the synthesis endpoints are Pro.

Get an API key

Free tier, no email required. Sign in with whichever identity you already have.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have. Your account

Where this information came from

This is an independent, third-party profile of Cognite Engineering diagrams API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.