20230101
20230101-beta
20230101-alpha
20230101-alpha
Search
Introduction
Postman
Pagination
Parallel retrieval
Requests throttling
API versions
Version headers
Beta versions
Alpha versions
Changelog
Changelog
2024-12-03
SAP Writeback API
Hosted Extractors API
2024-11-19
Simulator integration API
2024-11-14
User profiles
2024-11-12
Organizations and Projects
2024-10-22
Hosted Extractors API
2024-10-14
AWS Cognito support
2024-10-11
Organizations and Projects
2024-09-31
Time Series API
2024-09-19
Contextualization / Vision
2024-09-14
Simulator integration API
2024-09-13
Contextualization / Engineering diagrams
2024-09-12
Files API
SAP Writeback
2024-09-10
Time Series API
Subscriptions API
2024-09-02
Files API
2024-08-23
Data Workflows
2024-08-20
Data Workflows
2024-07-18
Organizations and Projects
2024-06-24
Data Modeling
2024-06-17
Data Modeling
2024-06-13
Organizations and Projects
Time Series
2024-05-24
Organizations and Projects
User profiles
Projects
2024-05-23
Time series
2024-05-02
Postgres gateway
2024-05-01
Time series
2024-04-02
Groups
2024-03-19
Engineering diagrams (beta)
2024-03-11
Default runtime in Cognite functions
2024-03-06
Files
2024-02-29
Assets
2024-02-20
Data Modeling
2024-02-19
Time series
2024-02-08
Hosted Extractors
2024-02-01
Synthetic time series
2024-01-16
Sessions
2024-01-02
Data Modeling
2023-12-12
Data Modeling
2023-12-11
Time series
2023-12-06
Time series
2023-11-30
Hosted extractors
2023-11-21
Units Catalog
2023-11-17
Documents
2023-11-08
Engineering diagrams
2023-10-23
Files
2023-10-17
Events
2023-10-10
Entity matching
Vision (Contextualization)
2023-10-05
Hosted extractors
2023-09-27
3D
2023-08-25
Transformations
2023-08-22
Functions
2023-08-22
Time series
2023-08-10
Time series
Sequences
2023-08-08
Assets
Events
Documents
2023-06-27
IAM (Identity and access management)
2023-06-05
Data Modeling
Time series
Sequences
2023-05-19
Transformations
2023-04-24
Transformations
2023-05-04
Annotations
2023-04-18
All resources
Assets
Events
Documents
2023-04-12
Sessions
2023-04-04
Transformations
2023-03-06
Documents
2023-02-03
Seismic
2023-02-07
Documents
2023-01-18
3D
2023-01-17
Authentication
3D
2023-01-12
Documents
2023-01-10
Documents
2023-01-09
Documents
2023-01-06
Documents
2023-01-02
Documents
2022-12-06
3D
2022-12-16
Time series
2022-11-29
Events
2022-11-17
Time series
2022-10-14
Geospatial
2022-10-11
Transformations
2022-10-06
IAM (Identity and access management)
2022-09-09
Vision (Contextualization)
2022-08-12
Time series
2022-07-21
Transformations
2022-06-21
Annotations (Data organization)
2022-07-07
Events
2022-06-13
IAM (Identity and access management)
2022-05-20
Documents
2022-05-12
Documents
2022-04-11
Documents
2022-03-15
Sequences
2022-03-02
Sequences
2022-02-08
Time series
2022-02-07
Documents
2022-01-25
Documents
2022-01-24
Time series
2021-12-07
Transformations
2021-11-22
Contextualization
2021-11-17
3D
2021-10-13
Raw
2021-10-05
Extraction Pipelines
2021-09-28
Sequences
Time series
2021-08-18
IAM (Identity and access management)
2021-08-12
Relationships
2021-07-01
3D
2021-06-29
Labels
2021-06-08
Sequences
2021-06-01
Assets
2021-04-28
Time series
2021-04-12
IAM (Identity and access management)
2021-04-06
Authentication
2021-03-22
2021-03-10
3D
2021-02-26
Entity matching
2020-12-22
Files
2020-10-20
Files
2020-08-29
Files
2020-08-05
Files
2020-07-08
IAM (Identity and access management)
2020-07-01
Events
2020-06-29
Labels
Assets
Time series
2020-04-28
Events
2020-03-12
General
Groups
2020-03-10
3D
2020-02-25
Assets
Events
2020-02-12
Assets
2020-02-10
Assets
2019-12-09
General
2019-12-04
Assets
2019-11-18
Events
2019-11-12
Access control
2019-10-31
Assets
Time Series
2019-10-23
Files
2019-10-18
Time Series
2019-10-16
Events
2019-10-02
Sequences
2019-09-30
3D
2019-09-23
Files
2019-09-16
Assets and Events
2019-08-22
3D
2019-08-21
Files
Assets
2019-08-15
3D
2019-07-24
Files
2019-07-15
Time series
2019-07-11
General
Assets
Events
Files
Raw
Time series
IAM (Identity and access management)
3D
Organizations and projects
Organizations
External identity providers (IdP)
Users
Organization hierarchy
Projects
Allowed clusters
Organization admins
Authentication for this API
put
Allow/forbid admins of an organization to create projects
put
Allow/forbid admins of an organization to create sub-organizations
post
Create an organization
post
Create an organization
del
Delete an organization
post
Delete an organization
get
List child organizations
get
List child organizations
get
Retrieve an organization
get
Retrieve an organization
put
Update the admin group ID for an organization
put
Update the allowed clusters for an organization
put
Update the IdP configuration for an organization
Projects
post
Create a project
post
Create a project
get
List projects in an organization
get
List projects in an organization
Identity and access management
Groups
post
Create groups
post
Delete groups
get
List groups
Security categories
post
Create security categories
post
Delete security categories
get
List security categories
Sessions
post
Create sessions
get
List sessions
post
Retrieve sessions with given IDs
post
Revoke sessions
Token
get
Inspect
User profiles
get
(deprecated) Get the user profile of the principal issuing the request
get
Get the user profile of the principal issuing the request
get
List all user profiles in the current project
get
List users in the organization
post
Retrieve profiles by ID in the current project
post
Search user profiles in the current project
Data modeling
Data Modeling
Data models
post
Create or update data models
post
Delete data models
get
List data models defined in the project
post
Retrieve data models by their external ids
Spaces
post
Create or update spaces
post
Delete spaces
get
List spaces defined in the project
post
Retrieve spaces by their space-ids
Views
post
Create or update views
post
Delete views
get
List views defined in the project
post
Retrieve views by their external ids
Containers
post
Create or update containers
post
Delete constraints from containers
post
Delete containers
post
Delete indexes from containers
post
Inspect containers
get
List containers defined in the project
post
Retrieve containers by their external ids
Instances
post
Aggregate data across nodes/edges
post
Create or update nodes/edges
post
Delete nodes/edges
post
Filter nodes/edges
post
Inspect instances
post
Query nodes/edges
post
Retrieve nodes/edges by their external ids
post
Search for nodes/edges
post
Sync nodes/edges
Asset-centric data model
Assets
Rate and concurrency limits
Translating RPS into data speed
Use of Partitions / Parallel Retrieval
post
Aggregate assets
post
Create assets
post
Delete assets
post
Filter assets
get
List assets
get
Retrieve an asset by its ID
post
Retrieve assets
post
Search assets
post
Update assets
Time series
post
Aggregate time series
post
Create time series
post
Delete data points
post
Delete time series
post
Filter time series
post
Insert data points
get
List time series
post
Retrieve data points
post
Retrieve latest data point
post
Retrieve time series
post
Search time series
post
Update time series
Synthetic Time Series
post
Synthetic query
Data point subscriptions
post
Create subscriptions
post
Delete subscriptions
post
List subscription data
get
List subscription members
get
List subscriptions
post
Retrieve subscriptions
post
Update subscriptions
Events
Rate and concurrency limits
Translating RPS into data speed
Use of Partitions / Parallel Retrieval
post
Aggregate events
post
Create events
post
Delete events
post
Filter events
get
List events
get
Receive an event by its ID
post
Retrieve events
post
Search events
post
Update events
Files
Rate and concurrency limits
Translating RPS into data speed
Use of Partitions / Parallel Retrieval
post
Aggregate files
post
Complete multipart upload
post
Delete files
post
Download files
post
Filter files
get
Get icon
post
Get multipart file upload link
post
Get upload file link
get
List files
get
Retrieve a file by its ID
post
Retrieve files
post
Search files
post
Update files
post
Upload file
post
Upload multipart file
Sequences
post
Aggregate sequences
post
Create sequences
post
Delete rows
post
Delete sequences
post
Filter sequences
post
Insert rows
get
List sequences
post
Retrieve last row
post
Retrieve rows
post
Retrieve sequences
post
Search sequences
post
Update sequences
Geospatial
post
Aggregate features
post
Compute
post
Create Coordinate Reference Systems
post
Create feature types
post
Create features
post
Delete a raster from a feature property
post
Delete Coordinate Reference Systems
post
Delete feature types
post
Delete features
post
Filter all features
post
Get a raster from a feature property
post
Get Coordinate Reference Systems
get
Get features
get
List Coordinate Reference Systems
post
List feature types
put
Put a raster into a feature property
post
Retrieve feature types
post
Retrieve features
post
Search and stream features
post
Search features
post
Update feature types
post
Update features
Seismic
get
Download a seismic object as a SEG-Y file
post
Download multiple seismic objects as a ZIP archive
3D
3D Models
post
Create 3D models
post
Delete 3D models
get
List 3D models
get
Retrieve a 3D model
post
Update 3D models
3D Model Revisions
post
Create 3D revisions
post
Delete 3D revisions
post
Filter 3D nodes
post
Get 3D nodes by ID
get
List 3D ancestor nodes
get
List 3D nodes
get
List 3D revision logs
get
List 3D revisions
get
List available outputs
get
Retrieve a 3D revision
post
Update 3D revision thumbnail
post
Update 3D revisions
3D Files
get
Retrieve a 3D directory file
get
Retrieve a single 3D file
3D Asset Mapping
post
Create 3D asset mappings
post
Delete 3D asset mappings
post
Filter 3D asset mappings
get
List 3D asset mappings
get
List mappings for one assetID across all 3D models
Contextualization
Entity matching
post
Create entity matcher model
post
Delete entity matcher model
post
Filter models
get
List entity matching models
post
Predict matches
post
Re-fit entity matcher model
get
Retrieve an entity matching model by the ID of the model
get
Retrieve entity matcher predict results
post
Retrieve entity matching models
post
Update entity matching models
Entity matching pipelines
post
Create pipelines
post
Delete pipelines
get
Get latest pipeline run results
get
Get pipeline
get
Get pipeline run results
get
List pipeline runs
get
List pipelines
post
Retrieve multiple pipelines
post
Run pipeline
post
Update pipelines
Engineering diagrams
post
Convert a diagram to image format
post
Detect annotations in engineering diagrams
get
Get the results for converting an engineering diagram to an image
get
Retrieve engineering diagram detect results
post
Retrieve OCR text
Vision
post
Extract features from images
get
Retrieve results from a feature extraction job on images
get
Retrieve results from a segmentation job on an image
post
Segment objects in an image
Advanced joins
Concepts
Advanced joins
Matches
Matchers
Jobs
post
Create advanced joins
post
Create matches
post
Delete advanced joins
post
Delete matches
post
Estimate contextualization quality
get
List advanced joins
get
List matches
post
Measure mapped percentages
get
Retrieve advanced join run status
get
Retrieve estimate quality status
get
Retrieve mapped percentage status
get
Retrieve suggested improvements
post
Run an advanced join
post
Suggest improvements
post
Update advanced joins
Diagram Parsing
Parsing
post
Run an instant parsing job for a file
post
Run parsing for files
post
Run parsing with tag detection for files
Libraries
post
Copy library
post
Create libraries
post
Delete libraries
get
Get a library with symbols
get
List libraries
post
Retrieve libraries
post
Update libraries
Symbols
post
Create symbols
post
Delete symbols
get
List symbols
post
Retrieve symbols
post
Update symbols
Geometries
post
Create geometries
post
Delete geometries
get
List geometries
post
Retrieve geometries
post
Update geometries
Diagrams
post
Filter diagrams
get
Get an extended diagram by external id
get
Get an extended diagram by file reference
get
Get an extended diagram with paths by external id
get
List diagrams
post
Retrieve diagrams
Entities
post
Create diagram entities
post
Delete diagram entities
get
List diagram entities
post
Retrieve diagram entities
post
Update diagram entities
Connections
post
Create connections
post
Delete connections
get
List connections
post
Retrieve connections
SVG Data
get
Get SVG data by diagramId
get
Get SVG data by file reference
Cognite AI
Document AI
post
Ask questions about one or more documents
post
Summarize documents
Documents
Documents
Derived fields
File type support
post
Aggregate documents
post
Document status
post
List documents
get
Retrieve document content
post
Retrieve document content
get
Retrieve parsed document content
post
Search for documents
post
Semantic search
post
Semantic search for passages
Preview
File type support
get
Retrieve a image preview of a page from a document
get
Retrieve a PDF preview of a document
get
Retrieve a temporary link to a PDF preview of a document
Data ingestion
Raw
Request and concurrency limits
post
Create databases
post
Create tables in a database
post
Delete databases
post
Delete rows in a table
post
Delete tables in a database
post
Insert rows into a table
get
List databases
get
List tables in a database
get
Retrieve cursors for parallel reads
get
Retrieve row by key
get
Retrieve rows from a table
Extraction Pipelines
post
Create extraction pipelines
post
Delete extraction pipelines
post
Filter extraction pipelines
get
List extraction pipelines
get
Retrieve an extraction pipeline by its ID.
post
Retrieve extraction pipelines
post
Update extraction pipelines
Extraction Pipelines Runs
post
Create extraction pipeline runs
post
Filter extraction pipeline runs
get
List extraction pipeline runs
Extraction Pipelines Config
post
Create extraction configuration revision
get
Get a single configuration revision
get
List configuration revisions
post
Revert configuration revision
Data organization
Data sets
post
Aggregate data sets
post
Create data sets
post
Filter data sets
post
Retrieve data sets
post
Update data sets.
Labels
post
Create label definitions.
post
Delete label definitions.
post
Filter labels
post
Retrieve labels
Relationships
post
Create relationships
post
Delete relationships
post
Filter relationships
get
List relationships
post
Retrieve relationships
post
Update relationships
Annotations
post
Create annotations
post
Delete annotations
post
Filter annotations
get
Get an annotation
post
Retrieve annotations
post
Reverse lookup
post
Suggest annotations
post
Update annotations
Transformations
Transformations
Concurrency limits
post
Cancel a transformation
post
Create transformations
post
Delete transformations
post
Filter transformations
get
List transformations
post
Retrieve transformations
post
Run a transformation
post
Update transformations
Transformation Jobs
get
List job metrics by job id
get
List jobs
post
Retrieve jobs by ids
Transformation Schedules
get
List all schedules
post
Retrieve schedules
post
Schedule transformations
post
Unschedule transformations
post
Update schedules
Transformation Notifications
post
Delete notification subscriptions by notification ID
get
List notification subscriptions
post
Subscribe for notifications
Query
post
Run query
Schema
get
Get Instance schema.
get
Get the schema of a sequence
get
Get the schema of resource type
Functions
Functions
post
Activate Functions
post
Create functions
post
Delete functions
post
Filter functions
get
Functions limits
get
Get activation status
get
List functions
get
Retrieve a function by its id
post
Retrieve functions
Function calls
post
Call a function asynchronously
post
Filter function calls
get
List function calls
get
Retrieve a function call by its id
post
Retrieve calls
get
Retrieve logs for function call
get
Retrieve response for function call
Function schedules
post
Create schedules
post
Delete schedules
post
Filter function schedules
get
List schedules
get
Retrieve a function schedule by its id
get
Retrieve function input data
post
Retrieve schedules
Hosted Extractors
Sources
post
Create Sources
post
Delete Sources
get
List Sources
post
Retrieve Sources
post
Update Sources
Jobs
post
Create Jobs
post
Delete Jobs
get
Get Job Logs
get
Get Job Metrics
get
List Jobs
post
Retrieve Jobs
post
Update Jobs
Destinations
post
Create Destinations
post
Delete Destinations
get
List Destinations
post
Retrieve Destinations
post
Update Destinations
Mappings
post
Create Mappings
post
Delete Mappings
get
List Mappings
post
Retrieve Mappings
post
Update Mappings
Previews
post
Create Preview
post
Download preview result
post
Get preview result
PostgreSQL Gateway
Postgres Gateway Users
post
Create users
post
Delete users
post
Filter users
get
List users
post
Retrieve users
post
Update users
Postgres Gateway Tables
post
Create tables
post
Delete tables
get
List tables
post
Retrieve tables
SAP Writeback
SAP Instances
post
Create SAP Instances
post
Delete SAP Instances
get
List SAP Instances
post
Retrieve SAP Instances
SAP Endpoints
post
Create SAP Endpoints
post
Delete SAP Endpoints
get
List SAP Endpoints
post
Retrieve SAP Endpoints
post
Verify SAP Endpoint
Schema Mappings
post
Create Mappings
post
Delete Mappings
get
List Mappings
post
Retrieve Mappings
Writeback Requests
post
Create Writeback Requests
get
List Writeback Requests
post
Retrieve Writeback Requests
Data workflows
Workflows
post
Create or update a workflow
post
Delete workflows
get
List workflows
get
Retrieve a workflow
Workflow versions
post
Create or update a workflow version
post
Delete workflow versions
post
Filter workflow versions
get
Retrieve a workflow version
Workflow executions
post
Cancel a workflow execution
post
Filter workflow executions
get
Retrieve workflow execution details
post
Retry workflow execution
post
Run a workflow
Workflow triggers
post
Create or update triggers
post
Delete triggers
get
Get the run history of a trigger
get
List triggers
Tasks
post
Update task status
Simulators
Simulators
post
Filter Simulators
Simulator Integrations
post
Delete Simulator Integrations
post
Filter Simulator Integrations
Simulator Models
post
Aggregate Simulator Models
post
Create Simulator Model
post
Create Simulator Model Revision
post
Delete Simulator Model
post
Filter Simulator Model Revisions
post
Filter Simulator Models
post
Retrieve Simulator Model
post
Retrieve Simulator Model Revisions
post
Update Simulator Model
Simulator Routines
post
Create Simulator Routine
post
Create Simulator Routine Revision
post
Delete Simulator Routine
post
Filter Simulator Routine Revisions
post
Filter Simulator Routines
post
Retrieve Simulator Routine Revisions
Simulation Runs
post
Filter Simulation Runs
post
Run Simulation
post
Simulation By Id
post
Simulation Data By Run Id
Simulator Logs
post
Simulator Logs By Ids
Units
Units
get
List all units
get
Retrieve unit by external ID
post
Retrieve units by external IDs
Unit Systems
get
List all unit systems
Token
Access tokens issued by an IdP (Azure AD, Google, etc.) are used to access CDF resources.
➔ Next to
Token / Inspect