Logo
Classes

AgentClient

Defined in: packages/cloud/src/agent/client.ts:25

Async client for agent data operations

Constructors

Constructor

new AgentClient(options?): AgentClient

Defined in: packages/cloud/src/agent/client.ts:30

Parameters

options?
apiKey?

string

baseUrl?

string

Returns

AgentClient

Methods

create()

create<T>(options): Promise<TypedAgentData<T>>

Defined in: packages/cloud/src/agent/client.ts:50

Create new agent data

Type Parameters

T

T = unknown

Parameters

options

CreateAgentDataOptions<T>

Returns

Promise<TypedAgentData<T>>


get()

get<T>(id): Promise<null | TypedAgentData<T>>

Defined in: packages/cloud/src/agent/client.ts:71

Get agent data by ID

Type Parameters

T

T = unknown

Parameters

id

string

Returns

Promise<null | TypedAgentData<T>>


update()

update<T>(id, options): Promise<TypedAgentData<T>>

Defined in: packages/cloud/src/agent/client.ts:95

Update agent data

Type Parameters

T

T = unknown

Parameters

id

string

options

UpdateAgentDataOptions<T>

Returns

Promise<TypedAgentData<T>>


delete()

delete(id): Promise<void>

Defined in: packages/cloud/src/agent/client.ts:114

Delete agent data

Parameters

id

string

Returns

Promise<void>


list()

list<T>(options): Promise<TypedAgentDataItems<T>>

Defined in: packages/cloud/src/agent/client.ts:125

List agent data

Type Parameters

T

T = unknown

Parameters

options

ListAgentDataOptions

Returns

Promise<TypedAgentDataItems<T>>


extract()

extract<T>(agentId, input, options?): Promise<ExtractedData<T>>

Defined in: packages/cloud/src/agent/client.ts:172

Extract data from agent with retry logic

Type Parameters

T

T = unknown

Parameters

agentId

string

input

unknown

options?

ExtractOptions

Returns

Promise<ExtractedData<T>>