Obtaining Details About a Model

Obtains model details.

You can debug this API through automatic authentication in API Explorer or use the SDK sample code generated by API Explorer.

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

Read

-

-

-

-

Action	Access Level	Resource Type (*: required)	Condition Key	Alias	Dependencies
workspace:modelProvider:getModel	Read	-	-	-	-

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

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
provider_id	Yes	String	Provider ID.
model_id	Yes	String	Model ID.

None

Status code: 200

**Table 2** Response body parameters
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.
groups	Array of AttachModelGroupInfo objects	Model group associated with the default model.

**Table 3** 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 4** ModelCompat
Parameter	Type	Description
supports_usage_streaming	Boolean	Whether usage streaming transmission is supported.
supports_developer_role	Boolean	Whether the developer role is supported.

**Table 5** AttachModelGroupInfo
Parameter	Type	Description
id	String	Group ID.
name	String	Group name.

Status code: 400

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

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

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

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

None

None

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.

Parent topic: Model Management

Thank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.

The system is busy. Please try again later.

For any further questions, feel free to contact us through the chatbot.