Skip to main content
POST
/
context
/
entitymatching
/
byids
JavaScript SDK
const [result] = await client.entityMatching.retrieve([{ externalId: 'model123' }]);
retrieved_model = client.entity_matching.retrieve(id=1)
retrieved_models = client.entity_matching.retrieve_multiple([1,2,3])
curl --request POST \
  --url https://{cluster}.cognitedata.com/api/v1/projects/{project}/context/entitymatching/byids \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "items": [
    {
      "id": 2563587950655335
    },
    {
      "externalId": "myUniqueName"
    }
  ]
}
'
<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://{cluster}.cognitedata.com/api/v1/projects/{project}/context/entitymatching/byids",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'items' => [
        [
                'id' => 2563587950655335
        ],
        [
                'externalId' => 'myUniqueName'
        ]
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}
package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://{cluster}.cognitedata.com/api/v1/projects/{project}/context/entitymatching/byids"

	payload := strings.NewReader("{\n  \"items\": [\n    {\n      \"id\": 2563587950655335\n    },\n    {\n      \"externalId\": \"myUniqueName\"\n    }\n  ]\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.post("https://{cluster}.cognitedata.com/api/v1/projects/{project}/context/entitymatching/byids")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"items\": [\n    {\n      \"id\": 2563587950655335\n    },\n    {\n      \"externalId\": \"myUniqueName\"\n    }\n  ]\n}")
  .asString();
require 'uri'
require 'net/http'

url = URI("https://{cluster}.cognitedata.com/api/v1/projects/{project}/context/entitymatching/byids")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"items\": [\n    {\n      \"id\": 2563587950655335\n    },\n    {\n      \"externalId\": \"myUniqueName\"\n    }\n  ]\n}"

response = http.request(request)
puts response.read_body
{
  "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
    }
  ]
}
{
  "error": {
    "code": 401,
    "message": "Could not authenticate.",
    "missing": [
      {}
    ],
    "duplicated": [
      {}
    ]
  }
}

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 July 10, 2026