POST /agent/get
Get Agent
Get agent information using the canonical shared agent operation.
Request Body (GetAgentApiRequest)
| Field | Type | Required | Description |
|---|---|---|---|
id | string | No | UUID of the agent to retrieve |
agent_id | string | No | Legacy alias for the agent identifier |
draft_id | string | No | UUID of the draft to retrieve |
snapshot_key | string | No | Cache snapshot key for consistent reads across related requests |
names | app__infra__agent__types__SectionFilter | No | Filter options for names |
descriptions | app__infra__agent__types__SectionFilter | No | Filter options for descriptions |
models | app__infra__agent__types__SectionFilter | No | Filter options for models |
prompts | app__infra__agent__types__SectionFilter | No | Filter options for prompts |
instructions | app__infra__agent__types__SectionFilter | No | Filter options for instructions |
flags | app__infra__agent__types__SectionFilter | No | Filter options for flags |
departments | app__infra__agent__types__SectionFilter | No | Filter options for departments |
tools | app__infra__agent__types__SectionFilter | No | Filter options for tools |
temperature_levels | app__infra__agent__types__SectionFilter | No | Filter options for temperature levels |
reasoning_levels | app__infra__agent__types__SectionFilter | No | Filter options for reasoning levels |
voices | app__infra__agent__types__SectionFilter | No | Filter options for voices |
qualities | app__infra__agent__types__SectionFilter | No | Filter options for qualities |
rubrics | app__infra__agent__types__SectionFilter | No | Filter options for rubrics |
Response (GetAgentApiResponse)
| Field | Type | Required | Description |
|---|---|---|---|
actor_name | string | No | Display name of the current actor |
agent_exists | boolean | No | Whether the agent exists |
can_edit | boolean | No | Whether the current user can edit |
disabled_reason | string | No | Reason the agent is disabled |
group_id | string | No | UUID of the owning group |
draft_name | string | No | Immutable draft label from the active draft entry, when a draft_id was supplied. None for non-draft fetches. |
agent_id | string | No | UUID of the selected agent |
show_ai_generate | boolean | No | Whether any step should show AI generate |
basic_show_ai_generate | boolean | No | Show AI generate for basic step |
general_show_ai_generate | boolean | No | Show AI generate for general step |
pending_ids | string[] | No | Pending resource identifiers when available |
names | AgentNameResource[] | No | Name resources |
descriptions | AgentDescriptionResource[] | No | Description resources |
models | AgentModelResource[] | No | Model resources |
prompts | AgentPromptResource[] | No | Prompt resources |
instructions | AgentInstructionResource[] | No | Instruction resources |
flags | AgentFlagResource[] | No | Flag resources (one per flags_resource row, value=true/false) |
departments | AgentDepartmentResource[] | No | Department resources |
tools | AgentToolResource[] | No | Tool resources |
temperature_levels | AgentTemperatureLevelResource[] | No | Temperature level resources |
reasoning_levels | AgentReasoningLevelResource[] | No | Reasoning level resources |
voices | AgentVoiceResource[] | No | Voice resources |
qualities | AgentQualityResource[] | No | Quality resources |
rubrics | AgentRubricResource[] | No | Rubric resources |
Last updated on