How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
Cognite

Cognite Entity matching API

The entity matching contextualization endpoints lets you match CDF resources. For example, you can match time series to assets. The model uses similarity between string-fields from the source and the target to find potential matches, for instance the source name and the target name. The exact algorithm may change over time.

Documentation Provider Profile APIs.io OpenAPI GitHub

Cognite Entity matching API is one of 90 APIs that Cognite publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Entity Matching. The published artifact set on APIs.io includes an OpenAPI specification.

This API exposes 10 operations across 9 paths, and defines 37 schemas. It is described by OpenAPI 3.2.0, at version v1.

Requests are made against a single base URL, https://{cluster}.cognitedata.com/api/v1/projects/{project}.

10 operations 9 paths 37 schemas 3 GET7 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
v1
Base URL
https://api.cognitedata.com
Authentication
HTTP Bearer, OAuth 2.0, OAuth 2.0, OAuth 2.0, OpenID Connect
Contact
Cognite Support
Resource Areas
1

Authentication & Security 5

Cognite Entity matching API declares 5 security schemes for authenticating requests. It accepts HTTP bearer tokens (OpenID Connect or OAuth2 token) (oidc-token). It supports OAuth 2.0 (oauth2-client-credentials) using the clientCredentials flow, exposing 1 scope. It supports OAuth 2.0 (oauth2-auth-code) using the authorizationCode flow, exposing 1 scope. It supports OAuth 2.0 (oauth2-open-industrial-data) using the clientCredentials flow, exposing 1 scope. It supports OpenID Connect (org-oidc-token) discovered at https://auth.cognite.com/.well-known/openid-configuration. By default, every request must be authenticated.

  • oidc-token — 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 acce…
  • oauth2-client-credentials — 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 acce…
  • oauth2-auth-code — 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 acce…
  • oauth2-open-industrial-data — Auth flow for Open Industrial Data. Get your client secret from https://hub.cognite.com/open-industrial-data-211.
  • org-oidc-token — Access token issued by the Cognite authorization server, and valid for the target organization. The token must be an OpenID Connect token, and it can be obtain…

Paths & Operations 10

Across 9 paths, the API surfaces 10 operations — 3 GET, 7 POST. Each is listed below with its method, path, parameters, and response codes.

Entity matching 10

The entity matching contextualization endpoints lets you match CDF resources. For example, you can match time series to assets. The model uses similarity between string-fields fro…

GET
/context/entitymatching
List entity matching models
entityMatchingModels 2 params → 200400
POST
/context/entitymatching
Create entity matcher model
entityMatchingCreate body → 200400
GET
/context/entitymatching/{id}
Retrieve an entity matching model by the ID of the model
entityMatchingStatus 1 param → 200400
POST
/context/entitymatching/byids
Retrieve entity matching models
entityMatchingRetrieve body → 200400
POST
/context/entitymatching/list
Filter models
entityMatchingFilter body → 200400
POST
/context/entitymatching/update
Update entity matching models
entityMatchingUpdate body → 200400
POST
/context/entitymatching/delete
Delete entity matcher model
entityMatchingDelete body → 200400
POST
/context/entitymatching/predict
Predict matches
entityMatchingPredict body → 200400
GET
/context/entitymatching/jobs/{jobId}
Retrieve entity matcher predict results
entityMatchingPredictResults 2 params → 200400
POST
/context/entitymatching/refit
Re-fit entity matcher model
entityMatchingReFit body → 200400

Schemas 37

The contract defines 37 schemas that model the data the API accepts and returns. The most detailed are EntityMatchingFeatureSchema (7 properties), EntityMatchingFilterSchema (5 properties), StatusSchema (5 properties), EntityMatchingRefitFeatureSchema (4 properties). Each schema is shown below with its type and property counts.

MatchFields
array
List of pairs of fields from the target and source items, used to calculate features. All source and target items should have all the source and target fields…
Sources
array
List of custom source object to match from, for example, time series. String key - value. Only string values are considered in the matching. Both id and extern…
SourceId
The id for the from-object of the match.
Match
object
A pair of source ID and target ID, that indicates a match between two entities in the source and target spaces. Internal and external IDs are supported.
EpochTimestamp
integer
The number of milliseconds since 00:00:00 Thursday, 1 January 1970, Coordinated Universal Time (UTC), minus leap seconds.
TrueMatches
array
A list of confirmed source/target matches, which will be used to train the model. If omitted, an unsupervised model is trained.
EntityMatchingFeatureSchema
object
7 properties
IgnoreMissingFields
boolean
If True, replaces missing fields in sources or targets entities, for fields set in set in matchFields, with empty strings. Else, returns an error if there are…
ModelName
string
User defined name.
JobId
integer
Contextualization job ID.
CogniteInternalId
integer
A server-generated ID for the object.
EntityMatcherResponseSchema
object
4 required
Targets
array
List of custom target object to match to, for example, assets. String key - value. Only string values are considered in the matching. Both id and externalId fi…
FeatureType
string
Each feature type defines the combination of features that will be created and used in the entity matcher model.
SinglePatchRequiredModelDescription
object
Set a new value for description.
1 property 1 required
NextCursorV3
string
The cursor value used to return (paginate to) the next page of results, when more data is available.
EntityMatchingRefitSchema
object
TargetExternalId
The external id for the to-object of the match.
EntityMatchingPredictFeatureSchema
object
4 properties
JobToken
string
A string token that can be attached to the header of a request fetching the job status. Authenticates the user fetching the job status as the same one who orig…
StatusSchema
object
5 properties 4 required
CogniteExternalId
string
The external ID provided by the client. Must be unique for the resource type.
Classifier
string
The classifier used in the model. Only relevant if there are trueMatches/labeled data and a supervised model is fitted.
TargetId
The id for the target-object of the match.
SourceExternalId
The external id for the source-object of the match.
SinglePatchRequiredModelName
object
Set a new value for name.
1 property 1 required
OneOfId
array
List of ids or externalIds of models.
JobStatus
string
The status of the job.
Error
object
Cognite API error.
4 properties 2 required
ModelDescription
string
User defined description.
ModelChange
EntityMatchingFilterSchema
object
5 properties
EntityMatchingPredictSchema
object
EntityMatchingRefitFeatureSchema
object
4 properties 1 required
ModelPatch
object
Changes applied to model
1 property 1 required
ModelChangeById
ModelChangeByExternalId

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

cognite-entity-matching-api-openapi.yml Raw ↑

Other APIs Cognite publishes across the network.

Cognite Data Fusion API
AE Profile APIs.io
Cognite 3D Asset Mapping API
AE Profile APIs.io
Cognite 3D Files API
AE Profile APIs.io
Cognite 3D Jobs API
AE Profile APIs.io
Cognite 3D Model Revisions API
AE Profile APIs.io
Cognite 3D Models API
AE Profile APIs.io
Cognite Annotations API
AE Profile APIs.io
Cognite Assets API
AE Profile APIs.io
Cognite Connections API
AE Profile APIs.io
Cognite Containers API
AE Profile APIs.io
Cognite Data models API
AE Profile APIs.io
Cognite Data point subscriptions API
AE Profile APIs.io
#Entity Matching
← Back to C APIs
API Details
ID
cognite:cognite-entity-matching-api
Base URL
https://api.cognitedata.com
Docs
https://api-docs.cognite.com/
Provider
Cognite
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network
Work with this as data

Every API here is available over the API and to AI agents over MCP. APIs is not yet its own endpoint on the v1 API. Reach this content through network search and the tag graph, or the MCP server below.

Installs https://mcp.apievangelist.com/mcp in Claude, Cursor, VS Code and the rest — one button, every client.

MCP tools for apis
4 tools reach this content
  • search_api_evangelistSearch every content type across the network at once.
  • find_relatedThe shared-tag relevance graph — what else covers this.
  • get_tagEverything one tag labels, across all content types.
  • guide_topicPRO — a curated bundle for a topic: area, guidance, rules, papers, stories, services.
All tools & prompts
Call it yourself
curl for this page
Search the network for this 
curl "https://api.apievangelist.com/v1/search?q=cognite-entity-matching-api&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/cognite-entity-matching-api"

Discovery needs no key. Full bodies and the synthesis endpoints are Pro.

Get an API key

Free tier, no email required. Sign in with whichever identity you already have.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have. Your account

Where this information came from

This is an independent, third-party profile of Cognite Entity matching API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.