Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.cognite.com/llms.txt

Use this file to discover all available pages before exploring further.

We recommend downloading, installing, and using Postman to test API requests and verify responses.
No admin setup required. Sign up at Cognite Hub and get credentials from OpenID Connect on Open Industrial Data. Use cluster api, project publicdatacdm.
1

Import your Postman collection

  1. Download the Cognite OpenAPI specification.
  2. In Postman, select Import and drag the file to the import modal.
  3. In View Import Settings: set Folder organization to Tags, turn off Enable optional parameters, turn on Always inherit authentication.
  4. Select Continue > Import.
2

Set up environment variables

  1. Navigate to Environments on the left sidebar. Click + Create new Environment and give it a name.
  2. Add these variables using values from the Open Industrial Data credentials:
    • tenant-id: From the Hub article
    • token: Leave blank. OAuth 2.0 will populate it automatically.
    • baseUrl: https://api.cognitedata.com/api/v1/projects/publicdatacdm
    • project: publicdatacdm
  3. Click Save and select your environment in the dropdown in the top right corner.
3

Configure OAuth 2.0 authorization

  1. Navigate to the Authorization tab in the collection overview.
  2. Set Type to OAuth 2.0 and Add authorization data to to Request Headers.
  3. Select Configure New Token and specify:
    • Grant Type: Implicit
    • Callback URL: https://postman.cogniteapp.com/loggedin
    • Auth URL: https://login.microsoftonline.com/{{tenant-id}}/oauth2/v2.0/authorize
    • Client ID: Use the Postman Client ID from the Open Industrial Data credentials (OID-Api app)
    • Scope: https://api.cognitedata.com/user_impersonation or https://api.cognitedata.com/DATA.VIEW
    • Client Authentication: Send as Basic Auth header
  4. Select Get New Access Token > Proceed > Use Token.
4

Send your API request

  1. Make a test API request to check that your integration is working correctly:
    • Click the Cognite API collection in the left-hand menu, and select Assets > List assets.
      List assets
    • Click Send.
Cognite Data Fusion returns a list of all asset objects in response to your API request. For the Open Industrial Data Project the JSON results look similar to this:
{
    "nextCursor": "8ZiApWzGe5RnTAE1N5SABLDNv7GKkUGiVUyUjzNsDvM",
    "items": [
        {
            "name": "23-TE-96116-04",
            "parentId": 3117826349444493,
            "description": "VRD - PH 1STSTGGEAR THRUST BRG OUT",
            "metadata": {
                "ELC_STATUS_ID": "1211",
                "RES_ID": "525283",
                "SOURCE_DB": "workmate",
                "SOURCE_TABLE": "wmate_dba.wmt_tag",
                "WMT_AREA_ID": "1600",
                "WMT_CATEGORY_ID": "1116",
                "WMT_CONTRACTOR_ID": "1686",
                "WMT_FUNC_CODE_ID": "4564",
                "WMT_LOCATION_ID": "1004",
                "WMT_PO_ID": "8309",
                "WMT_SAFETYCRITICALELEMENT_ID": "1060",
                "WMT_SYSTEM_ID": "4440",
                "WMT_TAG_CREATED_DATE": "2009-06-26 15:36:37",
                "WMT_TAG_CRITICALLINE": "N",
                "WMT_TAG_DESC": "VRD - PH 1STSTGGEAR THRUST BRG OUT",
                "WMT_TAG_GLOBALID": "1000000000681024",
                "WMT_TAG_HISTORYREQUIRED": "Y",
                "WMT_TAG_ID": "346434",
                "WMT_TAG_ID_ANCESTOR": "345637",
                "WMT_TAG_ISACTIVE": "1",
                "WMT_TAG_ISOWNEDBYPROJECT": "0",
                "WMT_TAG_LOOP": "96116",
                "WMT_TAG_MAINID": "681760",
                "WMT_TAG_NAME": "23-TE-96116-04",
                "WMT_TAG_UPDATED_BY": "8137",
                "WMT_TAG_UPDATED_DATE": "2014-07-11 09:25:15"
            },
            "id": 702630644612,
            "createdTime": 0,
            "lastUpdatedTime": 0,
            "rootId": 6687602007296940
        },
...
Once you have successfully made an API request, you’re ready to begin interacting with the Cognite Data Fusion API through the Software Development Kits (SDKs).
5

Install a Software Development Kit (SDK)

We provide official Software Development Kits (SDKs) for Python and JavaScript with libraries that interact with the Cognite Data Fusion API.

​
The Python Software Development Kit (SDK)

The Cognite Python SDK requires Python 3.5+ and provides access to the Cognite Data Fusion API from applications written in the Python language. See the Cognite Python SDK Documentation for more details.
To download and install Python, visit Python.org.
To install the Cognite Python library:
pip install cognite-sdk

​
The JavaScript Software Development Kit (SDK)

The JavaScript SDK provides access to the Cognite Data Fusion API from applications written in client-side or server-side JavaScript. The library supports authentication through API keys (for server-side applications) and bearer tokens (for web applications). See the Cognite JavaScript documentation for more details.Install the Cognite JavaScript library:
npm install @cognite/sdk --save

​
Next steps

Last modified on April 23, 2026