Help Center/ Workspace/ API Reference/ Workspace APIs/ Model Management/ Listing Models
Updated on 2026-07-24 GMT+08:00
View PDF
Share

Listing Models

Function

Obtains the model list of a specified vendor. Pagination is supported.

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:modelProvider:listModel

    List

    -

    -

    -

    -

URI

GET /v3/ai-agents/model-providers/{provider_id}/models

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

provider_id

Yes

String

Provider ID.
Table 2 Query Parameters

Parameter

Mandatory

Type

Description

limit

No

Integer

Number of records on each page. The default value is 10.

offset

No

Integer

Offset. The default value is 0.

group_id

No

String

Group ID for filtering.

name

No

String

Fuzzy search by name.

Request Parameters

None

Response Parameters

Status code: 200

Table 3 Response body parameters

Parameter

Type

Description

total

Integer

Total quantity.

items

Array of ModelInfoForListResp objects

Model list item.
Table 4 ModelInfoForListResp

Parameter

Type

Description

id

String

Model ID.

name

String

Model name.

input

Array of strings

Input type array.

context_window

Integer

Maximum context window.

max_tokens

Integer

Maximum number of output tokens.

reasoning

Boolean

Whether inference is supported.

cost

ModelCost object

Fee information.

compat

ModelCompat object

Compatibility configuration.

is_builtin

Boolean

Whether the model is a built-in model.

provider_model_id

String

Model ID on the provider side.

provider_id

String

Provider ID.

provider_name

String

Provider name.

description

String

Model description.

priority

Integer

Intra-group sorting priority.

create_time

String

Creation time.

update_time

String

Update time.

group_count

Long

Number of model groups associated with the default model.
Table 5 ModelCost

Parameter

Type

Description

input

Double

Fee per million input tokens.

output

Double

Fee per million output tokens.

cache_read

Double

Cache reading fee per million tokens.

cache_write

Double

Cache writing fee per million tokens.
Table 6 ModelCompat

Parameter

Type

Description

supports_usage_streaming

Boolean

Whether usage streaming transmission is supported.

supports_developer_role

Boolean

Whether the developer role is supported.

Status code: 400

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: 401

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: 403

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: 500

Table 10 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.

500

Internal server error.

Error Codes

See Error Codes.

Parent topic: Model Management