Skip to main content
POST
/
context
/
entitymatching
/
byids
JavaScript SDK
const [result] = await client.entityMatching.retrieve([{ externalId: 'model123' }]);
{
  "items": [
    {
      "id": 4503599627370496,
      "externalId": "my.known.id",
      "createdTime": 1730204346000,
      "startTime": 1730204346000,
      "statusTime": 1730204346000,
      "name": "simple_model_1",
      "description": "Simple model 1",
      "errorMessage": null,
      "featureType": "simple",
      "matchFields": [
        {
          "source": "name",
          "target": "name"
        },
        {
          "source": "name",
          "target": "someField"
        }
      ],
      "ignoreMissingFields": true,
      "classifier": "randomforest",
      "originalId": 111
    }
  ]
}

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.

Authorizations

​
Authorization
string
header
required

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.

Body

application/json
​
items
object[]
required

List of ids or externalIds of models.

Required array length: 1 - 1000 elements
Example:
[
  { "id": 2563587950655335 },
  { "externalId": "myUniqueName" }
]

Response

Success

​
items
object[]
required
Last modified on June 2, 2026