All Products
Search
Document Center

:Get an Agent

Last Updated:Jul 16, 2026

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

Authorization

Yes

Bearer <PAT>

Path parameters

Parameter

Type

Required

Description

agent_id

string

Yes

Agent unique identifier, prefixed with agent_

Query parameters

Parameter

Type

Required

Description

version

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

type

string

Always "agent"

id

string

Agent unique identifier

name

string

Agent name

description

string

Agent description

model

string | object

Model identifier. See Agent model for details

system

string

System prompt

tools

Agent tool array

Tool configuration list

mcp_servers

MCP server array

MCP server configuration

skills

Skill binding array

Skill bindings

metadata

Metadata object

Custom metadata

multiagent

Multiagent | null

Agents configuration; null when not set

version

integer

Current version number

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

400

invalid_request_error

version is not a positive integer

401

authentication_error

PAT invalid or expired

403

permission_error

Not authorized to access this Agent

404

not_found_error

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."
  }
}