---
title: "Get Custom Model"
method: GET
path: "/custom/models/{modelId}"
---

# Get Custom Model

`GET /custom/models/{modelId}`

Get detailed information about a custom model.

## Path parameters

- `modelId` string, uuid, required

## Query parameters

- `includeKeys` boolean

## Response `200`

Success

- Model — Response to the get custom model operation.
  - `modelInfo` ModelInfo, required — Basic custom model information.
    - `modelId` string, uuid, required — Model identifier.
    - `status` 'creating' | 'ready' | 'invalid', required — Status of the model.
    - `createdDateTime` string, date-time, required — Date and time (UTC) when the model was created.
    - `lastUpdatedDateTime` string, date-time, required — Date and time (UTC) when the status was last updated.
  - `keys` KeysResult — Keys extracted by the custom model.
    - `clusters` object, required — Object mapping clusterIds to a list of keys.
  - `trainResult` TrainResult — Custom model training result.
    - `trainingDocuments` TrainingDocumentInfo[], required — List of the documents used to train the model and any errors reported in each document.
      - `documentName` string, required — Training document name.
      - `pages` integer, required — Total number of pages trained.
      - `errors` ErrorInformation[], required — List of errors.
        - `code` string, required
        - `message` string, required
      - `status` 'succeeded' | 'partiallySucceeded' | 'failed', required — Status of the training operation.
    - `fields` FormFieldsReport[] — List of fields used to train the model and the train operation error reported by each.
      - `fieldName` string, required — Training field name.
      - `accuracy` number, required — Estimated extraction accuracy for this field.
    - `averageModelAccuracy` number — Average accuracy.
    - `errors` ErrorInformation[] — Errors returned during the training operation.
      - `code` string, required
      - `message` string, required

## Other responses

- `default` — Response entity accompanying non-successful responses containing additional details about the error.

---

[API](https://skmtc.dev/azure/apis/form-recognizer-client.md) · [All operations](https://skmtc.dev/azure/apis/form-recognizer-client/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/azure/form-recognizer-client/revisions/f77e48809807/schema)