Skip to content

Ticket

Bases: DuploResource

Manage AI HelpDesk tickets in DuploCloud.

Tickets live inside an AI HelpDesk workspace and are handled by an agent. Workspace and agent resolution is delegated to the workspace and agent resources so the same name-or-id lookup is shared across the CLI.

Commands

create_ticket

Create an AI HelpDesk ticket.

The workspace is resolved via --workspace (name) or --workspace-id. Provide either --agent_id (preferred, skips the lookup) or --agent_name (resolved via the agent resource). When --content is supplied the initial message is sent to the agent.

CLI Usage 
duploctl ticket create_ticket --title <title> --workspace <workspace> (--agent_id <id> | --agent_name <name>) [--content <content>]

Returns:

Name Type Description
ticket_response dict

A dict with ticketname, ai_response and chat_url keys.

Raises:

Type Description
DuploError

If the workspace cannot be resolved, or if neither agent_id nor agent_name is provided.

Parameters:

--title, --title required
The Title for ticket
str
--workspace, --workspace, --wksp, -W
AI HelpDesk workspace name. Resolved to a workspace id via the workspaces lookup.
str
--workspace_id, --workspace-id, --wksp-id
AI HelpDesk workspace id. Skips the workspace name lookup when provided.
str
--agent_id, --agent_id, --aid
AI Agent ID to be used to process the ticket. Skips the agent name lookup when provided.
str
--agent_name, --agent_name, --agent
AI Agent name to be used to process the ticket. Either --agent_id or --agent_name is required; --agent_id is preferred.
str
--message, --content, --msg, --message, -f
The message to send to the AI agent. Pass text inline (--content 'hello') or read from stdin with '-f -' (e.g. 'echo hello | duploctl ticket send_message -f -'). Read from a file with '-f - < message.txt'.
str action: StdinTextAction
--helpdesk_origin, --helpdesk-origin, --origin
The helpdesk origin to use for the ticket
str
--streaming, --streaming
Force the streaming (SSE) send endpoint regardless of the agent's advertised streaming support.
bool
--api_version, --api-version
API Version
str default: v1

find

Find an AI HelpDesk ticket within a workspace.

The ticket is fetched directly by its identifier (name or --id). The workspace is resolved via --workspace (name) or --workspace-id.

CLI Usage 
duploctl ticket find <name> --workspace <workspace>
duploctl ticket find --id <id> --workspace-id <workspace id>

Returns:

Name Type Description
resource dict

The ticket object.

Raises:

Type Description
DuploError

If no ticket identifier or workspace selector is given.

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
--workspace, --workspace, --wksp, -W
AI HelpDesk workspace name. Resolved to a workspace id via the workspaces lookup.
str
--workspace_id, --workspace-id, --wksp-id
AI HelpDesk workspace id. Skips the workspace name lookup when provided.
str
--api_version, --api-version
API Version
str default: v1

send_message

Send a message to an existing AI HelpDesk ticket.

The ticket's assigned agent is fetched to decide whether to use the streaming endpoint; --streaming forces it on regardless.

CLI Usage 
echo "the message" | duploctl ticket send_message --id <id> --workspace <workspace> -f -
duploctl ticket send_message --id <id> --workspace <workspace> --content "the message"

Returns:

Name Type Description
chat_response dict

A dict with ai_response and chat_url keys.

Raises:

Type Description
DuploError

If no ticket identifier, workspace, or message is provided.

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
--workspace, --workspace, --wksp, -W
AI HelpDesk workspace name. Resolved to a workspace id via the workspaces lookup.
str
--workspace_id, --workspace-id, --wksp-id
AI HelpDesk workspace id. Skips the workspace name lookup when provided.
str
--message, --content, --msg, --message, -f
The message to send to the AI agent. Pass text inline (--content 'hello') or read from stdin with '-f -' (e.g. 'echo hello | duploctl ticket send_message -f -'). Read from a file with '-f - < message.txt'.
str action: StdinTextAction
--streaming, --streaming
Force the streaming (SSE) send endpoint regardless of the agent's advertised streaming support.
bool
--api_version, --api-version
API Version
str default: v1