PURISTA API

---

PURISTA API / @purista/ai / InvokeAgentOptions

Type Alias: InvokeAgentOptions

InvokeAgentOptions = object

Defined in: packages/ai/src/runtime/invokeAgent.ts:8

Properties

agentName

agentName: string

Defined in: packages/ai/src/runtime/invokeAgent.ts:12

Target agent service name.

---

agentVersion

agentVersion: string

Defined in: packages/ai/src/runtime/invokeAgent.ts:14

Target agent service version.

---

correlationId?

optional correlationId: string

Defined in: packages/ai/src/runtime/invokeAgent.ts:26

Optional correlation id used for distributed trace chaining.

---

eventBridge

eventBridge: EventBridge

Defined in: packages/ai/src/runtime/invokeAgent.ts:10

EventBridge instance used to reach the target agent service.

---

failOnErrorFrame?

optional failOnErrorFrame: boolean

Defined in: packages/ai/src/runtime/invokeAgent.ts:35

When true (default), protocol error envelopes emitted by the target agent are treated as invocation failures and throw immediately.

---

parameter?

optional parameter: unknown

Defined in: packages/ai/src/runtime/invokeAgent.ts:18

Optional invoke parameter metadata passed alongside payload.

---

payload

payload: unknown

Defined in: packages/ai/src/runtime/invokeAgent.ts:16

Payload delivered to the target agent run command.

---

principalId?

optional principalId: string

Defined in: packages/ai/src/runtime/invokeAgent.ts:20

Optional principal id forwarded for scoped memory and auditing.

---

sessionId?

optional sessionId: string

Defined in: packages/ai/src/runtime/invokeAgent.ts:28

Optional session id injected into object payloads when missing.

---

stream?

optional stream: AgentStreamResponder

Defined in: packages/ai/src/runtime/invokeAgent.ts:30

Optional live frame responder for streaming consumption.

---

tenantId?

optional tenantId: string

Defined in: packages/ai/src/runtime/invokeAgent.ts:22

Optional tenant id forwarded for scoped memory and auditing.

---

timeoutMs?

optional timeoutMs: number

Defined in: packages/ai/src/runtime/invokeAgent.ts:24

Optional timeout passed to stream open/invoke calls.