Interface ResumeExternalToolRequestWithRegisteredToolsOptions

Optional runtime-only data needed when resuming a persisted external tool pause after the original AgentOS process is gone.

interface ResumeExternalToolRequestWithRegisteredToolsOptions {
    userContext?: Partial<UserContext>;
    organizationId?: string;
    correlationId?: string;
    fallbackExternalToolHandler?: PendingExternalToolHandler;
    externalTools?: ExternalToolRegistry;
    userApiKeys?: Record<string, string>;
    preferredModelId?: string;
    preferredProviderId?: string;
}

Hierarchy (view full)

Properties

userContext? organizationId? correlationId? fallbackExternalToolHandler? externalTools? userApiKeys? preferredModelId? preferredProviderId?

Properties

Optional userContext

userContext?: Partial<UserContext>

Optional additional user-context fields to merge into the execution context. pendingRequest.userId always wins.

Optional organizationId

organizationId?: string

Trusted runtime-only organization context to propagate into both userContext.organizationId and sessionData.organizationId.

Optional correlationId

correlationId?: string

Optional correlation ID for tool execution tracing. Defaults to the pending stream ID when omitted.

Optional fallbackExternalToolHandler

fallbackExternalToolHandler?: PendingExternalToolHandler

Optional fallback for pending external tool calls that are not registered in AgentOS. Use this when the same persisted pause can mix AgentOS- registered tools with custom host-managed tools.

Optional externalTools

externalTools?: ExternalToolRegistry

Optional map, array, or iterable of host-managed external tools to use when a tool name is not registered in AgentOS itself.

Optional userApiKeys

userApiKeys?: Record<string, string>

Optional preferredModelId

preferredModelId?: string

Optional preferredProviderId

preferredProviderId?: string

Settings

Member Visibility

Theme

On This Page

userContextorganizationIdcorrelationIdfallbackExternalToolHandlerexternalToolsuserApiKeyspreferredModelIdpreferredProviderId