Skip to content

Agent

Bases: DuploResource

Manage AI HelpDesk agents in DuploCloud.

An agent processes AI HelpDesk tickets. Agents are resolved by name to their id for ticket assignment, and expose whether they stream responses via their metaData.STREAMING_ENABLED flag.

Commands

find

Find an AI HelpDesk agent by name or id.

With --id the agent is fetched directly. Otherwise it is matched by name (case-insensitive) from the agents list. The list and single-agent endpoints return the same object shape, so the matching list entry — including metaData — is returned as-is.

CLI Usage
duploctl agent find <name>
duploctl agent find --id <id>

Returns:

Name Type Description
resource dict

The matching agent object.

Raises:

Type Description
DuploError

If neither name nor id is given.

DuploNotFound

If no agent matches the name or id.

Parameters:

name positional
The resource name
str
--id, --id
The resource id. When provided, the resource is fetched directly by id and the name lookup is skipped.
str
--api_version, --api-version
API Version
str default: v1

list

Retrieve a list of AI HelpDesk agents.

CLI Usage
duploctl agent list

Returns:

Name Type Description
list list

A list of agent objects.

Parameters:

--api_version, --api-version
API Version
str default: v1

supports_streaming

Return whether an agent streams its responses.

The top-level doesSupportStreaming is unreliable on some portals — agents that actually stream still report false. The authoritative flag is metaData.STREAMING_ENABLED (the string "true"), which this command reads.

CLI Usage
duploctl agent supports_streaming <name>
duploctl agent supports_streaming --id <id>

Returns:

Name Type Description
bool bool

True when metaData.STREAMING_ENABLED is "true".

Parameters:

name positional
The resource name
str
--id, --id
The resource id. When provided, the resource is fetched directly by id and the name lookup is skipped.
str
--api_version, --api-version
API Version
str default: v1