Query Digital Employee Sessions with GetThread API - CloudMonitor

Operation description

Retrieves a session.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

No authorization for this operation. If you encounter issues with this operation, contact technical support.

Request syntax

GET /digitalEmployee/{name}/thread/{threadId} HTTP/1.1

Path Parameters

Parameter	Type	Required	Description	Example
name	string	Yes	The name of the digital employee.	test
threadId	string	Yes	The session ID.	thread_id01

Request parameters

Parameter

Type

Required

Description

Example

No parameters required.

Response elements

Element	Type	Description	Example
	object	The response schema.
requestId	string	The request ID.	8FDE2569-626B-5176-9844-28877A*****
threadId	string	The session ID.	thread_id01
digitalEmployeeName	string	The name of the digital employee.	test
title	string	The session title.	testLive
status	string	The session status.	active
version	integer	The version.	1231
createTime	string	The time when the session was created.	2025-12-19T15:19:55.040403272+08:00
updateTime	string	The time when the thread was last updated.	2025-12-19T15:19:55.040403272+08:00
variables	object	The session properties.
workspace	string	The name of the workspace.	test
project	string	The name of the SLS project.	test
attributes	object	The attributes.
	string	A specific attribute.	test

Examples

Success response

JSON format

{
  "requestId": "8FDE2569-626B-5176-9844-28877A*****",
  "threadId": "thread_id01",
  "digitalEmployeeName": "test",
  "title": "testLive",
  "status": "active",
  "version": 1231,
  "createTime": "2025-12-19T15:19:55.040403272+08:00",
  "updateTime": "2025-12-19T15:19:55.040403272+08:00",
  "variables": {
    "workspace": "test",
    "project": "test"
  },
  "attributes": {
    "key": "test"
  }
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.