GET /v1/agents/{agent_id}
Returns the full details of the specified Agent.
| Header | Required | Description |
|---|
Authorization | Yes | Bearer <PAT> |
X-CAS-Include-Extended | No | Set to true to include extended fields (skills, metadata) in the response |
Path parameters
| Parameter | Type | Required | Description |
|---|
agent_id | string | Yes | Agent unique identifier (agent_ prefix followed by a UUID) |
Example request
curl -X GET "https://api.qoder.com/api/v1/cloud/agents/agent_019eXXXXXXXXXXXXXXXXXXXXXXXXXXXX" \
-H "Authorization: Bearer $QODER_PAT"
Example request (with extended fields)
curl -X GET "https://api.qoder.com/api/v1/cloud/agents/agent_019eXXXXXXXXXXXXXXXXXXXXXXXXXXXX" \
-H "Authorization: Bearer $QODER_PAT" \
-H "X-CAS-Include-Extended: true"
Example response
HTTP 200 OK
{
"type": "agent",
"id": "agent_019eXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
"name": "doc-test-agent",
"description": "",
"model": "ultimate",
"system": "You are a documentation testing assistant.",
"instructions": "You are a documentation testing assistant.",
"tools": [],
"mcp_servers": [],
"skills": [
{"type": "custom", "skill_id": "skill_019e5d133c057536872f745e0b6dbd5d"}
],
"metadata": {},
"default_environment": "",
"version": 1,
"archived": false,
"archived_at": null,
"created_at": "2026-05-18T15:26:39.61669Z",
"updated_at": "2026-05-18T15:26:39.61669Z"
}
Without the X-CAS-Include-Extended: true header, the response omits the skills and metadata fields.
Response fields
| Field | Type | Description |
|---|
type | string | Always "agent" |
id | string | Agent unique identifier |
name | string | Agent name |
description | string | Agent description |
model | string | Model identifier |
instructions | string | System prompt |
system | string | Alias of instructions (deprecated, use instructions instead) |
tools | array | Tool configuration list |
mcp_servers | array | MCP server configuration |
skills | array | Skill bindings (extended field, requires X-CAS-Include-Extended: true) |
metadata | object | Custom metadata (extended field, requires X-CAS-Include-Extended: true) |
default_environment | string | Default runtime environment |
version | integer | Current version |
archived | boolean | Whether archived (default false) |
archived_at | string|null | Archive time (ISO 8601), null when not archived |
created_at | string | Creation time (ISO 8601) |
updated_at | string | Last update time (ISO 8601) |
Errors
| HTTP | Type | Trigger |
|---|
| 401 | authentication_error | PAT invalid or expired |
| 403 | permission_error | Not authorized for this Agent |
| 404 | not_found_error | Agent with the given ID does not exist |
Error response example
{
"type": "error",
"error": {
"type": "not_found_error",
"message": "Agent 'agent_nonexistent' was not found."
}
}
