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 Parsing API

The Parsing API from Cognite — 3 operation(s) for parsing.

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

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

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

3 operations 3 paths 12 schemas 3 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 Parsing 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 3

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

Parsing 3
POST
/diagram-parsing/parsing/symbol-detection
Run parsing for files
runSymbolDetectionParsing body → 200400
POST
/diagram-parsing/parsing/instant
Run an instant parsing job for a file
runInstantParsing body → 200400
POST
/api/v1/projects/{project}/diagram-parsing/parsing/full
Run parsing with tag detection for files
runFullParsing 1 param body → 200400

Schemas 12

The contract defines 12 schemas that model the data the API accepts and returns. The most detailed are FullParseInput (7 properties), Error (4 properties), DiagramParseInput (3 properties), VirtualEntity (3 properties). Each schema is shown below with its type and property counts.

FullParseInput
object
7 properties 4 required
ParseStatus
string
Status of a parsing job
Error
object
Cognite API error.
4 properties 2 required
VirtualEntity
object
Diagram entity with its paths joined by pathIds
3 properties 3 required
DmsId
object
A DMS Identifier using the space and externalId
2 properties 2 required
DocumentIdentifier
object
2 properties 2 required
ExternalId
object
1 property 1 required
InstantParseInput
object
2 properties 2 required
DetectTagsResourceFilter
object
2 properties
CogniteExternalId
string
The external ID provided by the client. Must be unique for the resource type.
DiagramParseInput
object
3 properties 3 required
InstantParseResult
object
Temporary diagram entity data resulting from running instant parsing with a library on a file.
3 properties 2 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

cognite-parsing-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 Parsing 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.