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

Cognite Diagrams API

The Diagrams API from Cognite — 6 operation(s) for diagrams.

Cognite 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 Diagrams. The published artifact set on APIs.io includes an OpenAPI specification.

This API exposes 6 operations across 6 paths, and defines 16 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}.

6 operations 6 paths 16 schemas 4 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
Resource Areas
1

Authentication & Security 5

Cognite 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 6

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

Diagrams 6
GET
/diagram-parsing/diagrams
List diagrams
listDiagrams 1 param → 200400
POST
/diagram-parsing/diagrams/byids
Retrieve diagrams
multiGetDiagrams body → 200400
POST
/diagram-parsing/diagrams/list
Filter diagrams
filterDiagrams body → 200400
GET
/diagram-parsing/diagrams/{diagramId}
Get an extended diagram by external id
getExtendedDiagramById 1 param → 200400
GET
/diagram-parsing/diagrams/{fileSpace}/{fileExternalId}/{pageNumber}
Get an extended diagram by file reference
getExtendedDiagramByFilePage 3 params → 200400
GET
/diagram-parsing/diagrams/{diagramId}/with-paths
Get an extended diagram with paths by external id
getExtendedDiagramWithPaths 2 params → 200400

Schemas 16

The contract defines 16 schemas that model the data the API accepts and returns. The most detailed are ExtendedDiagramWithPathsDto (13 properties), ExtendedDiagramDto (10 properties), EntityDto (10 properties), EntityWithPathsDto (10 properties). Each schema is shown below with its type and property counts.

ParseStatus
string
Status of a parsing job
ExtendedDiagramWithPathsDto
object
Diagram with its entities, connections, and SVG paths data
13 properties 12 required
EpochTimestamp
integer
The number of milliseconds since 00:00:00 Thursday, 1 January 1970, Coordinated Universal Time (UTC), minus leap seconds.
ExternalIdsRequest
object
1 property 1 required
ConnectionDto
object
Connection between two entities in a diagram. The connected entities can either be in the same or different diagrams.
7 properties 7 required
ExtendedDiagramDto
object
Diagram with all of its entities and connections joined
10 properties 9 required
DiagramFilter
object
List of properties used to filter diagrams
4 properties
NextCursorV3
string
The cursor value used to return (paginate to) the next page of results, when more data is available.
EntityDto
object
10 properties 8 required
EntityWithPathsDto
object
Diagram entity with its paths joined by pathIds
10 properties 8 required
Path
object
SVG path in a custom format
3 properties 2 required
DiagramDto
object
8 properties 7 required
DmsId
object
A DMS Identifier using the space and externalId
2 properties 2 required
CogniteExternalId
string
The external ID provided by the client. Must be unique for the resource type.
DiagramFilters
array
List of filters used to filter diagrams
Error
object
Cognite API error.
4 properties 2 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

cognite-diagrams-api-openapi.yml Raw ↑

Other APIs Cognite publishes across the network.

Cognite Data Fusion API
Cognite 3D Asset Mapping API
Cognite 3D Files API
Cognite 3D Jobs API
Cognite 3D Model Revisions API
Cognite 3D Models API
Cognite Annotations API
Cognite Assets API
Cognite Connections API
Cognite Containers API
Cognite Data models API
Cognite Data point subscriptions API
Where this information came from

This is an independent, third-party profile of Cognite 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.