Agents

Get an agent

Return a single agent by id.

404 when the agent does not exist, belongs to another org, or the caller lacks visibility (owner/share/org-visible). The org scope is enforced by AgentService.get_agent's ownership check; a wrong-org agent surfaces as AgentNotFoundError → 404 so existence is not leaked across org boundaries.

Note: DELETE is a soft delete: a destroyed agent stays readable here with status: "destroyed" rather than returning 404. Poll for status == "destroyed" to confirm teardown; do not rely on a 404 (QA Finding #6).

get/agents/{agent_id}

Request

Base URL: https://api-docs.jackhamr.ai (the document declares no server; this is the origin it was published from)
URL: https://api-docs.jackhamr.ai/agents/{agent_id}
Auth: none declared

Path parameters

agent_idstring required

Response

Successful Response

idstring required

organization_idstring required

namestring required

descriptionstring nullable

statusstring required

owner_user_idstring nullable

allow_cloningboolean

visible_to_orgboolean

coresinteger nullable

memoryinteger nullable

disk_sizeinteger nullable

template_idstring nullable

os_templatestring nullable

size_preset_idstring nullable

sort_orderinteger

is_board_cloneboolean

clone_of_agent_idstring nullable

avatar_image_urlstring nullable

avatar_colorstring nullable

subtitlestring nullable

tagsobject nullable

metadataobject nullable

subagent_max_iterationsinteger nullable

error_messagestring nullable

last_error_atstring date-time nullable

created_atstring date-time required

updated_atstring date-time required

provisioned_atstring date-time nullable

started_atstring date-time nullable

stopped_atstring date-time nullable

hibernated_atstring date-time nullable

Changes

No recorded changes to this operation across all 1 revision of this API.