Help Center/ Workspace/ API Reference/ Workspace APIs/ Agent Instance Management/ Querying Model Groups Associated with an Agent Instance
Updated on 2026-07-24 GMT+08:00
View PDF
Share

Querying Model Groups Associated with an Agent Instance

Function

Queries all model groups associated with an agent instance based on the agent instance ID. The model groups are sorted in ascending order by priority and can be displayed on multiple pages.

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:agentInstance:list

    List

    -

    -

    -

    -

URI

GET /v3/ai-agents/instances/{instance_id}/model-groups

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

instance_id

Yes

String

Agent instance ID.
Table 2 Query Parameters

Parameter

Mandatory

Type

Description

offset

No

Integer

Offset, which starts from 0.

limit

No

Integer

Number of records on each page.

Request Parameters

None

Response Parameters

Status code: 200

Table 3 Response body parameters

Parameter

Type

Description

total

Integer

Total quantity.

items

Array of InstanceModelGroupItem objects

Model group list, which is sorted by priority in ascending order.
Table 4 InstanceModelGroupItem

Parameter

Type

Description

group_id

String

Model group ID.

group_name

String

Model group name.

default_model_id

String

Default model ID in the group. If this parameter is not set, the value is empty.

priority

Integer

Group priority. A smaller value indicates a higher priority.

update_time

String

Model group update time.

providers

Array of InstanceModelProviderConfig objects

Provider configuration list (excluding the API key).
Table 5 InstanceModelProviderConfig

Parameter

Type

Description

id

String

Primary key ID in the provider configuration.

provider_id

String

Provider ID.

name

String

Provider name.

provider_type

String

Provider type.

update_time

String

Provider update time.

api_base_url

String

Provider API address.

custom_config

ProviderCustomConfig object

Extended provider configuration.

models

Array of ModelInfo objects

Model list.
Table 6 ProviderCustomConfig

Parameter

Type

Description

model_list_api

String

Address of the model list API, which is used to query the provider's remote models.

auth_header

String

Name of the authentication request header.

auth_prefix

String

Authentication prefix (for example, Bearer).

model_id_field

String

Field name of the model ID in the provider model list.

model_name_field

String

Field name of the model name in the provider model list.

headers

Map<String,String>

Customized HTTP request header, which is added when the provider API is called.
Table 7 ModelInfo

Parameter

Type

Description

id

String

Model ID (service primary key).

name

String

Model name.

provider_model_id

String

Model ID on the provider side.

input

Array of strings

Input type array.

reasoning

Boolean

Whether inference is supported.

update_time

String

Time when a model is updated.

context_window

Integer

Context window.

max_tokens

Integer

Maximum number of output tokens.

type

String

Management type. The value can be BACKEND_MANAGE (managed by the backend) or CUSTOM. The value for models delivered by the service is BACKEND_MANAGE.

Status code: 400

Table 8 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 9 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 10 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 11 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

Invalid request parameters.

401

Authorization failed.

403

No permissions.

500

Internal server error.

Error Codes

See Error Codes.