LiveAgentClient

LiveAgentClient = object

Defined in: packages/agent/src/index.ts:67

Methods

addTranscript()

addTranscript(line): Promise<void>

Defined in: packages/agent/src/index.ts:99

Parameters

line

cut?

boolean = ...

final

boolean = ...

id

string = ...

text

string = ...

turn?

boolean = ...

Returns

Promise<void>

---

browserOps()

browserOps(request): Promise<{ page: { changed?: { added: string[]; removed: string[]; }; controller: { color?: string; id: string; kind: "human" | "agent"; name: string; onBehalfOf?: { id: string; name: string; }; } | null; outline: string; screenshot?: string; title: string; url: string; }; results: ({ ok: true; } | { error: string; heldBy?: { color?: string; id: string; kind: "human" | "agent"; name: string; onBehalfOf?: { id: string; name: string; }; }; ok: false; })[]; }>

Defined in: packages/agent/src/index.ts:90

Parameters

request

ops

({ type: "navigate"; url: string; } | { ref: string; type: "click"; } | { ref: string; submit?: boolean; text: string; type: "type"; } | { key: string; type: "press"; } | { dy: number; type: "scroll"; } | { ms: number; type: "wait"; })[] = ...

Returns

Promise<{ page: { changed?: { added: string[]; removed: string[]; }; controller: { color?: string; id: string; kind: "human" | "agent"; name: string; onBehalfOf?: { id: string; name: string; }; } | null; outline: string; screenshot?: string; title: string; url: string; }; results: ({ ok: true; } | { error: string; heldBy?: { color?: string; id: string; kind: "human" | "agent"; name: string; onBehalfOf?: { id: string; name: string; }; }; ok: false; })[]; }>

---

browserVideo()

browserVideo(): Promise<{ token: string; url: string; }>

Defined in: packages/agent/src/index.ts:92

Returns

Promise<{ token: string; url: string; }>

---

canvasOps()

canvasOps(request): Promise<{ results: ({ humanShapes?: string[]; ids: string[]; ok: true; suggested?: boolean; } | { error: string; ok: false; })[]; suggestionId: string | null; }>

Defined in: packages/agent/src/index.ts:78

Parameters

request

approver?

string = ...

approverId?

string = ...

mode?

"edit" | "suggest" = ...

ops

({ shapes: object[]; type: "add_shapes"; } | { arrows: object[]; type: "connect"; } | { type: "update_shapes"; updates: object[]; } | { ids: string[]; type: "delete_shapes"; })[] = ...

Returns

Promise<{ results: ({ humanShapes?: string[]; ids: string[]; ok: true; suggested?: boolean; } | { error: string; ok: false; })[]; suggestionId: string | null; }>

---

chatOps()

chatOps(request): Promise<{ results: ({ id: string; ok: true; } | { error: string; ok: false; })[]; suggestionId: null; }>

Defined in: packages/agent/src/index.ts:80

Parameters

request

approver?

string = ...

approverId?

string = ...

mode?

"edit" | "suggest" = ...

ops

({ attachments?: object[]; id?: string; mentions?: object[]; text: string; type: "post_message"; } | { id: string; text: string; type: "edit_message"; } | { emoji: string; id: string; type: "react"; } | { type: "typing"; })[] = ...

Returns

Promise<{ results: ({ id: string; ok: true; } | { error: string; ok: false; })[]; suggestionId: null; }>

---

comment()

comment(request): Promise<{ threadId: string; }>

Defined in: packages/agent/src/index.ts:74

Parameters

request

{ body: string; threadId: string; } | { blockId: string; body: string; quote?: string; }

Returns

Promise<{ threadId: string; }>

---

desktopOps()

desktopOps(request): Promise<{ desktop: { actions: object[]; app: string; controller: { color?: string; id: string; kind: "human" | "agent"; name: string; onBehalfOf?: { id: string; name: string; }; } | null; cursor: { x: number; y: number; } | null; screen: { height: number; width: number; }; screenshot?: string; status: "starting" | "running" | "stopped" | "unavailable"; }; results: ({ ok: true; } | { error: string; heldBy?: { color?: string; id: string; kind: "human" | "agent"; name: string; onBehalfOf?: { id: string; name: string; }; }; ok: false; })[]; }>

Defined in: packages/agent/src/index.ts:95

Parameters

request

ops

({ type: "move"; x: number; y: number; } | { button?: "left" | "right" | "middle"; count?: 1 | 2; type: "click"; x: number; y: number; } | { from: [number, number]; to: [number, number]; type: "drag"; } | { amount?: number; direction: "up" | "down"; type: "scroll"; } | { keys: string[]; type: "key"; } | { text: string; type: "type"; } | { target: string; type: "open"; } | { application: string; type: "launch"; uri?: string; } | { ms: number; type: "wait"; })[] = ...

Returns

Promise<{ desktop: { actions: object[]; app: string; controller: { color?: string; id: string; kind: "human" | "agent"; name: string; onBehalfOf?: { id: string; name: string; }; } | null; cursor: { x: number; y: number; } | null; screen: { height: number; width: number; }; screenshot?: string; status: "starting" | "running" | "stopped" | "unavailable"; }; results: ({ ok: true; } | { error: string; heldBy?: { color?: string; id: string; kind: "human" | "agent"; name: string; onBehalfOf?: { id: string; name: string; }; }; ok: false; })[]; }>

---

frame()

frame(id): Promise<Buffer<ArrayBufferLike>>

Defined in: packages/agent/src/index.ts:94

Parameters

id

string

Returns

Promise<Buffer<ArrayBufferLike>>

---

frames()

frames(): Promise<{ frames: object[]; }>

Defined in: packages/agent/src/index.ts:93

Returns

Promise<{ frames: object[]; }>

---

history()

history(): Promise<{ events: object[]; sessions: object[]; }>

Defined in: packages/agent/src/index.ts:71

Returns

Promise<{ events: object[]; sessions: object[]; }>

---

markdown()

markdown(): Promise<string>

Defined in: packages/agent/src/index.ts:69

Returns

Promise<string>

---

mediaToken()

mediaToken(request?): Promise<{ canPublish: boolean; identity: string; room: string; token: string; url: string; }>

Defined in: packages/agent/src/index.ts:97

Parameters

request?

viewer?

string = ...

Returns

Promise<{ canPublish: boolean; identity: string; room: string; token: string; url: string; }>

---

ops()

ops(request): Promise<{ results: ({ blockIds: string[]; ok: true; } | { error: string; ok: false; })[]; suggestionId: string | null; }>

Defined in: packages/agent/src/index.ts:70

Parameters

request

approver?

string = ...

approverId?

string = ...

mode?

"edit" | "suggest" = ...

ops

({ afterBlockId: string | null; markdown: string; type: "insert"; } | { blockId: string; markdown: string; type: "replace"; } | { blockId: string; type: "delete"; })[] = ...

Returns

Promise<{ results: ({ blockIds: string[]; ok: true; } | { error: string; ok: false; })[]; suggestionId: string | null; }>

---

outline()

outline(): Promise<{ blocks: object[]; suggestions: object[]; threads: object[]; }>

Defined in: packages/agent/src/index.ts:68

Returns

Promise<{ blocks: object[]; suggestions: object[]; threads: object[]; }>

---

pptx()

pptx(title): Promise<Buffer<ArrayBufferLike>>

Defined in: packages/agent/src/index.ts:87

Parameters

title

string

Returns

Promise<Buffer<ArrayBufferLike>>

---

readBrowser()

readBrowser(options?): Promise<{ changed?: { added: string[]; removed: string[]; }; controller: { color?: string; id: string; kind: "human" | "agent"; name: string; onBehalfOf?: { id: string; name: string; }; } | null; outline: string; screenshot?: string; title: string; url: string; }>

Defined in: packages/agent/src/index.ts:91

Parameters

options?

screenshot?

boolean

Returns

Promise<{ changed?: { added: string[]; removed: string[]; }; controller: { color?: string; id: string; kind: "human" | "agent"; name: string; onBehalfOf?: { id: string; name: string; }; } | null; outline: string; screenshot?: string; title: string; url: string; }>

---

readCanvas()

readCanvas(): Promise<{ connections: object[]; shapes: object[]; suggestions: object[]; }>

Defined in: packages/agent/src/index.ts:79

Returns

Promise<{ connections: object[]; shapes: object[]; suggestions: object[]; }>

---

readChat()

readChat(options?): Promise<{ messages: object[]; }>

Defined in: packages/agent/src/index.ts:81

Parameters

options?

limit?

number

since?

number

Returns

Promise<{ messages: object[]; }>

---

readDeck()

readDeck(): Promise<{ slides: object[]; suggestions: object[]; theme: { mode: "light" | "dark"; name: string; themeId: string; }; }>

Defined in: packages/agent/src/index.ts:89

Returns

Promise<{ slides: object[]; suggestions: object[]; theme: { mode: "light" | "dark"; name: string; themeId: string; }; }>

---

readDesktop()

readDesktop(options?): Promise<{ actions: object[]; app: string; controller: { color?: string; id: string; kind: "human" | "agent"; name: string; onBehalfOf?: { id: string; name: string; }; } | null; cursor: { x: number; y: number; } | null; screen: { height: number; width: number; }; screenshot?: string; status: "starting" | "running" | "stopped" | "unavailable"; }>

Defined in: packages/agent/src/index.ts:96

Parameters

options?

screenshot?

boolean

Returns

Promise<{ actions: object[]; app: string; controller: { color?: string; id: string; kind: "human" | "agent"; name: string; onBehalfOf?: { id: string; name: string; }; } | null; cursor: { x: number; y: number; } | null; screen: { height: number; width: number; }; screenshot?: string; status: "starting" | "running" | "stopped" | "unavailable"; }>

---

readSheet()

readSheet(range?): Promise<{ colCount: number; columns: object[]; range: string | null; rowCount: number; rows: object[]; suggestions: object[]; }>

Defined in: packages/agent/src/index.ts:76

Parameters

range?

string

Returns

Promise<{ colCount: number; columns: object[]; range: string | null; rowCount: number; rows: object[]; suggestions: object[]; }>

---

readSpace()

readSpace(): Promise<{ objects: object[]; }>

Defined in: packages/agent/src/index.ts:86

Returns

Promise<{ objects: object[]; }>

---

restore()

restore(uptoId): Promise<void>

Defined in: packages/agent/src/index.ts:73

Parameters

uptoId

string

Returns

Promise<void>

---

sheetOps()

sheetOps(request): Promise<{ results: ({ humanCells?: string[]; ok: true; range: string; suggested?: boolean; } | { error: string; ok: false; })[]; suggestionId: string | null; }>

Defined in: packages/agent/src/index.ts:75

Parameters

request

approver?

string = ...

approverId?

string = ...

mode?

"edit" | "suggest" = ...

ops

({ range: string; type: "set_range"; values: string[][]; } | { afterRow: number | null; type: "add_rows"; values: string[][]; } | { fromRow: number; toRow: number; type: "delete_rows"; } | { columns: string; format?: "number" | "date" | "text" | "currency" | "percent"; type: "format_columns"; width?: number; })[] = ...

Returns

Promise<{ results: ({ humanCells?: string[]; ok: true; range: string; suggested?: boolean; } | { error: string; ok: false; })[]; suggestionId: string | null; }>

---

slidesOps()

slidesOps(request): Promise<{ results: ({ humanElements?: string[]; ids: string[]; ok: true; suggested?: boolean; } | { error: string; ok: false; })[]; suggestionId: string | null; }>

Defined in: packages/agent/src/index.ts:88

Parameters

request

approver?

string = ...

approverId?

string = ...

mode?

"edit" | "suggest" = ...

ops

({ attribution?: string; bullets?: string[]; chart?: { chart: "bar" | "line" | "pie"; labels: string[]; series: object[]; }; id?: string; image?: { alt: string; url: string; }; layout?: "section" | "quote" | "title" | "title_bullets" | "two_column" | "chart_takeaway" | "image_full" | "closing"; notes?: string; position?: number; quote?: string; rightBullets?: string[]; subtitle?: string; title?: string; type: "add_slide"; } | { attribution?: string; bullets?: string[]; chart?: { chart: "bar" | "line" | "pie"; labels: string[]; series: object[]; }; hidden?: boolean; image?: { alt: string; url: string; }; layout?: "section" | "quote" | "title" | "title_bullets" | "two_column" | "chart_takeaway" | "image_full" | "closing"; notes?: string; quote?: string; rightBullets?: string[]; slide: string; subtitle?: string; title?: string; type: "update_slide"; } | { position: number; slide: string; type: "move_slide"; } | { slide: string; type: "delete_slide"; } | { overrides?: { accent?: string; background?: string; }; themeId?: "studio" | "midnight"; type: "set_theme"; } | { data?: { chart: "bar" | "line" | "pie"; labels: string[]; series: object[]; } | { alt: string; url: string; } | { header: boolean; rows: string[][]; } | { shape: "ellipse" | "line" | "rect"; }; delete?: boolean; element: string; h?: number; rotation?: number; style?: { align?: "left" | "center" | "right"; color?: string; fill?: string; opacity?: number; radius?: number; role?: "quote" | "body" | "title" | "subtitle" | "heading" | "caption"; stroke?: string; valign?: "top" | "middle" | "bottom"; }; text?: string; type: "edit_element"; w?: number; x?: number; y?: number; z?: number; } | { data?: { chart: "bar" | "line" | "pie"; labels: string[]; series: object[]; } | { alt: string; url: string; } | { header: boolean; rows: string[][]; } | { shape: "ellipse" | "line" | "rect"; }; h?: number; id?: string; kind: "text" | "shape" | "chart" | "image" | "table"; slide: string; style?: { align?: "left" | "center" | "right"; color?: string; fill?: string; opacity?: number; radius?: number; role?: "quote" | "body" | "title" | "subtitle" | "heading" | "caption"; stroke?: string; valign?: "top" | "middle" | "bottom"; }; text?: string; type: "add_element"; w?: number; x?: number; y?: number; })[] = ...

Returns

Promise<{ results: ({ humanElements?: string[]; ids: string[]; ok: true; suggested?: boolean; } | { error: string; ok: false; })[]; suggestionId: string | null; }>

---

spaceOps()

spaceOps(request): Promise<{ results: ({ id: string; ok: true; } | { by?: string; error: string; ok: false; })[]; suggestionId: null; }>

Defined in: packages/agent/src/index.ts:85

Parameters

request

approver?

string = ...

approverId?

string = ...

mode?

"edit" | "suggest" = ...

ops

({ docName: string; h?: number; kind: string; title: string; type: "place"; w?: number; x?: number; y?: number; } | { id: string; type: "move"; x: number; y: number; } | { h: number; id: string; type: "resize"; w: number; } | { id: string; type: "remove"; } | { id: string; type: "bring_to_front"; } | { id: string; state: "minimized" | "maximized" | "open"; type: "set_state"; })[] = ...

Returns

Promise<{ results: ({ id: string; ok: true; } | { by?: string; error: string; ok: false; })[]; suggestionId: null; }>

---

speak()

speak(text): Promise<{ id: string; spoken: "server" | "clients"; }>

Defined in: packages/agent/src/index.ts:100

Parameters

text

string

Returns

Promise<{ id: string; spoken: "server" | "clients"; }>

---

transcript()

transcript(): Promise<{ lines: object[]; present: object[]; room: string; startedAt: string | null; }>

Defined in: packages/agent/src/index.ts:98

Returns

Promise<{ lines: object[]; present: object[]; room: string; startedAt: string | null; }>

---

version()

version(uptoId, sinceId?): Promise<{ cells: object[]; diff: object[]; markdown: string; objects: object[]; shapes: object[]; slides: object[]; uptoId: string; }>

Defined in: packages/agent/src/index.ts:72

Parameters

uptoId

string

sinceId?

string

Returns

Promise<{ cells: object[]; diff: object[]; markdown: string; objects: object[]; shapes: object[]; slides: object[]; uptoId: string; }>

---

xlsx()

xlsx(title): Promise<Buffer<ArrayBufferLike>>

Defined in: packages/agent/src/index.ts:77

Parameters

title

string

Returns

Promise<Buffer<ArrayBufferLike>>