Class CogniteClient

Hierarchy (view full)

default
- CogniteClient

Constructors

constructor

new CogniteClient(options, apiVersion?): CogniteClient

Create a new SDK client

Parameters

options: ClientOptions

Client options

import { CogniteClient } from '@cognite/sdk';

const client = new CogniteClient({ appId: 'YOUR APPLICATION NAME' });

// can also specify a base URL
const client = new CogniteClient({ ..., baseUrl: 'https://greenfield.cognitedata.com' });

apiVersion: "v1" = 'v1'

Returns CogniteClient

Properties

authenticate

authenticate: (() => Promise<undefined | string>) = ...

`Readonly`project

project: string

Accessors

annotations

get annotations(): AnnotationsAPI
Returns AnnotationsAPI
Deprecated
Asset-centric API, deprecated 2026-10-15 and retired 2027-12-31. Will be removed or moved in a future major release. See https://docs.cognite.com/cdf/deprecated and https://github.com/cognitedata/cognite-sdk-js/blob/master/guides/DEPRECATIONS.md.
- Defined in packages/stable/src/cogniteClient.ts:151

assetMappings3D

get assetMappings3D(): AssetMappings3DAPI
Returns AssetMappings3DAPI
Deprecated
Asset-centric 3D contextualization is deprecated 2026-10-15; no retirement date is announced. Use the 3D contextualization APIs in data modeling (public preview, not in this SDK yet). Will be removed or moved in a future major release. See https://docs.cognite.com/cdf/deprecated and https://github.com/cognitedata/cognite-sdk-js/blob/master/guides/DEPRECATIONS.md.
- Defined in packages/stable/src/cogniteClient.ts:124

templates

get templates(): {
    group: ((externalId: string) => {
        version: ((version: number) => {
            instances: TemplateInstancesApi;
            runQuery: (<TVariables>(graphQlParams: {
                operationName?: string;
                query: string;
                variables?: TVariables;
            }) => Promise<GraphQlResponse>);
            views: ViewsApi;
        });
        versions: TemplateGroupVersionsApi;
    });
    groups: TemplateGroupsApi;
}
Returns {
    group: ((externalId: string) => {
        version: ((version: number) => {
            instances: TemplateInstancesApi;
            runQuery: (<TVariables>(graphQlParams: {
                operationName?: string;
                query: string;
                variables?: TVariables;
            }) => Promise<GraphQlResponse>);
            views: ViewsApi;
        });
        versions: TemplateGroupVersionsApi;
    });
    groups: TemplateGroupsApi;
}
- group: ((externalId: string) => {
      version: ((version: number) => {
          instances: TemplateInstancesApi;
          runQuery: (<TVariables>(graphQlParams: {
              operationName?: string;
              query: string;
              variables?: TVariables;
          }) => Promise<GraphQlResponse>);
          views: ViewsApi;
      });
      versions: TemplateGroupVersionsApi;
  })
  - - (externalId): {
          version: ((version: number) => {
              instances: TemplateInstancesApi;
              runQuery: (<TVariables>(graphQlParams: {
                  operationName?: string;
                  query: string;
                  variables?: TVariables;
              }) => Promise<GraphQlResponse>);
              views: ViewsApi;
          });
          versions: TemplateGroupVersionsApi;
      }
    - Parameters
      externalId: string
      Returns {
          version: ((version: number) => {
              instances: TemplateInstancesApi;
              runQuery: (<TVariables>(graphQlParams: {
                  operationName?: string;
                  query: string;
                  variables?: TVariables;
              }) => Promise<GraphQlResponse>);
              views: ViewsApi;
          });
          versions: TemplateGroupVersionsApi;
      }
      - version: ((version: number) => {
            instances: TemplateInstancesApi;
            runQuery: (<TVariables>(graphQlParams: {
                operationName?: string;
                query: string;
                variables?: TVariables;
            }) => Promise<GraphQlResponse>);
            views: ViewsApi;
        })
        (version): {
            instances: TemplateInstancesApi;
            runQuery: (<TVariables>(graphQlParams: {
                operationName?: string;
                query: string;
                variables?: TVariables;
            }) => Promise<GraphQlResponse>);
            views: ViewsApi;
        }
        Parameters
        version: number
        Returns {
            instances: TemplateInstancesApi;
            runQuery: (<TVariables>(graphQlParams: {
                operationName?: string;
                query: string;
                variables?: TVariables;
            }) => Promise<GraphQlResponse>);
            views: ViewsApi;
        }
        instances: TemplateInstancesApi
        runQuery: (<TVariables>(graphQlParams: {
            operationName?: string;
            query: string;
            variables?: TVariables;
        }) => Promise<GraphQlResponse>)
        <TVariables>(graphQlParams): Promise<GraphQlResponse>
        Type Parameters
        TVariables extends Record<string, unknown>
        Parameters
        graphQlParams: {
            operationName?: string;
            query: string;
            variables?: TVariables;
        }
        OptionaloperationName?: string
        query: string
        Optionalvariables?: TVariables
        Returns Promise<GraphQlResponse>
        views: ViewsApi
      - versions: TemplateGroupVersionsApi
- groups: TemplateGroupsApi
Deprecated
Templates API was retired 2025-05-31 and will be removed in the next major release. See https://github.com/cognitedata/cognite-sdk-js/blob/master/guides/DEPRECATIONS.md for details.
- Defined in packages/stable/src/cogniteClient.ts:172

timeseries

get timeseries(): TimeSeriesAPI
Returns TimeSeriesAPI
- Defined in packages/stable/src/cogniteClient.ts:61

units

get units(): UnitsAPI
Returns UnitsAPI
- Defined in packages/stable/src/cogniteClient.ts:211

viewer3D

get viewer3D(): Viewer3DAPI
Returns Viewer3DAPI
- Defined in packages/stable/src/cogniteClient.ts:127

views

get views(): ViewsAPI
Returns ViewsAPI
- Defined in packages/stable/src/cogniteClient.ts:220

vision

get vision(): VisionAPI
Returns VisionAPI
Deprecated
Retirement date: 2027-02-17. See https://docs.cognite.com/cdf/deprecated#deprecated-and-retired-features for more details.
- Defined in packages/stable/src/cogniteClient.ts:157

Methods

delete

delete<T>(path, options?): Promise<HttpResponse<T>>
Basic HTTP method for DELETE
Type Parameters
- T = unknown
Parameters
- path: string
  The URL path
- Optionaloptions: RetryableHttpRequestOptions
  Request options, optional
```
const response = await client.delete('someUrl');
```
Returns Promise<HttpResponse<T>>
Inherited from default.delete
- Defined in packages/core/src/baseCogniteClient.ts:310

get

get<T>(path, options?): Promise<HttpResponse<T>>
Basic HTTP method for GET
Type Parameters
- T = unknown
Parameters
- path: string
  The URL path
- Optionaloptions: RetryableHttpRequestOptions
  Request options, optional
```
const response = await client.get('/api/v1/projects/{project}/assets', { params: { limit: 50 }});
```
Returns Promise<HttpResponse<T>>
Inherited from default.get
- Defined in packages/core/src/baseCogniteClient.ts:265

getBaseUrl

getBaseUrl(): string
Returns the base-url used for all requests.

Returns string
Inherited from default.getBaseUrl
- Defined in packages/core/src/baseCogniteClient.ts:225

getDefaultRequestHeaders

getDefaultRequestHeaders(): HttpHeaders
Returns the default HTTP request headers, including e.g. authentication headers that is included in all requests. Headers provided per-requests is not included in this list. This function is useful when constructing API requests outside the SDK.
```
const customUrl = '...';
const headers = client.getDefaultRequestHeaders();
const result = await fetch(customUrl, { headers });
```
Returns HttpHeaders
Inherited from default.getDefaultRequestHeaders
- Defined in packages/core/src/baseCogniteClient.ts:241

getMetadata

getMetadata(value): undefined | Metadata
Lookup response metadata from an request using the response as the parameter
```
const createdAsset = await client.assets.create([{ name: 'My first asset' }]);
const metadata = client.getMetadata(createdAsset);
```
Parameters
- value: object
Returns undefined | Metadata
Inherited from default.getMetadata
- Defined in packages/core/src/baseCogniteClient.ts:253

patch

patch<T>(path, options?): Promise<HttpResponse<T>>
Basic HTTP method for PATCH
Type Parameters
- T = unknown
Parameters
- path: string
  The URL path
- Optionaloptions: RetryableHttpRequestOptions
  Request options, optional
```
const response = await client.patch('someUrl');
```
Returns Promise<HttpResponse<T>>
Inherited from default.patch
- Defined in packages/core/src/baseCogniteClient.ts:324

post

post<T>(path, options?): Promise<HttpResponse<T>>
Basic HTTP method for POST
Type Parameters
- T = unknown
Parameters
- path: string
  The URL path
- Optionaloptions: RetryableHttpRequestOptions
  Request options, optional
```
const assets = [{ name: 'First asset' }, { name: 'Second asset' }];
const response = await client.post('/api/v1/projects/{project}/assets', { data: { items: assets } });
```
Returns Promise<HttpResponse<T>>
Inherited from default.post
- Defined in packages/core/src/baseCogniteClient.ts:296

put

put<T>(path, options?): Promise<HttpResponse<T>>
Basic HTTP method for PUT
Type Parameters
- T = unknown
Parameters
- path: string
  The URL path
- Optionaloptions: RetryableHttpRequestOptions
  Request options, optional
```
const response = await client.put('someUrl');
```
Returns Promise<HttpResponse<T>>
Inherited from default.put
- Defined in packages/core/src/baseCogniteClient.ts:280

`Static`urlEncodeExternalId

urlEncodeExternalId(externalId): string
Parameters
- externalId: string
Returns string
- Defined in packages/stable/src/cogniteClient.ts:340

Class CogniteClient

Hierarchy (view full)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns CogniteClient

Properties

authenticate

Readonlyproject

Accessors

annotations

Returns AnnotationsAPI

Deprecated

assetMappings3D

Returns AssetMappings3DAPI

Deprecated

assets

Returns AssetsAPI

Deprecated

containers

Returns ContainersAPI

dataModels

Returns DataModelsAPI

dataProducts

Returns DataProductsAPI

datapoints

Returns DataPointsAPI

datasets

Returns DataSetsAPI

Deprecated

documents

Returns DocumentsAPI

entityMatching

Returns EntityMatchingApi

events

Returns EventsAPI

Deprecated

extractors

Returns ExtractorsAPI

files

Returns FilesAPI

files3D

Returns Files3DAPI

functions

Returns FunctionsAPI

geospatial

Returns GeospatialAPI

Deprecated

groups

Returns GroupsAPI

instances

Returns InstancesAPI

labels

Returns LabelsAPI

Deprecated

models3D

Returns Models3DAPI

profiles

Returns ProfilesAPI

projects

Returns ProjectsAPI

raw

Returns RawAPI

records

Returns RecordsAPI

relationships

Returns RelationshipsApi

Deprecated

revisions3D

Returns Revisions3DAPI

securityCategories

Returns SecurityCategoriesAPI

Deprecated

sequences

Returns SequencesAPI

`Readonly`project

group: ((externalId: string) => {
version: ((version: number) => {
instances: TemplateInstancesApi;
runQuery: (<TVariables>(graphQlParams: {
operationName?: string;
query: string;
variables?: TVariables;
}) => Promise<GraphQlResponse>);
views: ViewsApi;
});
versions: TemplateGroupVersionsApi;
})

Returns {
version: ((version: number) => {
instances: TemplateInstancesApi;
runQuery: (<TVariables>(graphQlParams: {
operationName?: string;
query: string;
variables?: TVariables;
}) => Promise<GraphQlResponse>);
views: ViewsApi;
});
versions: TemplateGroupVersionsApi;
}

version: ((version: number) => {
instances: TemplateInstancesApi;
runQuery: (<TVariables>(graphQlParams: {
operationName?: string;
query: string;
variables?: TVariables;
}) => Promise<GraphQlResponse>);
views: ViewsApi;
})

Returns {
instances: TemplateInstancesApi;
runQuery: (<TVariables>(graphQlParams: {
operationName?: string;
query: string;
variables?: TVariables;
}) => Promise<GraphQlResponse>);
views: ViewsApi;
}

runQuery: (<TVariables>(graphQlParams: {
operationName?: string;
query: string;
variables?: TVariables;
}) => Promise<GraphQlResponse>)

`Optional`operationName?: string

`Optional`variables?: TVariables

`Static`urlEncodeExternalId