Skip to main content

Get an agent

Retrieve the full details of a specified Agent.

Request Headers

HeaderRequiredDescription
AuthorizationYesBearer <PAT>

Path parameters

ParameterTypeRequiredDescription
agent_idstringYesAgent unique identifier, formatted as the "agent_" prefix plus a UUID

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": "你是文档测试助手",
  "instructions": "你是文档测试助手",
  "tools": [],
  "mcp_servers": [],
  "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"
}

Response Fields

Field

Type

Description

type

string

Fixed value "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 for instructions (deprecated; use instructions)

tools

array

Tool configuration list

mcp_servers

array

MCP server configuration

default_environment

string

Default runtime environment

version

integer

Current version

archived

boolean

Whether the Agent is archived

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)

Error Codes

HTTPtypeTrigger
401authentication_errorPAT invalid or expired
403permission_errorNot authorized to access this Agent
404not_found_errorAgent with the given ID does not exist
Example error response: 
{
  "type": "error",
  "error": {
    "type": "not_found_error",
    "message": "Agent 'agent_nonexistent' was not found."
  }
}