Help Center/ Workspace/ API Reference/ Workspace APIs/ Model Groups/ Querying Details About a Model Group
Updated on 2026-07-24 GMT+08:00
View PDF
Share

Querying Details About a Model Group

Function

Queries details about a model group, including the simplified information about the associated provider.

Debugging

You can debug this API through automatic authentication in API Explorer or use the SDK sample code generated by API Explorer.

Authorization Information

Each account has all the permissions required to call all APIs, but IAM users must be assigned the required permissions.

  • If you are using role/policy-based authorization, see Permissions Policies and Supported Actions for details on the required permissions.
  • If you are using identity policy-based authorization, the following identity policy-based permissions are required.

    Action

    Access Level

    Resource Type (*: required)

    Condition Key

    Alias

    Dependencies

    workspace:modelGroup:get

    Read

    -

    -

    -

    -

URI

GET /v3/ai-agents/model-groups/{group_id}

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

group_id

Yes

String

Model group ID.

Request Parameters

None

Response Parameters

Status code: 200

Table 2 Response body parameters

Parameter

Type

Description

id

String

Group ID.

name

String

Group name.

description

String

Group description.

priority

Integer

Group priority.

default_model_id

String

Default model ID.

providers

Array of ModelGroupProviderSimpleResp objects

List of simplified information (only IDs and names) about associated providers.

create_time

String

Creation time (in ISO 8601 format and UTC time zone).

update_time

String

Update time (in ISO 8601 format and UTC time zone).
Table 3 ModelGroupProviderSimpleResp

Parameter

Type

Description

id

String

Provider ID.

provider_name

String

Provider name.

Status code: 400

Table 4 Response body parameters

Parameter

Type

Description

error_code

String

Error code, which is returned upon failure.

error_msg

String

Error message.

Status code: 401

Table 5 Response body parameters

Parameter

Type

Description

error_code

String

Error code, which is returned upon failure.

error_msg

String

Error message.

Status code: 403

Table 6 Response body parameters

Parameter

Type

Description

error_code

String

Error code, which is returned upon failure.

error_msg

String

Error message.

Status code: 404

Table 7 Response body parameters

Parameter

Type

Description

error_code

String

Error code, which is returned upon failure.

error_msg

String

Error message.

Status code: 500

Table 8 Response body parameters

Parameter

Type

Description

error_code

String

Error code, which is returned upon failure.

error_msg

String

Error message.

Example Requests

None

Example Responses

None

Status Codes

Status Code

Description

200

Operation successful.

400

The request cannot be understood by the server due to malformed syntax.

401

Authorization failed.

403

No permissions.

404

Resource not found.

500

Internal server error.

Error Codes

See Error Codes.

Parent topic: Model Groups