SDK 方法参考

Client

构造函数

new Client(options: ClientOptions): Client

ClientOptions 参数：

示例：

import Client from '@ctyun/desktop-agent-sdk';

const client = new Client({
  apiKey: process.env.AIUSE_API_KEY,
  apiSecret: process.env.AIUSE_API_SECRET,
  desktopCode: process.env.AIUSE_DESKTOP_CODE,
  serviceURL: process.env.AIUSE_SERVICE_URL || 'https://desk.ctyun.cn:8816'
});

createSession

创建会话并返回会话对象。

async createSession(): Promise<Session>

返回的 Session 对象包含：

通用返回结构

SDK 方法通常返回如下结构：

{
  "code": 0,
  "data": null,
  "msg": null
}

ComputerAPI

move_mouse

移动鼠标到指定坐标。

await session.computer.move_mouse({ x: 500, y: 300 });

click_mouse

在指定位置点击鼠标。

await session.computer.click_mouse({
  x: 500,
  y: 300,
  clickMode: 'left'
});

press_mouse

按下鼠标键。

await session.computer.press_mouse({
  x: 500,
  y: 300,
  clickMode: 'left'
});

release_mouse

释放鼠标键。

await session.computer.release_mouse({
  x: 500,
  y: 300,
  clickMode: 'left'
});

drag_mouse

从起点拖拽到终点。

await session.computer.drag_mouse({
  startX: 500,
  startY: 300,
  endX: 800,
  endY: 500
});

scroll

在指定位置滚动。

await session.computer.scroll({
  startX: 500,
  startY: 300,
  direction: 'down',
  amount: 3
});

press_key

按下键盘按键或组合键。

await session.computer.press_key({ key: 'Enter' });
await session.computer.press_key({ key: 'ctrl c' });

type_text

输入文本。

await session.computer.type_text({
  text: 'Hello World'
});

screen_shot

截取当前桌面屏幕。

const result = await session.computer.screen_shot();

get_cursor_position

获取当前鼠标位置。

const result = await session.computer.get_cursor_position();

成功时，data 中通常包含：

{
  "PositionX": 500,
  "PositionY": 300
}

FileSystemAPI

create_directory

创建目录。

await session.filesystem.create_directory({
  path: 'C:/ai-user-test'
});

read_file

读取文本文件。

const result = await session.filesystem.read_file({
  path: 'C:/ai-user-test/demo.txt',
  offset: 0,
  length: 1024
});

write_file

写入文本文件。

await session.filesystem.write_file({
  path: 'C:/ai-user-test/result.txt',
  mode: 'overwrite',
  content: 'result content'
});

move_file

移动或重命名文件、目录。

await session.filesystem.move_file({
  source: 'C:/ai-user-test/result.txt',
  destination: 'C:/ai-user-test/archive/result.txt'
});

search_files

搜索文件。

const result = await session.filesystem.search_files({
  path: 'C:/ai-user-test',
  pattern: '*.txt',
  matchMode: 'wildcard'
});

close

关闭当前会话。

await session.close();

建议在 finally 中调用，确保异常场景也能释放会话。

常见错误码