Listing Provider Templates
Function
Obtains the built-in provider template list (hw_maas and deepseek).
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-provider-templates
Request Parameters
None
Response Parameters
Status code: 200
| Parameter | Type | Description |
|---|---|---|
| templates | Array of ProviderTemplateInfo objects | Provider template list. |
| Parameter | Type | Description |
|---|---|---|
| provider_type | String | Unique template ID (provider type). |
| provider_id | String | Provider ID. |
| base_url | String | Provider base URL. |
| custom_config | ProviderCustomConfig object | Customized configuration content. |
| api_type | String | API protocol type (OpenAI/Anthropic). |
| 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. |
Status code: 400
| Parameter | Type | Description |
|---|---|---|
| error_code | String | Error code, which is returned upon failure. |
| error_msg | String | Error message. |
Status code: 401
| Parameter | Type | Description |
|---|---|---|
| error_code | String | Error code, which is returned upon failure. |
| error_msg | String | Error message. |
Status code: 403
| Parameter | Type | Description |
|---|---|---|
| error_code | String | Error code, which is returned upon failure. |
| error_msg | String | Error message. |
Status code: 500
| 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.
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.
For any further questions, feel free to contact us through the chatbot.
Chatbot