Retrieve the details of a specified Agent by ID.
GET /api/v1/cloud/agents/{agent_id}
Returns the details of the specified Agent.
Request headers
|
Header |
Required |
Description |
|
|
Yes |
|
Path parameters
|
Parameter |
Type |
Required |
Description |
|
|
string |
Yes |
Agent unique identifier, prefixed with |
Query parameters
|
Parameter |
Type |
Required |
Description |
|
|
integer |
No |
Returns the Agent snapshot at the specified version; omit to return the current Agent |
Example request
curl -X GET "https://api.qoder.com.cn/api/v1/cloud/agents/agent_019eXXXXXXXXXXXXXXXXXXXXXXXXXXXX" \
-H "Authorization: Bearer $QODER_PAT"
Example response
HTTP 200 OK
{
"type": "agent",
"id": "agent_019eXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
"name": "doc-test-agent",
"description": "",
"model": "ultimate",
"system": "You are the documentation testing assistant.",
"tools": [],
"mcp_servers": [],
"skills": [
{"type": "custom", "skill_id": "skill_019e5d133c057536872f745e0b6dbd5d"}
],
"metadata": {},
"multiagent": null,
"version": 1,
"archived_at": null,
"created_at": "2026-05-18T15:26:39.61669Z",
"updated_at": "2026-05-18T15:26:39.61669Z"
}
Response fields
When version is omitted, the response is the current Agent object. When version is provided, the response is an Agent version snapshot.
|
Field |
Type |
Description |
|
|
string |
Always |
|
|
string |
Agent unique identifier |
|
|
string |
Agent name |
|
|
string |
Agent description |
|
|
string | object |
Model identifier. See Agent model for details |
|
|
string |
System prompt |
|
|
Agent tool array |
Tool configuration list |
|
|
MCP server array |
MCP server configuration |
|
|
Skill binding array |
Skill bindings |
|
|
Metadata object |
Custom metadata |
|
|
Multiagent | null |
Agents configuration; |
|
|
integer |
Current version number |
|
|
string|null |
Archive time (ISO 8601); |
|
|
string |
Creation time (ISO 8601) |
|
|
string |
Last update time (ISO 8601) |
Errors
|
HTTP |
type |
Trigger |
|
400 |
|
|
|
401 |
|
PAT invalid or expired |
|
403 |
|
Not authorized to access this Agent |
|
404 |
|
Agent with the specified ID does not exist |
Error response example:
{
"type": "error",
"request_id": "cb80235f-76a2-4ff3-9e28-5aa2da12dc14",
"error": {
"type": "not_found_error",
"message": "Agent 'agent_nonexistent' was not found."
}
}