All Products
Search

This Product

    Platform For AI:GetModel

    Document Center

    Platform For AI:GetModel

    Last Updated:Oct 17, 2025

    Gets the details of a specified model.

    Try it now

    Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

    Test

    RAM authorization

    The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

    • Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.

    • API: The API that you can call to perform the action.

    • Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.

    • Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.

      • For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.

      • For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.

    • Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.

    • Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

    Action

    Access level

    Resource type

    Condition key

    Dependent action

    paimodel:GetModel

    get

    *All Resource

    *

    		 None None

    Request syntax

    GET /api/v1/models/{ModelId} HTTP/1.1

    Path Parameters

    Parameter

    Type

    Required

    Description

    Example
    ModelId

    string

    Yes

    The model ID. For more information about how to obtain a model ID, see ListModels.

    model-rbvg5****c9ks92

    Request parameters

    Parameter

    Type

    Required

    Description

    Example

    No parameters required.

    Response elements

    Element

    Type

    Description

    Example

    object

    The response body.

    RequestId

    string

    The request ID.

    5A14FA81-DD4E-******-6343FE44B941
    ModelId

    string

    The model ID.

    model-rbvg5wzljz****ks92
    ModelName

    string

    The model name.

    情感分析
    ModelDescription

    string

    The model description.

    通用情感分析。
    GmtCreateTime

    string

    The UTC time when the model was created. The time is in the ISO 8601 format.

    2021-01-30T12:51:33.028Z
    GmtModifiedTime

    string

    The UTC time when the model was last updated. The time is in the ISO 8601 format.

    2021-01-30T12:51:33.028Z
    UserId

    string

    The user ID.

    1234567890******
    OwnerId

    string

    The ID of the Alibaba Cloud account.

    1234567890******
    Origin

    string

    The source of the model. This indicates the community or organization to which the source model belongs, such as ModelScope and HuggingFace.

    ModelScope
    Provider

    string

    The provider.

    pai
    Domain

    string

    The domain. This indicates the domain of the problem that the model is designed to solve, such as natural language processing (NLP) and computer vision (CV).

    cv
    Task

    string

    The task. This indicates the specific problem that the model is designed to solve, such as text classification.

    text-classification
    ModelDoc

    string

    The model document.

    https://***.md
    Labels

    array

    The list of labels for the model.

    Label

    The label.

    WorkspaceId

    string

    The workspace ID.

    234**
    Accessibility

    string

    The visibility of the workspace. Valid values:

    • PRIVATE: The model is visible only to you and administrators in the workspace.

    • PUBLIC: The model is visible to everyone in the workspace.

    PUBLIC
    LatestVersion ModelVersion

    The latest version of the model.

    ModelType

    string

    The model type.

    Checkpoint
    ExtraInfo

    object

    Other information about the model.

    { "RatingCount": 2866, "Rating": 4.94, "FavoriteCount": 34992, "CommentCount": 754, "CoverUris": ["https://e***u.oss-cn-hangzhou.aliyuncs.com/drea***w.png"], "TippedAmountCount": 32, "DownloadCount": 606056 }
    OrderNumber

    integer

    The ordinal number.

    1
    ParameterSize

    integer

    The number of parameters, in millions.

    3000
    GmtLatestVersionModifiedTime

    string

    The time when the latest version was updated.

    2021-01-30T12:51:33.028Z

    Examples

    Success response

    JSON format

    {
  "RequestId": "5A14FA81-DD4E-******-6343FE44B941",
  "ModelId": "model-rbvg5wzljz****ks92",
  "ModelName": "情感分析",
  "ModelDescription": "通用情感分析。",
  "GmtCreateTime": "2021-01-30T12:51:33.028Z",
  "GmtModifiedTime": "2021-01-30T12:51:33.028Z",
  "UserId": "1234567890******",
  "OwnerId": "1234567890******",
  "Origin": "ModelScope",
  "Provider": "pai",
  "Domain": "cv",
  "Task": "text-classification",
  "ModelDoc": "https://***.md",
  "Labels": [
    {
      "Key": "env",
      "Value": "test"
    }
  ],
  "WorkspaceId": "234**",
  "Accessibility": "PUBLIC",
  "LatestVersion": {
    "VersionName": "0.1.0",
    "GmtCreateTime": "2021-01-21T17:12:35Z",
    "GmtModifiedTime": "2021-01-21T17:12:35Z",
    "UserId": "155770209******",
    "OwnerId": "155770209******",
    "Uri": "oss://mybucket.oss-cn-beijing.aliyuncs.com/mypath/",
    "VersionDescription": "情感分析。",
    "FormatType": "SavedModel",
    "FrameworkType": "TensorFlow",
    "Options": "{}",
    "SourceType": "PAIFlow",
    "SourceId": "region=cn-shanghai,workspaceId=13**,kind=PipelineRun,id=run-sakdb****jdf",
    "ApprovalStatus": "Approved",
    "Labels": [
      {
        "Value": "v1",
        "Key": "k1"
      }
    ],
    "Metrics": {
      "Results": [
        {
          "Dataset": {
            "DatasetId": "d-sdkjanksaklerhfd"
          },
          "Metrics": {
            "cer": 0.175
          }
        },
        {
          "Dataset": {
            "Uri": "oss://xxxx/"
          },
          "Metrics": {
            "cer": 0.172
          }
        }
      ]
    },
    "TrainingSpec": {},
    "InferenceSpec": {
      "processor": "tensorflow_gpu_1.12"
    },
    "EvaluationSpec": {},
    "CompressionSpec": {},
    "ExtraInfo": {
      "CoverUris": [
        "https://e***u.oss-cn-hangzhou.aliyuncs.com/st****017.preview.png"
      ],
      "TrainedWords": [
        "albedo_overlord"
      ]
    },
    "DistillationSpec": {}
  },
  "ModelType": "Checkpoint",
  "ExtraInfo": {
    "RatingCount": 2866,
    "Rating": 4.94,
    "FavoriteCount": 34992,
    "CommentCount": 754,
    "CoverUris": [
      "https://e***u.oss-cn-hangzhou.aliyuncs.com/drea***w.png"
    ],
    "TippedAmountCount": 32,
    "DownloadCount": 606056
  },
  "OrderNumber": 1,
  "ParameterSize": 3000,
  "GmtLatestVersionModifiedTime": "2021-01-30T12:51:33.028Z"
}

    Error codes

    See Error Codes for a complete list.

    Release notes

    See Release Notes for a complete list.