Cognite Entities API
The Entities API from Cognite — 4 operation(s) for entities.
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.
Call it yourself
curl for this page
This API
curl "https://apis.io/api/v1/apis/cognite:cognite-entities-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.
A second provider on the same verified email joins the account you already have.
OpenAPI Specification
openapi: 3.2.0
info:
title: Cognite Entities 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: Entities
paths:
/diagram-parsing/entities:
get:
tags:
- Entities
summary: List diagram entities
description: '> **Required capabilities:** `diagramParsingAcl:READ`
List all diagram entities defined for the diagram specified by the diagramId parameter.'
operationId: listDiagramEntities
parameters:
- $ref: '#/components/parameters/Cursor'
- $ref: '#/components/parameters/diagramId'
x-capability:
- diagramParsingAcl:READ
responses:
'200':
$ref: '#/components/responses/EntitiesListWithCursorResponse'
'400':
$ref: '#/components/responses/ErrorResponse'
post:
tags:
- Entities
summary: Create diagram entities
description: '> **Required capabilities:** `diagramParsingAcl:WRITE`
Create diagram entities.'
operationId: createDiagramEntities
requestBody:
description: Diagram entities to create.
content:
application/json:
schema:
$ref: '#/components/schemas/CreateEntitiesRequest'
required: true
x-capability:
- diagramParsingAcl:WRITE
responses:
'200':
$ref: '#/components/responses/EntitiesListResponse'
'400':
$ref: '#/components/responses/ErrorResponse'
/diagram-parsing/entities/byids:
post:
tags:
- Entities
summary: Retrieve diagram entities
description: '> **Required capabilities:** `diagramParsingAcl:READ`
Retrieve up to 100 diagram entities by specifying their IDs.'
operationId: multiGetDiagramEntities
requestBody:
description: List of IDs for the diagram entities to return.
content:
application/json:
schema:
$ref: '#/components/schemas/ExternalIdsRequest'
required: true
x-capability:
- diagramParsingAcl:READ
responses:
'200':
$ref: '#/components/responses/EntitiesListResponse'
'400':
$ref: '#/components/responses/ErrorResponse'
/diagram-parsing/entities/delete:
post:
tags:
- Entities
summary: Delete diagram entities
description: '> **Required capabilities:** `diagramParsingAcl:WRITE`
Delete up to 100 diagram entities by specifying their IDs.'
operationId: deleteDiagramEntities
requestBody:
description: List of diagram entity 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/entities/update:
post:
tags:
- Entities
summary: Update diagram entities
description: '> **Required capabilities:** `diagramParsingAcl:WRITE`
Update the properties of a set of diagram entities'
operationId: updateDiagramEntities
requestBody:
description: List of diagram entities to be updated.
content:
application/json:
schema:
$ref: '#/components/schemas/UpdateEntitiesRequest'
required: true
x-capability:
- diagramParsingAcl:WRITE
responses:
'200':
$ref: '#/components/responses/EntitiesListResponse'
'400':
$ref: '#/components/responses/ErrorResponse'
components:
schemas:
EntityCreateDraft:
type: object
required:
- diagramId
- externalId
- isAssetVerified
- isUserDetected
- pathIds
- symbolId
properties:
annotationId:
description: DMS identifier of a Diagram Annotation used to determine the asset to which the diagram entity is mapped
$ref: '#/components/schemas/DmsId'
assetId:
description: DMS identifier of the asset to which the diagram entity is mapped
$ref: '#/components/schemas/DmsId'
diagramId:
description: The external ID of a diagram the entity belongs to
$ref: '#/components/schemas/CogniteExternalId'
externalId:
description: The external ID of the diagram entity
$ref: '#/components/schemas/CogniteExternalId'
isAssetVerified:
description: Determines if a diagram entity has a verified asset mapping
type: boolean
isUserDetected:
description: Determines if a diagram entity was detected manually
type: boolean
pathIds:
type: array
items:
type: string
symbolId:
description: The external ID of the symbol this diagram entity is detected as
$ref: '#/components/schemas/CogniteExternalId'
ExternalIdsRequest:
type: object
required:
- items
properties:
items:
type: array
minItems: 1
maxItems: 100
items:
type: object
required:
- externalId
properties:
externalId:
$ref: '#/components/schemas/CogniteExternalId'
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
UpdateEntitiesRequest:
type: object
required:
- items
description: List of diagram entities to update
minItems: 1
maxItems: 100
properties:
items:
type: array
minItems: 1
maxItems: 100
items:
type: object
$ref: '#/components/schemas/EntityUpdateItem'
EntityUpdateItem:
type: object
required:
- externalId
- update
properties:
externalId:
description: The external ID of the diagram entity
$ref: '#/components/schemas/CogniteExternalId'
update:
description: The properties to be updated
$ref: '#/components/schemas/EntityUpdateDraft'
EntityUpdateDraft:
type: object
properties:
annotationId:
description: DMS identifier of a linked diagram annotation
anyOf:
- type: 'null'
- $ref: '#/components/schemas/DmsId'
assetId:
description: DMS identifier of a mapped asset
anyOf:
- type: 'null'
- $ref: '#/components/schemas/DmsId'
isAssetVerified:
description: Determines if a diagram entity has a verified asset mapping
type: boolean
isUserDetected:
description: Determines if a diagram entity was detected manually
type: boolean
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
EntityDto:
type: object
required:
- createdTime
- diagramId
- externalId
- isAssetVerified
- isUserDetected
- lastUpdatedTime
- pathIds
- symbolId
properties:
annotationId:
description: DMS identifier of a linked Diagram Annotation
$ref: '#/components/schemas/DmsId'
assetId:
description: DMS identifier of a mapped asset
$ref: '#/components/schemas/DmsId'
createdTime:
$ref: '#/components/schemas/EpochTimestamp'
diagramId:
description: The external ID of a diagram this entity belongs to
$ref: '#/components/schemas/CogniteExternalId'
externalId:
description: The external ID of the diagram entity
$ref: '#/components/schemas/CogniteExternalId'
isAssetVerified:
description: Determines if a diagram entity has a verified asset mapping
type: boolean
isUserDetected:
description: Determines if a diagram entity was detected manually
type: boolean
lastUpdatedTime:
$ref: '#/components/schemas/EpochTimestamp'
pathIds:
type: array
items:
type: string
symbolId:
description: The external ID of the symbol this diagram entity is detected as
$ref: '#/components/schemas/CogniteExternalId'
CreateEntitiesRequest:
type: object
required:
- items
description: List of diagram entities to create
minItems: 1
maxItems: 100
properties:
items:
type: array
minItems: 1
maxItems: 100
items:
type: object
$ref: '#/components/schemas/EntityCreateDraft'
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
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'
EntitiesListWithCursorResponse:
description: List of diagram entities with next cursor
content:
application/json:
schema:
type: object
required:
- items
properties:
items:
type: array
items:
$ref: '#/components/schemas/EntityDto'
nextCursor:
$ref: '#/components/schemas/NextCursorV3'
EntitiesListResponse:
description: List of diagram entities
content:
application/json:
schema:
type: object
required:
- items
properties:
items:
type: array
items:
$ref: '#/components/schemas/EntityDto'
parameters:
diagramId:
name: diagramId
description: Retrieve items related to the diagram
in: query
schema:
$ref: '#/components/schemas/CogniteExternalId'
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
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:
- ''