Cognite Parsing API

openapi: 3.2.0
info:
  title: Cognite Parsing API
  description: '# Introduction

    This is the reference documentation for the Cognite API with

    an overview of all the available methods.'
  version: v1
  contact:
    name: Cognite Support
    url: https://support.cognite.com
    email: support@cognite.com
servers:
- url: https://{cluster}.cognitedata.com/api/v1/projects/{project}
  description: The URL for the CDF cluster to connect to
  variables:
    cluster:
      enum:
      - api
      - az-tyo-gp-001
      - az-eastus-1
      - az-power-no-northeurope
      - westeurope-1
      - asia-northeast1-1
      - gc-dsm-gp-001
      default: api
      description: The CDF cluster to connect to
    project:
      default: publicdata
      description: The CDF project name.
security:
- oidc-token:
  - https://{cluster}.cognitedata.com/.default
- oauth2-client-credentials:
  - https://{cluster}.cognitedata.com/.default
- oauth2-open-industrial-data:
  - https://api.cognitedata.com/.default
- oauth2-auth-code:
  - https://{cluster}.cognitedata.com/.default
tags:
- name: Parsing
paths:
  /diagram-parsing/parsing/symbol-detection:
    post:
      tags:
      - Parsing
      summary: Run parsing for files
      description: '> **Required capabilities:** `diagramParsingAcl:WRITE`


        Start a parsing job on files to detect their symbols and connections.'
      operationId: runSymbolDetectionParsing
      requestBody:
        description: Specifies the library to use when parsing the given files.
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DiagramParseInput'
        required: true
      x-capability:
      - diagramParsingAcl:WRITE
      responses:
        '200':
          $ref: '#/components/responses/ExternalIdsResponse'
        '400':
          $ref: '#/components/responses/ErrorResponse'
  /diagram-parsing/parsing/instant:
    post:
      tags:
      - Parsing
      summary: Run an instant parsing job for a file
      description: '> **Required capabilities:** `diagramParsingAcl:WRITE`


        Start an instant parsing job on a file to detect diagram symbols based on the specified library. Parsed outputs do not persist.'
      operationId: runInstantParsing
      requestBody:
        description: Specifies the library to use when instant parsing the given file.
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/InstantParseInput'
        required: true
      x-capability:
      - diagramParsingAcl:WRITE
      responses:
        '200':
          $ref: '#/components/responses/InstantParsingResponse'
        '400':
          $ref: '#/components/responses/ErrorResponse'
  /api/v1/projects/{project}/diagram-parsing/parsing/full:
    post:
      tags:
      - Parsing
      summary: Run parsing with tag detection for files
      description: '> **Required capabilities:** `diagramParsingAcl:WRITE` `dataModelInstancesAcl:WRITE`


        A parsing job will be started on the files to detect their entities and connections and map assets.'
      operationId: runFullParsing
      parameters:
      - $ref: '#/components/parameters/project'
      requestBody:
        description: Defines parsing options needed for symbol and tag detection jobs.
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/FullParseInput'
        required: true
      x-capability:
      - diagramParsingAcl:WRITE
      - dataModelInstancesAcl:WRITE
      responses:
        '200':
          $ref: '#/components/responses/ExternalIdsResponse'
        '400':
          $ref: '#/components/responses/ErrorResponse'
components:
  schemas:
    Error:
      type: object
      required:
      - code
      - message
      description: Cognite API error.
      properties:
        code:
          type: integer
          description: HTTP status code.
          format: int32
          example: 401
        message:
          type: string
          description: Error message.
          example: Could not authenticate.
        missing:
          type: array
          description: List of lookup objects that do not match any results.
          items:
            type: object
            additionalProperties: true
        duplicated:
          type: array
          description: List of objects that are not unique.
          items:
            type: object
            additionalProperties: true
    InstantParseResult:
      description: Temporary diagram entity data resulting from running instant parsing with a library on a file.
      type: object
      required:
      - entities
      - status
      properties:
        entities:
          type: array
          items:
            $ref: '#/components/schemas/VirtualEntity'
        message:
          type: string
        status:
          $ref: '#/components/schemas/ParseStatus'
    InstantParseInput:
      type: object
      required:
      - document
      - libraryId
      properties:
        document:
          type: object
          $ref: '#/components/schemas/DocumentIdentifier'
        libraryId:
          description: The external ID of a library for parsing
          $ref: '#/components/schemas/CogniteExternalId'
    VirtualEntity:
      description: Diagram entity with its paths joined by pathIds
      type: object
      required:
      - externalId
      - pathIds
      - symbolId
      properties:
        externalId:
          description: The external ID of the diagram entity
          $ref: '#/components/schemas/CogniteExternalId'
        pathIds:
          type: array
          items:
            type: string
        symbolId:
          description: The external ID of the symbol this diagram entity is detected as
          $ref: '#/components/schemas/CogniteExternalId'
    DiagramParseInput:
      type: object
      required:
      - documents
      - libraryId
      - nonce
      properties:
        documents:
          type: array
          minItems: 1
          maxItems: 100
          items:
            type: object
            $ref: '#/components/schemas/DocumentIdentifier'
        libraryId:
          description: The external ID of a library for parsing
          $ref: '#/components/schemas/CogniteExternalId'
        nonce:
          description: Nonce parameter
          type: string
    DetectTagsResourceFilter:
      type: object
      properties:
        Asset:
          type: object
          additionalProperties: true
        File:
          type: object
          additionalProperties: true
    DocumentIdentifier:
      type: object
      required:
      - fileId
      - pageNumber
      properties:
        fileId:
          description: DMS identifier of a file to be parsed
          $ref: '#/components/schemas/DmsId'
        pageNumber:
          description: Page number of the file to be parsed
          type: integer
    ExternalId:
      type: object
      required:
      - externalId
      properties:
        externalId:
          $ref: '#/components/schemas/CogniteExternalId'
    ParseStatus:
      description: Status of a parsing job
      type: string
      enum:
      - Failed
      - InProgress
      - InQueue
      - Pending
      - Success
    CogniteExternalId:
      description: The external ID provided by the client. Must be unique for the resource type.
      type: string
      maxLength: 255
      example: my.known.id
    DmsId:
      description: A DMS Identifier using the space and externalId
      type: object
      required:
      - space
      - externalId
      properties:
        space:
          type: string
        externalId:
          $ref: '#/components/schemas/CogniteExternalId'
    FullParseInput:
      type: object
      required:
      - documents
      - filters
      - libraryId
      - nonce
      properties:
        documents:
          type: array
          minItems: 1
          maxItems: 100
          items:
            type: object
            $ref: '#/components/schemas/DocumentIdentifier'
        filters:
          description: Map of filters for DMS list operations used to load assets and files
          type: object
          $ref: '#/components/schemas/DetectTagsResourceFilter'
        libraryId:
          description: The externalId of a library to use for parsing
          $ref: '#/components/schemas/ExternalId'
        minTokens:
          description: 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.
          type: integer
        nonce:
          description: Session nonce value
          type: string
        partialMatch:
          description: Allow partial (fuzzy) matching of entities in the engineering diagrams. Creates a match only when it is possible to do so unambiguously.
          type: boolean
        searchField:
          description: This field determines the string to search for and to identify object entities.
          type: string
  responses:
    ErrorResponse:
      description: The response for a failed request.
      content:
        application/json:
          schema:
            type: object
            required:
            - error
            properties:
              error:
                $ref: '#/components/schemas/Error'
    ExternalIdsResponse:
      description: List of external IDs returned in a response
      content:
        application/json:
          schema:
            type: object
            required:
            - items
            properties:
              items:
                type: array
                minItems: 1
                maxItems: 100
                items:
                  $ref: '#/components/schemas/CogniteExternalId'
    InstantParsingResponse:
      description: Temporary diagram entity detections in a given file based on the provided library.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/InstantParseResult'
  parameters:
    project:
      in: path
      name: project
      required: true
      description: The CDF project name, equal to the project variable in the server URL.
      schema:
        type: string
        example: publicdata
  securitySchemes:
    oidc-token:
      type: http
      scheme: bearer
      bearerFormat: OpenID Connect or OAuth2 token
      description: 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.
    oauth2-client-credentials:
      type: oauth2
      description: 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.
      flows:
        clientCredentials:
          tokenUrl: https://your-idps.token.url/
          scopes:
            default: https://{cluster}.cognitedata.com/.default
    oauth2-auth-code:
      type: oauth2
      description: 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.
      flows:
        authorizationCode:
          authorizationUrl: https://your-idps.authorization.url/
          tokenUrl: https://your-idps.token.url/
          scopes:
            default: https://{cluster}.cognitedata.com/.default
    oauth2-open-industrial-data:
      type: oauth2
      description: Auth flow for Open Industrial Data. Get your client secret from https://hub.cognite.com/open-industrial-data-211.
      flows:
        clientCredentials:
          tokenUrl: https://login.microsoftonline.com/48d5043c-cf70-4c49-881c-c638f5796997/oauth2/v2.0/token
          scopes:
            default: https://api.cognitedata.com/.default
    org-oidc-token:
      type: openIdConnect
      openIdConnectUrl: https://auth.cognite.com/.well-known/openid-configuration
      description: '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 obtained by performing an OIDC login flow toward `auth.cognite.com`.

        This is a single URL for all CDF organizations.'
x-tagGroups:
- name: Changelog
  tags:
  - Changelog
- name: Organizations and projects
  tags:
  - Organizations
  - Projects
- name: Identity and access management
  tags:
  - Principals
  - Groups
  - Security categories
  - Sessions
  - Token
  - User profiles
  - Project Deletion Reporting
- name: Data modeling
  tags:
  - Data Modeling
  - Data models
  - Spaces
  - Views
  - Containers
  - Nodes
  - Instances
  - Statistics
  - Streams
  - Records
- name: Asset-centric data model
  tags:
  - Assets
  - Time series
  - Synthetic Time Series
  - Data point subscriptions
  - Events
  - Files
  - Sequences
  - Geospatial
  - Seismic
- name: 3D
  tags:
  - 3D Models
  - 3D Model Revisions
  - 3D Files
  - 3D Asset Mapping
  - 3D Contextualization
  - 3D Jobs
  - 3D Migration
  - 3D Scenes
- name: Contextualization
  tags:
  - Entity matching
  - Entity matching pipelines
  - Engineering diagrams
  - Vision
  - Advanced joins
- name: Cognite AI
  tags:
  - Agents
  - Skills
  - Chat Completions
  - Document AI
  - Models
- name: Documents
  tags:
  - Documents
  - Document preview
- name: Data ingestion
  tags:
  - Raw
  - Extraction Pipelines
  - Extraction Pipelines Runs
  - Extraction Pipelines Config
  - Extractors
- name: Data organization
  tags:
  - Data sets
  - Data domains
  - Data products
  - Rule sets
  - Labels
  - Relationships
  - Annotations
- name: Transformations
  tags:
  - Transformations
  - Transformation Jobs
  - Transformation Schedules
  - Transformation Notifications
  - Query
  - Schema
- name: Functions
  tags:
  - Functions
  - Function calls
  - Function schedules
- name: Hosted Extractors
  tags:
  - Sources
  - Jobs
  - Destinations
  - Mappings
- name: PostgreSQL Gateway
  tags:
  - Postgres Gateway Users
  - Postgres Gateway Tables
- name: SAP Writeback
  tags:
  - SAP Instances
  - SAP Endpoints
  - Schema Mappings
  - Writeback Requests
- name: Data workflows
  tags:
  - Workflows
  - Workflow versions
  - Workflow executions
  - Workflow triggers
  - Tasks
  - Workers
- name: Simulators
  tags:
  - Simulators
  - Simulator Integrations
  - Simulator Models
  - Simulator Routines
  - Simulation Runs
  - Simulator Logs
- name: Units
  tags:
  - Units
  - Unit Systems
- name: ''
  tags:
  - ''