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

Listing Provider Configurations

Function

Lists suppliers. Pagination and multi-dimensional filtering are 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:list

    List

    -

    -

    -

    -

URI

GET /v3/ai-agents/model-providers

Table 1 Query Parameters

Parameter

Mandatory

Type

Description

limit

No

Integer

Number of records on each page. The default value is 10, and the maximum value is 100.

offset

No

Integer

Offset. The default value is 0.

group_id

No

String

Filter by group (association query).

status

No

String

Filter by status. The value can be connected, disconnected, or unverified.

provider_type

No

String

Filter by provider type.

name

No

String

Fuzzy search by name.

Request Parameters

None

Response Parameters

Status code: 200

Table 2 Response body parameters

Parameter

Type

Description

total

Integer

Total quantity.

items

Array of ProviderInfoVO objects

Provider configuration list item.
Table 3 ProviderInfoVO

Parameter

Type

Description

id

String

Provider ID.

provider_name

String

Provider name.

provider_type

String

Provider type.

provider_id

String

Provider ID.

base_url

String

Provider base URL.

connection_status

String

Connection status. The value can be connected, disconnected, or unverified.

model_count

Integer

Number of subordinate models.

group_count

Integer

Number of associated model groups.

last_verify_time

String

Last verification time.

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).

is_builtin

Boolean

Whether the provider is a built-in provider.

api_type

String

API protocol type (OpenAI/Anthropic).

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 Providers