> ## 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.

> ## Agent Instructions
> Cognite Data Fusion (CDF) is an industrial DataOps platform. Prefer English docs unless the user asks for another locale.
> Follow /_llms/ index links recursively until you reach page URLs ending in .md. Fetch those Markdown twins instead of HTML.
> For REST APIs, default to calendar version 20230101 (stable). Use 20230101-beta or 20230101-alpha only if the user is on a preview API. Cite paths under /api-reference/concepts/<version>/ and the Cdf-Version header. Prefer the Python SDK (cognite-sdk) unless the user is in JavaScript/TypeScript.
> Start here by task: platform overview /cdf/index.md; data modeling /cdf/dm/index.md; data integration /cdf/integration/index.md; access /cdf/access/index.md; CDF Toolkit /cdf/deploy/cdf_toolkit/index.md; REST quickstart /dev/quickstart.md; Python SDK https://cognite-sdk-python.readthedocs-hosted.com/en/stable/; Atlas AI /cdf/atlas_ai/concepts/index.md; Flows apps /cdf/flows/index.md; MCP and IDE setup /dev/guides/ide_ai_integration.md.
> For implementation work, also load /skill.md.

# Retrieve an entity matching model by the ID of the model

> 

> **Required capabilities:** `entitymatchingAcl:READ`

Shows the status of the model. If the status is completed, shows the parameters used to train the model.



## OpenAPI

````yaml https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-alpha.json get /context/entitymatching/{id}
openapi: 3.1.0
info:
  title: Cognite API
  description: >-
    Reference documentation for the Cognite Data Fusion (CDF) API. See the [API
    introduction](/api-reference/concepts/20230101/api-description) and [API
    changelog](/api-reference/changelog).
  version: v1
  contact:
    name: Cognite Support
    url: https://support.cognite.com
    email: support@cognite.com
servers:
  - url: https://{cluster}.cognitedata.com/api/v1/projects/{project}
    description: The URL for the CDF cluster to connect to
    variables:
      cluster:
        enum:
          - api
          - az-tyo-gp-001
          - az-eastus-1
          - az-power-no-northeurope
          - westeurope-1
          - asia-northeast1-1
          - gc-dsm-gp-001
        default: api
        description: The CDF cluster to connect to
      project:
        default: publicdata
        description: The CDF project name.
security:
  - oidc-token:
      - https://{cluster}.cognitedata.com/.default
  - oauth2-client-credentials:
      - https://{cluster}.cognitedata.com/.default
  - oauth2-open-industrial-data:
      - https://api.cognitedata.com/.default
  - oauth2-auth-code:
      - https://{cluster}.cognitedata.com/.default
tags:
  - name: Token
  - name: Advanced joins
  - name: Assets
  - name: Data Modeling
    x-uri-format-fragments:
      - resource: Space
        uri-fragment: models/{space}
      - resource: Data Model
        uri-fragment: models/{space}/datamodel/{externalId}/{version}
      - resource: View
        uri-fragment: models/{space}/view/{externalId}/{version}
      - resource: Container
        uri-fragment: models/{space}/container/{externalId}
      - resource: Node
        uri-fragment: models/{space}/node/{externalId}
      - resource: Edge
        uri-fragment: models/{space}/edge/{externalId}
  - name: Streams
  - name: Records
  - name: Events
  - name: Files
  - name: Functions
  - name: Function calls
  - name: Function schedules
  - name: Function Apps
  - name: Function App Calls
  - name: Function App MCP
  - name: 3D
  - name: Time series
  - name: Data point subscriptions
  - name: Synthetic Time Series
  - name: Raw
    x-uri-format-fragments:
      - resource: Database
        uri-fragment: raw/{dbName}
      - resource: Table
        uri-fragment: raw/{dbName}/{tableName}
  - name: Groups
  - name: Projects
  - name: Security categories
  - name: Data sets
  - name: Limits
  - name: Metering
  - name: Sequences
  - name: Labels
  - name: Relationships
  - name: Entity matching
  - name: Entity matching pipelines
  - name: Diagram parsing
  - name: Vision
  - name: Agents
  - name: Skills
  - name: Project Configuration
  - name: Models
  - name: Chat Completions
  - name: Cognite AI
  - name: Documents
  - name: Document preview
    x-displayName: Preview
  - name: Geospatial
  - name: SessionsInternal
  - name: Sessions
  - name: Extraction Pipelines
  - name: Extraction Pipelines Runs
  - name: Extraction Pipelines Config
  - name: Extractors
  - name: Transformations
  - name: Transformation Jobs
  - name: Transformation Schedules
  - name: Transformation Notifications
  - name: Query
  - name: Schema
  - name: Transformation External Data Sources
  - name: Annotations
  - name: User profiles
  - name: Workflows
  - name: Workflow versions
  - name: Workflow executions
  - name: Tasks
  - name: Workflow triggers
  - name: Sources
  - name: Jobs
  - name: Destinations
  - name: Mappings
  - name: Previews
  - name: Postgres Gateway Users
  - name: Postgres Gateway Tables
  - name: SAP Instances
  - name: SAP Endpoints
  - name: Schema Mappings
  - name: Writeback Requests
  - name: Simulators
  - name: Simulator Integrations
  - name: Simulator Routines
  - name: Simulator Models
  - name: Simulation Runs
  - name: Simulator Logs
  - name: Units
  - name: Unit Systems
  - name: Application Data Storage
  - name: Location Filters
  - name: User Preferences
  - name: User History
  - name: Search Config
  - name: Organizations
  - name: Applications
  - name: Integrations
  - name: Integration Tasks
  - name: Integration Actions
  - name: Integration Configuration
  - name: Integration Errors
  - name: Principals
  - name: Signals
  - name: Data products
paths:
  /context/entitymatching/{id}:
    get:
      tags:
        - Entity matching
      summary: Retrieve an entity matching model by the ID of the model
      description: >-


        > **Required capabilities:** `entitymatchingAcl:READ`


        Shows the status of the model. If the status is completed, shows the
        parameters used to train the model.
      operationId: entityMatchingStatus
      parameters:
        - $ref: '#/components/parameters/CogniteInternalId'
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                required:
                  - classifier
                  - featureType
                allOf:
                  - $ref: '#/components/schemas/EntityMatcherResponseSchema'
        '400':
          $ref: '#/components/responses/ErrorResponse'
components:
  parameters:
    CogniteInternalId:
      in: path
      name: id
      required: true
      schema:
        $ref: '#/components/schemas/CogniteInternalId'
  schemas:
    EntityMatcherResponseSchema:
      type: object
      required:
        - id
        - externalId
        - name
        - description
      allOf:
        - properties:
            id:
              $ref: '#/components/schemas/CogniteInternalId'
            externalId:
              $ref: '#/components/schemas/CogniteExternalId'
        - $ref: '#/components/schemas/StatusSchema'
        - $ref: '#/components/schemas/EntityMatchingFeatureSchema'
    CogniteInternalId:
      description: A server-generated ID for the object.
      type: integer
      minimum: 1
      maximum: 9007199254740991
      format: int64
    CogniteExternalId:
      description: >-
        The external ID provided by the client. Must be unique for the resource
        type.
      type: string
      maxLength: 255
      example: my.known.id
    StatusSchema:
      type: object
      required:
        - status
        - createdTime
        - startTime
        - statusTime
      properties:
        status:
          $ref: '#/components/schemas/JobStatus'
        createdTime:
          $ref: '#/components/schemas/EpochTimestamp'
        startTime:
          $ref: '#/components/schemas/EpochTimestamp'
        statusTime:
          $ref: '#/components/schemas/EpochTimestamp'
        errorMessage:
          type: string
          description: If the job failed, some more information about the error cause.
          example: null
          default: null
    EntityMatchingFeatureSchema:
      type: object
      properties:
        name:
          $ref: '#/components/schemas/ModelName'
        description:
          $ref: '#/components/schemas/ModelDescription'
        featureType:
          $ref: '#/components/schemas/FeatureType'
        matchFields:
          $ref: '#/components/schemas/MatchFields'
        ignoreMissingFields:
          description: >-
            If True, missing fields in `sources` or `targets` entities set in
            `matchFields`, are replaced with empty strings.
          allOf:
            - $ref: '#/components/schemas/IgnoreMissingFields'
        classifier:
          description: >-
            Name of the classifier used in the model, "Unsupervised" if
            unsupervised model.
          allOf:
            - $ref: '#/components/schemas/Classifier'
        originalId:
          type: integer
          description: >-
            The ID of original model, only relevant when the model is a
            retrained model.
          example: 111
    Error:
      type: object
      required:
        - code
        - message
      description: Cognite API error.
      properties:
        code:
          type: integer
          description: HTTP status code.
          format: int32
          example: 401
        message:
          type: string
          description: Error message.
          example: Could not authenticate.
        missing:
          type: array
          description: List of lookup objects that do not match any results.
          items:
            type: object
            additionalProperties: true
        duplicated:
          type: array
          description: List of objects that are not unique.
          items:
            type: object
            additionalProperties: true
    JobStatus:
      description: The status of the job.
      type: string
      enum:
        - Queued
        - Running
        - Completed
        - Failed
    EpochTimestamp:
      description: >-
        The number of milliseconds since 00:00:00 Thursday, 1 January 1970,
        Coordinated Universal Time (UTC), minus leap seconds.
      type: integer
      minimum: 0
      format: int64
      example: 1730204346000
    ModelName:
      type: string
      description: User defined name.
      example: simple_model_1
      maxLength: 256
    ModelDescription:
      type: string
      description: User defined description.
      example: Simple model 1
      maxLength: 500
    FeatureType:
      type: string
      example: simple
      enum:
        - simple
        - insensitive
        - bigram
        - frequencyweightedbigram
        - bigramextratokenizers
        - bigramcombo
      default: simple
      description: >-
        Each feature type defines the combination of features that will be
        created and used in the entity matcher model.
    MatchFields:
      type: array
      example:
        - source: name
          target: name
        - source: name
          target: someField
      default:
        - source: name
          target: name
      description: >-
        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 specified here.
      items:
        type: object
        required:
          - source
          - target
        properties:
          source:
            type: string
          target:
            type: string
    IgnoreMissingFields:
      type: boolean
      default: false
      example: true
      description: >-
        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 missing data.
    Classifier:
      type: string
      description: >-
        The classifier used in the model. Only relevant if there are
        trueMatches/labeled data and a supervised model is fitted.
      example: randomforest
      default: randomforest
      enum:
        - randomforest
        - decisiontree
        - logisticregression
        - augmentedlogisticregression
        - augmentedrandomforest
  responses:
    ErrorResponse:
      description: The response for a failed request.
      content:
        application/json:
          schema:
            type: object
            required:
              - error
            properties:
              error:
                $ref: '#/components/schemas/Error'
  securitySchemes:
    oidc-token:
      type: http
      scheme: bearer
      bearerFormat: OpenID Connect or OAuth2 token
      description: >-
        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.
    oauth2-client-credentials:
      type: oauth2
      description: >-
        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.
      flows:
        clientCredentials:
          tokenUrl: https://your-idps.token.url/
          scopes:
            default: https://{cluster}.cognitedata.com/.default
    oauth2-open-industrial-data:
      type: oauth2
      description: >-
        Auth flow for Open Industrial Data. Get your client secret from
        https://hub.cognite.com/open-industrial-data-211.
      flows:
        clientCredentials:
          tokenUrl: >-
            https://login.microsoftonline.com/48d5043c-cf70-4c49-881c-c638f5796997/oauth2/v2.0/token
          scopes:
            default: https://api.cognitedata.com/.default
    oauth2-auth-code:
      type: oauth2
      description: >-
        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.
      flows:
        authorizationCode:
          authorizationUrl: https://your-idps.authorization.url/
          tokenUrl: https://your-idps.token.url/
          scopes:
            default: https://{cluster}.cognitedata.com/.default

````