Cognite Engineering diagrams API

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

OpenAPI Specification

cognite-engineering-diagrams-api-openapi.yml Raw ↑
openapi: 3.1.0
info:
  title: Cognite 3D Asset Mapping Engineering diagrams API
  description: "# Introduction\nThis is the reference documentation for the Cognite API with\nan overview of all the available methods.\n\n# Postman\nSelect the **Download** button to download our OpenAPI specification to get started.\n\nTo import your data into Postman, select **Import**, and the Import modal opens.\nYou can import items by dragging or dropping files or folders. You can choose how to import your API and manage the import settings in **View Import Settings**.\n\nIn the Import Settings, set the **Folder organization** to **Tags**, select\n**Enable optional parameters** to turn off the settings, and select **Always inherit authentication** to turn on the settings. Select **Import**.\n\nSet the Authorization to **Oauth2.0**. By default, the settings are for Open Industrial Data. Navigate to [Cognite Hub](https://hub.cognite.com/open-industrial-data-211) to understand how to get the credentials for use in Postman.\n\nFor more information, see [Getting Started with Postman](https://developer.cognite.com/dev/guides/postman/).\n\n# Pagination\nMost resource types can be paginated, indicated by the field `nextCursor` in the response.\nBy passing the value of `nextCursor` as the cursor you will get the next page of `limit` results.\nNote that all parameters except `cursor` has to stay the same.\n\n# Parallel retrieval\nAs general guidance, Parallel Retrieval is a technique that should be used when due to query complexity, retrieval of data in a single request is significantly slower than it would otherwise be for a simple request.  Parallel retrieval does not act as a speed multiplier on optimally running queries.  By parallelizing such requests, data retrieval performance can be tuned to meet the client application needs. \n\nCDF supports parallel retrieval through the `partition` parameter, which has the format `m/n` where `n` is the amount of partitions you would like to split the entire data set into.\nIf you want to download the entire data set by splitting it into 10 partitions, do the following in parallel with `m` running from 1 to 10:\n  - Make a request to `/events` with `partition=m/10`.\n  - Paginate through the response by following the cursor as explained above. Note that the `partition` parameter needs to be passed to all subqueries.\n\nProcessing of parallel retrieval requests is subject to concurrency quota availability. The request returns the `429` response upon exceeding concurrency limits. See the Request throttling chapter below.\n\nTo prevent unexpected problems and to maximize read throughput, you should at most use 10 partitions. \nSome CDF resources will automatically enforce a maximum of 10 partitions.\nFor more specific and detailed information, please read the ```partition``` attribute documentation for the CDF resource you're using.  \n\n# Requests throttling\nCognite Data Fusion (CDF) returns the HTTP `429` (too many requests) response status code when project capacity exceeds the limit.\n\nThe throttling can happen:\n  - If a user or a project sends too many (more than allocated) concurrent requests.\n  - If a user or a project sends a too high (more than allocated) rate of requests in a given amount of time.\n\nCognite recommends using a retry strategy based on truncated exponential backoff to handle sessions with HTTP response codes 429.\n\nCognite recommends using a reasonable number (up to 10) of  `Parallel retrieval` partitions.\n\nFollowing these strategies lets you slow down the request frequency to maximize productivity without having to re-submit/retry failing requests.\n\nSee more [here](https://docs.cognite.com/dev/concepts/resource_throttling).\n\n# API versions\n## Version headers\nThis API uses calendar versioning, and version names follow the `YYYYMMDD` format.\nYou can find the versions currently available by using the version selector at the top of this page.\n\nTo use a specific API version, you can pass the `cdf-version: $version` header along with your requests to the API.\n\n## Beta versions\nThe beta versions provide a preview of what the stable version will look like in the future.\nBeta versions contain functionality that is reasonably mature, and highly likely to become a part of the stable API.\n\nBeta versions are indicated by a `-beta` suffix after the version name. For example, the beta version header for the\n2023-01-01 version is then `cdf-version: 20230101-beta`.\n\n## Alpha versions\nAlpha versions contain functionality that is new and experimental, and not guaranteed to ever become a part of the stable API.\nThis functionality presents no guarantee of service, so its use is subject to caution.\n\nAlpha versions are indicated by an `-alpha` suffix after the version name. For example, the alpha version header for\nthe 2023-01-01 version is then `cdf-version: 20230101-alpha`."
  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: Engineering diagrams
paths:
  /context/diagram/detect:
    post:
      tags:
      - Engineering diagrams
      summary: Detect annotations in engineering diagrams
      description: '


        > **Required capabilities:** `assetsAcl:READ` `filesAcl:READ`


        Detect annotations in engineering diagrams. Note: All users in a CDF project with assets read-all and files read access to the requested files can access data sent to this endpoint.

        Supported input file mime_types are application/pdf, image/jpeg, image/png, image/tiff. Also note that the header of a successful response contains an `X-Job-Token` which allows to fetch the result of the

        job at `/context/diagram/detect/{jobId}` without requiring ''assetsAcl:READ''.'
      operationId: diagramDetect
      requestBody:
        content:
          application/json:
            schema:
              type: object
              required:
              - items
              - entities
              allOf:
              - properties:
                  items:
                    type: array
                    description: Files to run entity detection on.
                    minItems: 1
                    maxItems: 50
                    items:
                      $ref: '#/components/schemas/FileReferenceWithPageRange'
                  entities:
                    $ref: '#/components/schemas/DiagramDetectEntities'
              - $ref: '#/components/schemas/DiagramDetectConfig'
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: object
                required:
                - jobId
                - items
                allOf:
                - properties:
                    items:
                      type: array
                      items:
                        $ref: '#/components/schemas/FileReferenceWithPageRange'
                    jobId:
                      $ref: '#/components/schemas/JobId'
                    status:
                      $ref: '#/components/schemas/BatchJobStatus'
                - $ref: '#/components/schemas/StatusSchema'
                - $ref: '#/components/schemas/DiagramDetectConfig'
        '400':
          $ref: '#/components/responses/ErrorResponse'
      x-capability:
      - assetsAcl:READ
      - filesAcl:READ
      x-code-samples:
      - lang: Python
        label: Python SDK
        source: "from cognite.client.data_classes.contextualization import FileReference\ndetect_job = client.diagrams.detect(\n    entities=[\n        {\"userDefinedField\": \"21PT1017\",\"ignoredField\": \"AA11\"},\n        {\"userDefinedField\": \"21PT1018\"}],\n    search_field=\"userDefinedField\",\n    partial_match=True,\n    min_tokens=2,\n    file_ids=[101],\n    file_external_ids=[\"Test1\"],\n    file_references=[\n        FileReference(id=20, first_page=1, last_page=10),\n        FileReference(external_id=\"ext_20\", first_page=11, last_page=20)\n    ])\nresult = detect_job.result\nprint(result)\n\nfrom cognite.client.data_classes.contextualization import ConnectionFlags, DiagramDetectConfig\nconfig = DiagramDetectConfig(\n    remove_leading_zeros=True,\n    connection_flags=ConnectionFlags(\n        no_text_inbetween=True,\n        natural_reading_order=True,\n    )\n)\njob = client.diagrams.detect(entities=[{\"name\": \"A1\"}], file_id=123, config=config)\n"
  /context/diagram/detect/{jobId}:
    get:
      tags:
      - Engineering diagrams
      summary: Retrieve engineering diagram detect results
      description: '


        > **Required capabilities:** `assetsAcl:READ` `filesAcl:READ`


        Get the results from an engineering diagram detect job. Providing the `X-Job-Token` header returned by the

        `/context/diagram/detect` endpoint is required unless the caller has read access to all assets. Results are available for 30 days following the completion of the detect job.'
      operationId: diagramDetectResults
      parameters:
      - $ref: '#/components/parameters/jobId'
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: object
                required:
                - jobId
                allOf:
                - properties:
                    jobId:
                      $ref: '#/components/schemas/JobId'
                    status:
                      $ref: '#/components/schemas/BatchJobStatus'
                    items:
                      $ref: '#/components/schemas/DiagramDetectResultSchema'
                - $ref: '#/components/schemas/StatusSchema'
                - $ref: '#/components/schemas/DiagramDetectConfig'
        '400':
          $ref: '#/components/responses/ErrorResponse'
      x-capability:
      - assetsAcl:READ
      - filesAcl:READ
  /context/diagram/convert:
    post:
      tags:
      - Engineering diagrams
      summary: Convert a diagram to image format
      description: '


        > **Required capabilities:** `assetsAcl:READ` `filesAcl:READ`


        Convert interactive engineering diagrams to image format, with highlighted annotations.

        Supported input file mime_types are application/pdf, image/jpeg, image/png, image/tiff.

        Supported output image formats are PNG and SVG, only the svg embeds the input annotations.'
      operationId: diagramConvert
      requestBody:
        content:
          application/json:
            schema:
              type: object
              required:
              - items
              allOf:
              - properties:
                  items:
                    $ref: '#/components/schemas/DiagramConvertRequestSchema'
              - $ref: '#/components/schemas/DiagramConvertConfig'
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: object
                required:
                - jobId
                - items
                allOf:
                - properties:
                    items:
                      type: array
                      items:
                        $ref: '#/components/schemas/OneOfFileId'
                    jobId:
                      $ref: '#/components/schemas/JobId'
                    status:
                      $ref: '#/components/schemas/BatchJobStatus'
                - $ref: '#/components/schemas/StatusSchema'
                - $ref: '#/components/schemas/DiagramConvertConfig'
        '400':
          $ref: '#/components/responses/ErrorResponse'
      x-capability:
      - assetsAcl:READ
      - filesAcl:READ
  /context/diagram/convert/{jobId}:
    get:
      tags:
      - Engineering diagrams
      summary: Get the results for converting an engineering diagram to an image
      description: '


        > **Required capabilities:** `assetsAcl:READ` `filesAcl:READ`


        Get the results for converting an engineering diagram to SVG and PNG formats.'
      operationId: diagramConvertResults
      parameters:
      - $ref: '#/components/parameters/jobId'
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: object
                required:
                - jobId
                allOf:
                - properties:
                    jobId:
                      $ref: '#/components/schemas/JobId'
                    status:
                      $ref: '#/components/schemas/BatchJobStatus'
                    items:
                      $ref: '#/components/schemas/DiagramConvertResultSchema'
                - $ref: '#/components/schemas/StatusSchema'
                - $ref: '#/components/schemas/DiagramConvertConfig'
        '400':
          $ref: '#/components/responses/ErrorResponse'
      x-capability:
      - assetsAcl:READ
      - filesAcl:READ
components:
  schemas:
    DiagramDetectConfig:
      type: object
      properties:
        searchField:
          $ref: '#/components/schemas/DiagramSearchField'
        partialMatch:
          $ref: '#/components/schemas/DiagramPartialMatch'
        minTokens:
          $ref: '#/components/schemas/DiagramMinTokens'
    InstanceExternalId:
      type: string
      pattern: ^[a-zA-Z]([a-zA-Z0-9_]{0,253}[a-zA-Z0-9])?$
      minLength: 1
      maxLength: 255
    StatusSchema:
      type: object
      required:
      - status
      - createdTime
      - startTime
      - statusTime
      properties:
        status:
          $ref: '#/components/schemas/JobStatus'
        createdTime:
          $ref: '#/components/schemas/EpochTimestamp'
        startTime:
          $ref: '#/components/schemas/EpochTimestamp'
        statusTime:
          $ref: '#/components/schemas/EpochTimestamp'
        errorMessage:
          type: string
          description: If the job failed, some more information about the error cause.
          example: null
          default: null
    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
    BatchJobStatus:
      description: The status of the job.
      type: string
      enum:
      - Queued
      - Distributing
      - Distributed
      - Running
      - Collecting
      - Completed
      - Failed
      - Timeout
    DiagramDetectEntities:
      type: array
      items:
        type: object
        maxProperties: 256
      minItems: 1
      maxItems: 500000
      example:
      - userDefinedField: 21PT1017
        ignoredField: AA11
      - userDefinedField:
        - 21PT1017-A
        - 21PT1017-B
      description: 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.
    NewAnnotation:
      type: object
      required:
      - text
      - region
      properties:
        text:
          description: The text and entities detected by the service.
          type: string
          example: 21-PT-1019
        confidence:
          type: number
          description: The confidence for the detection.
          example: 0.5
          minimum: 0
          maximum: 1
        region:
          required:
          - shape
          - vertices
          - page
          allOf:
          - $ref: '#/components/schemas/DiagramRegion'
          - properties:
              page:
                $ref: '#/components/schemas/Page'
    DiagramPartialMatch:
      type: boolean
      description: Allow partial (fuzzy) matching of entities in the engineering diagrams. Creates a match only when it is possible to do so unambiguously.
      default: false
    JobId:
      description: Contextualization job ID.
      type: integer
      example: 123
      format: int64
    EpochTimestamp:
      description: The number of milliseconds since 00:00:00 Thursday, 1 January 1970, Coordinated Universal Time (UTC), minus leap seconds.
      type: integer
      minimum: 0
      format: int64
      example: 1730204346000
    DiagramDetectedEntities:
      type: array
      example:
      - userDefinedField: 21PT1017
        ignoredField: AA11
      - userDefinedField:
        - 21PT1017-A
        - 21PT1017-B
      description: A list of entities detected per annotation.
      items:
        type: object
      minItems: 1
      maxItems: 5
    DiagramConvertResultSchema:
      description: An array of converted results, returned when the job finished or failed partially.
      type: array
      items:
        type: object
        oneOf:
        - allOf:
          - $ref: '#/components/schemas/AllOfFileId'
          - properties:
              results:
                type: array
                items:
                  $ref: '#/components/schemas/DiagramSvgPngResultSchema'
                maxItems: 50
          required:
          - results
        - allOf:
          - $ref: '#/components/schemas/AllOfFileId'
          - properties:
              errorMessage:
                type: string
                description: The error message for a file.
          required:
          - errorMessage
    DiagramConvertConfig:
      type: object
      properties:
        grayscale:
          $ref: '#/components/schemas/Grayscale'
    DiagramAnnotation:
      description: Annotation representing a detected entity.
      allOf:
      - $ref: '#/components/schemas/NewAnnotation'
      - type: object
        properties:
          entities:
            $ref: '#/components/schemas/DiagramDetectedEntities'
    PageRange:
      type: object
      required:
      - begin
      - end
      description: 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.
      properties:
        begin:
          type: integer
          description: The first page of the page range.
          minimum: 1
          example: 51
        end:
          type: integer
          description: The last page of the page range, must be greater than or equal to begin.
          minimum: 1
          example: 100
    PageCount:
      type: integer
      description: The total number of pages in the file, returned if page range was provided.
      example: 51
    DiagramFileId:
      type: integer
      example: 1234
      description: The ID of a file in CDF. The file must have mime_type application/pdf, image/jpeg, image/png or image/tiff.
      format: int64
    DiagramMinTokens:
      type: integer
      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.
      default: 2
    JobStatus:
      description: The status of the job.
      type: string
      enum:
      - Queued
      - Running
      - Completed
      - Failed
    OneOfFileId:
      type: object
      required:
      - fileId
      - fileExternalId
      - fileInstanceId
      description: An object containing file (external/instance) id. The file can have at most 50 pages.
      oneOf:
      - properties:
          fileId:
            $ref: '#/components/schemas/DiagramFileId'
      - properties:
          fileExternalId:
            $ref: '#/components/schemas/DiagramFileExternalId'
      - properties:
          fileInstanceId:
            $ref: '#/components/schemas/DiagramInstanceId'
    DiagramSearchField:
      type: string
      example: userDefinedField
      default: name
      description: This field determines the string to search for and to identify object entities.
    AllOfFileId:
      type: object
      required:
      - fileId
      properties:
        fileId:
          $ref: '#/components/schemas/DiagramFileId'
        fileExternalId:
          $ref: '#/components/schemas/DiagramFileExternalId'
        fileInstanceId:
          $ref: '#/components/schemas/DiagramInstanceId'
    DiagramSvgPngResultSchema:
      type: object
      oneOf:
      - properties:
          page:
            $ref: '#/components/schemas/Page'
          svgUrl:
            type: string
            example: https://storage.googleapis.com/cluster/1234/PH-ME-P-0004-001.svg
            description: A signed URL to an interactive SVG version of the engineering diagram (valid for 10 minutes).
          pngUrl:
            type: string
            example: https://storage.googleapis.com/cluster/1234/PH-ME-P-0004-001.png
            description: A signed URL to a PNG version of the engineering diagram (valid for 10 minutes).
        required:
        - page
        - svgUrl
        - pngUrl
      - properties:
          page:
            $ref: '#/components/schemas/Page'
          errorMessage:
            type: string
            description: The error message for the page and file.
        required:
        - page
        - errorMessage
    DiagramConvertRequestSchema:
      description: An array of files and annotations to create interactive diagrams.
      type: array
      maxItems: 50
      minItems: 1
      items:
        type: object
        required:
        - annotations
        allOf:
        - $ref: '#/components/schemas/OneOfFileId'
        - properties:
            annotations:
              description: Annotations to draw on the engineering diagrams
              type: array
              items:
                $ref: '#/components/schemas/DiagramAnnotation'
              maxItems: 1000
    DiagramDetectResultSchema:
      description: An array of detected results, returned when the job finished or failed partially.
      type: array
      items:
        type: object
        oneOf:
        - allOf:
          - $ref: '#/components/schemas/AllOfFileId'
          - properties:
              annotations:
                type: array
                description: Annotations of entities detected by the service
                items:
                  $ref: '#/components/schemas/DiagramAnnotation'
          required:
          - annotations
        - allOf:
          - $ref: '#/components/schemas/AllOfFileIdWithPageRange'
          - properties:
              errorMessage:
                type: string
                description: Error message for the file.
          required:
          - errorMessage
    DiagramFileExternalId:
      type: string
      example: '1234'
      description: The external ID of a file in CDF. The file must have mime_type application/pdf, image/jpeg, image/png or image/tiff.
    Vertex:
      type: object
      description: A vertex represents a 2D point in the image. The vertex coordinates are normalized.
      example:
        x: 0.58
        y: 0.12
      required:
      - x
      - y
      properties:
        x:
          type: number
          description: Normalized x coordinate.
          minimum: 0
          maximum: 1
        y:
          type: number
          description: Normalized y coordinate.
          minimum: 0
          maximum: 1
    FileReferenceWithPageRange:
      type: object
      required:
      - fileId
      - fileExternalId
      - fileInstanceId
      description: Either file id, external id or instance id, and optionally a page range. At most 50 pages can be queried.
      oneOf:
      - properties:
          fileId:
            $ref: '#/components/schemas/DiagramFileId'
      - properties:
          fileExternalId:
            $ref: '#/components/schemas/DiagramFileExternalId'
      - properties:
          fileInstanceId:
            $ref: '#/components/schemas/DiagramInstanceId'
      properties:
        pageRange:
          $ref: '#/components/schemas/PageRange'
    DiagramInstanceId:
      type: object
      required:
      - space
      - externalId
      example:
        space: space
        externalId: externalId
      description: The instance id of a file in CDF. The file must have mime_type application/pdf, image/jpeg, image/png or image/tiff.
      properties:
        space:
          $ref: '#/components/schemas/InstanceSpace'
        externalId:
          $ref: '#/components/schemas/InstanceExternalId'
    Grayscale:
      type: boolean
      example: true
      default: true
      description: Return the SVG version in grayscale colors only (reduces the file size).
    DiagramRegion:
      description: Shape and coordinates of the detected entity in the image.
      type: object
      required:
      - shape
      - vertices
      properties:
        shape:
          type: string
          description: The geometrical shape of the image region to which a detected entity belongs.
          enum:
          - rectangle
        vertices:
          type: array
          description: List of vertices representing the image region to which a detected entity belongs.
          items:
            $ref: '#/components/schemas/Vertex'
          minItems: 4
          maxItems: 4
    InstanceSpace:
      type: string
      pattern: ^[a-zA-Z][a-zA-Z0-9_-]{0,41}[a-zA-Z0-9]?$
      minLength: 1
      maxLength: 43
    AllOfFileIdWithPageRange:
      type: object
      required:
      - fileId
      properties:
        fileId:
          $ref: '#/components/schemas/DiagramFileId'
        fileExternalId:
          $ref: '#/components/schemas/DiagramFileExternalId'
        fileInstanceId:
          $ref: '#/components/schemas/DiagramInstanceId'
        pageRange:
          $ref: '#/components/schemas/PageRange'
        pageCount:
          $ref: '#/components/schemas/PageCount'
    Page:
      type: integer
      example: 1
      description: The page of the file where the annotations in `annotations` were detected.
      minimum: 1
  parameters:
    jobId:
      in: path
      name: jobId
      required: true
      schema:
        $ref: '#/components/schemas/JobId'
  responses:
    ErrorResponse:
      description: The response for a failed request.
      content:
        application/json:
          schema:
            type: object
            required:
            - error
            properties:
              error:
                $ref: '#/components/schemas/Error'
  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:
  - ''