Class: AgentInstanceClient
Prefactor TypeScript SDK / @prefactor/core / AgentInstanceClient
Class: AgentInstanceClient
Section titled “Class: AgentInstanceClient”Defined in: packages/core/src/transport/http/agent-instance-client.ts:46
Constructors
Section titled “Constructors”Constructor
Section titled “Constructor”new AgentInstanceClient(
httpClient):AgentInstanceClient
Defined in: packages/core/src/transport/http/agent-instance-client.ts:47
Parameters
Section titled “Parameters”httpClient
Section titled “httpClient”Returns
Section titled “Returns”AgentInstanceClient
Methods
Section titled “Methods”register()
Section titled “register()”register(
payload):Promise<AgentInstanceResponse>
Defined in: packages/core/src/transport/http/agent-instance-client.ts:49
Parameters
Section titled “Parameters”payload
Section titled “payload”Returns
Section titled “Returns”Promise<AgentInstanceResponse>
start()
Section titled “start()”start(
agentInstanceId,options?):Promise<AgentInstanceResponse>
Defined in: packages/core/src/transport/http/agent-instance-client.ts:56
Parameters
Section titled “Parameters”agentInstanceId
Section titled “agentInstanceId”string
options?
Section titled “options?”Returns
Section titled “Returns”Promise<AgentInstanceResponse>
finish()
Section titled “finish()”finish(
agentInstanceId,options?):Promise<AgentInstanceResponse>
Defined in: packages/core/src/transport/http/agent-instance-client.ts:67
Parameters
Section titled “Parameters”agentInstanceId
Section titled “agentInstanceId”string
options?
Section titled “options?”Returns
Section titled “Returns”Promise<AgentInstanceResponse>
recordQuality()
Section titled “recordQuality()”recordQuality(
agentInstanceId,payload):Promise<AgentInstanceResponse>
Defined in: packages/core/src/transport/http/agent-instance-client.ts:88
Records a named quality payload on an agent instance.
A null payload removes the recorded value for that name. Other names are left unchanged. An idempotency key is auto-generated when omitted.
Parameters
Section titled “Parameters”agentInstanceId
Section titled “agentInstanceId”string
Backend agent instance ID.
payload
Section titled “payload”AgentInstanceRecordQualityPayload
Quality schema name and payload (or null to remove).
Returns
Section titled “Returns”Promise<AgentInstanceResponse>
The API response containing the updated instance details.