Skip to main content

@agentshelf/external-agents-sdk / ExternalAgentClientOptions

Type Alias: ExternalAgentClientOptions

type ExternalAgentClientOptions = {
  apiBase?: string;
  apiBaseUrl?: string;
  externalAgentRef?: ExternalAgentRef;
  fetch?: FetchLike;
  getBootstrapAssertion: () => Promise<string> | string;
  onError?: (error) => void;
  storage?: RuntimeStorage<ExternalAgentStoredSessionRecord>;
  storageKey?: string;
  transport?: RuntimeTransport;
};

Properties​

apiBase?​

optional apiBase?: string;

apiBaseUrl?​

optional apiBaseUrl?: string;

externalAgentRef?​

optional externalAgentRef?: ExternalAgentRef;

fetch?​

optional fetch?: FetchLike;

getBootstrapAssertion​

getBootstrapAssertion: () => Promise<string> | string;

Returns​

Promise<string> | string

onError?​

optional onError?: (error) => void;

Parameters​

ParameterType
errorRuntimeSdkError

Returns​

void

storage?​

optional storage?: RuntimeStorage<ExternalAgentStoredSessionRecord>;

storageKey?​

optional storageKey?: string;

transport?​

optional transport?: RuntimeTransport;