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

Querying Details About a Provider

Function

Obtains the details about a provider, including the associated group list and subordinate model list.

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

    Read

    -

    -

    -

    -

URI

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

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

provider_id

Yes

String

Provider ID.

Request Parameters

None

Response Parameters

Status code: 200

Table 2 Response body parameters

Parameter

Type

Description

id

String

Provider ID.

provider_type

String

Provider type.

provider_id

String

Provider ID.

provider_name

String

Provider name.

base_url

String

Provider base URL.

connection_status

String

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

is_builtin

Boolean

Whether the provider is a built-in provider.

last_verify_time

String

Last verification time (in ISO 8601 format and UTC time zone).

custom_config

Object

Customized provider configuration.

groups

Array of AttachModelGroupInfo objects

List of associated groups.

models

Array of ModelItemResp objects

List of subordinate models.

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

api_type

String

API protocol type (OpenAI/Anthropic).
Table 3 AttachModelGroupInfo

Parameter

Type

Description

id

String

Group ID.

name

String

Group name.
Table 4 ModelItemResp

Parameter

Type

Description

id

String

Model ID.

name

String

Model name.

provider_model_id

String

Model ID on the provider side.

input

Array of strings

Input type array.

description

String

Model description.

is_builtin

Boolean

Whether the model is a built-in model.

Status code: 400

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

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

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

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

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.

404

Resource not found.

405

The request method is not allowed.

500

Internal server error.

Error Codes

See Error Codes.

Parent topic: Model Providers