GetModel
Queries the detailed configuration and region of a model in a specified workspace.
Operation description
Queries the detailed configuration and region of a model in a specified workspace.
Try it now
Test
RAM authorization
|
Action |
Access level |
Resource type |
Condition key |
Dependent action |
|
agentcore:GetModel |
get |
*Model
|
None | None |
Request syntax
GET /workspaces/{workspaceId}/models/{modelId} HTTP/1.1
Path Parameters
|
Parameter |
Type |
Required |
Description |
Example |
| workspaceId |
string |
Yes |
The workspace ID. |
ws-1 |
| modelId |
string |
Yes |
The model ID. |
model-1 |
Request parameters
|
Parameter |
Type |
Required |
Description |
Example |
No parameters required.
Response elements
|
Element |
Type |
Description |
Example |
|
object |
The text response returned by the model upon successful testing, or empty if testing fails. |
||
| requestId |
string |
The request ID. |
request-1 |
| message |
string |
The message about the request processing result. |
success |
| httpStatusCode |
integer |
The HTTP status code. A value of 200 indicates success. |
200 |
| code |
string |
The business status code. A value of SUCCESS indicates success. |
SUCCESS |
| success |
boolean |
Indicates whether the request is successful. |
|
| data |
object |
The detailed information about the model. |
|
| modelId |
string |
The model ID. |
model-1 |
| workspaceId |
string |
The workspace ID. |
ws-1 |
| connectionId |
string |
The model connection ID. |
mc-1 |
| modelName |
string |
The upstream model name. |
qwen-max |
| description |
string |
The model description, which can be up to 255 characters in length. |
description |
| contextSize |
integer |
The context window size of the model, in tokens. The value must be a positive integer. |
128000 |
| maxTokens |
integer |
The maximum number of output tokens supported by the model in a single generation. |
131072 |
| capabilities |
object |
The capability configurations of the model. |
|
| toolCall |
boolean |
Indicates whether the model supports tool calling. |
|
| multiToolCall |
boolean |
Specifies whether the model is able to invoke multiple tool calling operations in a single response. |
|
| streamToolCall |
boolean |
Indicates whether the model supports streaming tool calling. |
|
| vision |
boolean |
Indicates whether the model supports image input. |
|
| audio |
boolean |
Indicates whether the model supports audio input or output. |
|
| video |
boolean |
Indicates whether the model supports video input. |
|
| document |
boolean |
Indicates whether the model supports document input. |
|
| reasoning |
boolean |
Indicates whether the model supports reasoning capabilities. |
|
| createdAt |
string |
The time when the resource was created, in RFC 3339 UTC format. |
2026-08-09T00:00:00Z |
| updatedAt |
string |
The time when the resource was last updated, in RFC 3339 UTC format. |
2026-08-09T00:00:00Z |
| regionId |
string |
The ID of the region to which the resource belongs. |
cn-hangzhou |
Examples
Success response
JSON format
{
"requestId": "request-1",
"message": "success",
"httpStatusCode": 200,
"code": "SUCCESS",
"success": false,
"data": {
"modelId": "model-1",
"workspaceId": "ws-1",
"connectionId": "mc-1",
"modelName": "qwen-max",
"description": "description",
"contextSize": 128000,
"maxTokens": 131072,
"capabilities": {
"toolCall": false,
"multiToolCall": false,
"streamToolCall": false,
"vision": false,
"audio": false,
"video": false,
"document": false,
"reasoning": false
},
"createdAt": "2026-08-09T00:00:00Z",
"updatedAt": "2026-08-09T00:00:00Z",
"regionId": "cn-hangzhou"
}
}
Error codes
|
HTTP status code |
Error code |
Error message |
Description |
|---|---|---|---|
| 400 | InvalidParameter | A model parameter is invalid. | |
| 404 | Resource.NotFound | The specified AgentCore workspace does not exist. |
See Error Codes for a complete list.
Release notes
See Release Notes for a complete list.