Cognite

Cognite Libraries API

The Libraries API from Cognite — 6 operation(s) for libraries.

GitHub OpenAPI

Operations 7

GET /diagram-parsing/libraries List libraries #
POST /diagram-parsing/libraries Create libraries #
GET /diagram-parsing/libraries/{libraryId} Get a library with symbols #
POST /diagram-parsing/libraries/{libraryId}/copy Copy library #
POST /diagram-parsing/libraries/byids Retrieve libraries #
POST /diagram-parsing/libraries/delete Delete libraries #
POST /diagram-parsing/libraries/update Update libraries #

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/cognite/refs/heads/main/openapi/cognite-libraries-api-openapi.yml

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/cognite-libraries-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

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

OpenAPI Specification

cognite-libraries-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Cognite Libraries 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: Libraries
paths:
  /diagram-parsing/libraries:
    get:
      tags:
      - Libraries
      summary: List libraries
      description: '> **Required capabilities:** `diagramParsingAcl:READ`


        List all libraries defined in the current project.'
      operationId: listLibraries
      parameters:
      - $ref: '#/components/parameters/Cursor'
      x-capability:
      - diagramParsingAcl:READ
      responses:
        '200':
          $ref: '#/components/responses/LibrariesListWithCursorResponse'
        '400':
          $ref: '#/components/responses/ErrorResponse'
    post:
      tags:
      - Libraries
      summary: Create libraries
      description: '> **Required capabilities:** `diagramParsingAcl:WRITE`


        Create libraries.'
      operationId: createLibraries
      requestBody:
        description: Libraries to create.
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateLibrariesRequest'
        required: true
      x-capability:
      - diagramParsingAcl:WRITE
      responses:
        '200':
          $ref: '#/components/responses/LibrariesListResponse'
        '400':
          $ref: '#/components/responses/ErrorResponse'
  /diagram-parsing/libraries/{libraryId}:
    get:
      tags:
      - Libraries
      summary: Get a library with symbols
      description: '> **Required capabilities:** `diagramParsingAcl:READ`


        Returns a single library with all its symbols and geometries.'
      operationId: getExtendedLibrary
      parameters:
      - $ref: '#/components/parameters/libraryIdPath'
      x-capability:
      - diagramParsingAcl:READ
      responses:
        '200':
          $ref: '#/components/responses/ExtendedLibraryResponse'
        '400':
          $ref: '#/components/responses/ErrorResponse'
  /diagram-parsing/libraries/{libraryId}/copy:
    post:
      tags:
      - Libraries
      summary: Copy library
      description: '> **Required capabilities:** `diagramParsingAcl:WRITE`


        Creates a new library by copying an existing library, including all its symbols and geometries.'
      operationId: copyLibrary
      parameters:
      - $ref: '#/components/parameters/libraryIdPath'
      requestBody:
        description: Name of the new library
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CopyLibraryInput'
        required: true
      x-capability:
      - diagramParsingAcl:WRITE
      responses:
        '200':
          $ref: '#/components/responses/CopyLibraryResponse'
        '400':
          $ref: '#/components/responses/ErrorResponse'
  /diagram-parsing/libraries/byids:
    post:
      tags:
      - Libraries
      summary: Retrieve libraries
      description: '> **Required capabilities:** `diagramParsingAcl:READ`


        Retrieve up to 100 libraries by specifying their IDs.'
      operationId: multiGetLibraries
      requestBody:
        description: List of IDs for the libraries to return.
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ExternalIdsRequest'
        required: true
      x-capability:
      - diagramParsingAcl:READ
      responses:
        '200':
          $ref: '#/components/responses/LibrariesListResponse'
        '400':
          $ref: '#/components/responses/ErrorResponse'
  /diagram-parsing/libraries/delete:
    post:
      tags:
      - Libraries
      summary: Delete libraries
      description: '> **Required capabilities:** `diagramParsingAcl:WRITE`


        Delete up to 100 libraries by specifying their IDs.'
      operationId: deleteLibraries
      requestBody:
        description: List of libraries IDs to delete.
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ExternalIdsRequest'
        required: true
      x-capability:
      - diagramParsingAcl:WRITE
      responses:
        '200':
          $ref: '#/components/responses/ExternalIdsResponse'
        '400':
          $ref: '#/components/responses/ErrorResponse'
  /diagram-parsing/libraries/update:
    post:
      tags:
      - Libraries
      summary: Update libraries
      description: '> **Required capabilities:** `diagramParsingAcl:WRITE`


        Update the properties of a set of libraries.'
      operationId: updateLibraries
      requestBody:
        description: List of libraries to be updated.
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateLibrariesRequest'
        required: true
      x-capability:
      - diagramParsingAcl:WRITE
      responses:
        '200':
          $ref: '#/components/responses/LibrariesListResponse'
        '400':
          $ref: '#/components/responses/ErrorResponse'
components:
  schemas:
    GeometryDto:
      type: object
      required:
      - createdTime
      - externalId
      - lastUpdatedTime
      - paths
      - symbolId
      properties:
        createdTime:
          $ref: '#/components/schemas/EpochTimestamp'
        externalId:
          description: The external ID of the geometry
          $ref: '#/components/schemas/CogniteExternalId'
        lastUpdatedTime:
          $ref: '#/components/schemas/EpochTimestamp'
        paths:
          type: array
          description: List of paths of this geometry
          items:
            $ref: '#/components/schemas/Path'
        symbolId:
          description: The external ID of a symbol the geometry belongs to
          $ref: '#/components/schemas/CogniteExternalId'
    LibraryDto:
      type: object
      required:
      - createdTime
      - externalId
      - lastUpdatedTime
      - name
      - scope
      properties:
        createdTime:
          $ref: '#/components/schemas/EpochTimestamp'
        externalId:
          description: The external ID of the library
          $ref: '#/components/schemas/CogniteExternalId'
        lastUpdatedTime:
          $ref: '#/components/schemas/EpochTimestamp'
        name:
          description: The name of the library
          type: string
        scope:
          description: Global or project scope where the library is available
          $ref: '#/components/schemas/LibraryScope'
    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
    Path:
      description: SVG path in a custom format
      type: object
      required:
      - id
      - d
      properties:
        id:
          type: string
        d:
          description: The d attribute of an SVG path
          type: string
        styleId:
          description: The id of the style used for this path
          type: string
    DmsId:
      description: A DMS Identifier using the space and externalId
      type: object
      required:
      - space
      - externalId
      properties:
        space:
          type: string
        externalId:
          $ref: '#/components/schemas/CogniteExternalId'
    CogniteExternalId:
      description: The external ID provided by the client. Must be unique for the resource type.
      type: string
      maxLength: 255
      example: my.known.id
    LibraryUpdateItem:
      type: object
      required:
      - externalId
      - update
      properties:
        externalId:
          description: The external ID of the library
          $ref: '#/components/schemas/CogniteExternalId'
        update:
          description: The properties to be updated
          $ref: '#/components/schemas/LibraryUpdateDraft'
    CopyLibraryInput:
      type: object
      required:
      - name
      properties:
        name:
          description: The name of the copied library
          type: string
    ExtendedSymbolDto:
      description: Symbol with all of its geometries joined
      type: object
      required:
      - assetTypeId
      - externalId
      - geometries
      - lastUpdatedTime
      - libraryId
      properties:
        assetTypeId:
          $ref: '#/components/schemas/DmsId'
        createdTime:
          $ref: '#/components/schemas/EpochTimestamp'
        externalId:
          description: The external ID of the symbol
          $ref: '#/components/schemas/CogniteExternalId'
        geometries:
          description: List of geometries of this symbol
          type: array
          items:
            $ref: '#/components/schemas/GeometryDto'
        lastUpdatedTime:
          $ref: '#/components/schemas/EpochTimestamp'
        libraryId:
          description: The external ID of a library the symbol belongs to
          $ref: '#/components/schemas/CogniteExternalId'
    LibraryUpdateDraft:
      type: object
      properties:
        name:
          description: The name of the library
          type: string
    UpdateLibrariesRequest:
      type: object
      required:
      - items
      description: List of libraries to update
      minItems: 1
      maxItems: 100
      properties:
        items:
          type: array
          minItems: 1
          maxItems: 100
          items:
            type: object
            $ref: '#/components/schemas/LibraryUpdateItem'
    ExternalIdsRequest:
      type: object
      required:
      - items
      properties:
        items:
          type: array
          minItems: 1
          maxItems: 100
          items:
            type: object
            required:
            - externalId
            properties:
              externalId:
                $ref: '#/components/schemas/CogniteExternalId'
    LibraryScope:
      description: Global or project scope where library is available
      type: string
      enum:
      - Global
      - Project
    ExtendedLibraryDto:
      description: Library with all of its symbols and geometries joined
      type: object
      required:
      - createdTime
      - externalId
      - lastUpdatedTime
      - name
      - scope
      - symbols
      properties:
        createdTime:
          $ref: '#/components/schemas/EpochTimestamp'
        externalId:
          description: The external ID of the library
          $ref: '#/components/schemas/CogniteExternalId'
        lastUpdatedTime:
          $ref: '#/components/schemas/EpochTimestamp'
        name:
          description: The name of the library
          type: string
        scope:
          description: Global or project scope where the library is available
          $ref: '#/components/schemas/LibraryScope'
        symbols:
          description: List of symbols of this library
          type: array
          items:
            $ref: '#/components/schemas/ExtendedSymbolDto'
    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
    LibraryCreateDraft:
      type: object
      required:
      - externalId
      - name
      properties:
        externalId:
          description: The external ID of the library
          $ref: '#/components/schemas/CogniteExternalId'
        name:
          description: The name of the library
          type: string
    CreateLibrariesRequest:
      type: object
      required:
      - items
      description: List of libraries to create
      minItems: 1
      maxItems: 100
      properties:
        items:
          type: array
          minItems: 1
          maxItems: 100
          items:
            type: object
            $ref: '#/components/schemas/LibraryCreateDraft'
    NextCursorV3:
      description: The cursor value used to return (paginate to) the next page of results, when more data is available.
      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'
    LibrariesListWithCursorResponse:
      description: List of libraries with next cursor
      content:
        application/json:
          schema:
            type: object
            required:
            - items
            properties:
              items:
                type: array
                items:
                  $ref: '#/components/schemas/LibraryDto'
              nextCursor:
                $ref: '#/components/schemas/NextCursorV3'
    LibrariesListResponse:
      description: List of libraries
      content:
        application/json:
          schema:
            type: object
            required:
            - items
            properties:
              items:
                type: array
                items:
                  $ref: '#/components/schemas/LibraryDto'
    CopyLibraryResponse:
      description: The copied library with its symbols and geometries
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ExtendedLibraryDto'
    ExtendedLibraryResponse:
      description: A single library with its symbols and geometries
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ExtendedLibraryDto'
  parameters:
    Cursor:
      name: cursor
      description: 'Cursor for paging through results. In general, if a response contains a `nextCursor`

        property, it means that there may be more results, and you should pass that value as the

        `cursor` parameter in the next request.


        Note that the cursor may or may not be encrypted, but either way, it is not intended to be

        decoded. Its internal structure is not a part of the public API, and may change without

        notice. You should treat it as an opaque string and not attempt to craft your own cursors.

        '
      in: query
      schema:
        type: string
        example: 4zj0Vy2fo0NtNMb229mI9r1V3YG5NBL752kQz1cKtwo
    libraryIdPath:
      name: libraryId
      description: External ID of a library
      required: true
      in: path
      schema:
        $ref: '#/components/schemas/CogniteExternalId'
  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:
  - ''