Skip to main content

Interface: ResumeExternalToolRequestWithRegisteredToolsOptions

Defined in: packages/agentos/src/api/runtime/resumeExternalToolRequestWithRegisteredTools.ts:76

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

Extends​

Properties​

applicationNote?​

optional applicationNote: string

Defined in: packages/agentos/src/api/types/AgentOSExternalToolRequest.ts:40

The note of the turn this resume continues (AgentOSInput.applicationNote). Unset, the continuation sends the paused stream's note while this process holds that stream, and none after a restart; an empty or blank note sends none. Runtime-only like organizationId: the pause never stores it.

Inherited from​

AgentOSResumeExternalToolRequestOptions.applicationNote


correlationId?​

optional correlationId: string

Defined in: packages/agentos/src/api/runtime/resumeExternalToolRequestWithRegisteredTools.ts:62

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

Inherited from​

PendingExternalToolExecutionOptions.correlationId


externalTools?​

optional externalTools: ExternalToolRegistry

Defined in: packages/agentos/src/api/runtime/resumeExternalToolRequestWithRegisteredTools.ts:73

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

Inherited from​

PendingExternalToolExecutionOptions.externalTools


fallbackExternalToolHandler?​

optional fallbackExternalToolHandler: PendingExternalToolHandler

Defined in: packages/agentos/src/api/runtime/resumeExternalToolRequestWithRegisteredTools.ts:68

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.

Inherited from​

PendingExternalToolExecutionOptions.fallbackExternalToolHandler


organizationId?​

optional organizationId: string

Defined in: packages/agentos/src/api/runtime/resumeExternalToolRequestWithRegisteredTools.ts:57

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

Inherited from​

PendingExternalToolExecutionOptions.organizationId


preferredModelId?​

optional preferredModelId: string

Defined in: packages/agentos/src/api/types/AgentOSExternalToolRequest.ts:25

Inherited from​

AgentOSResumeExternalToolRequestOptions.preferredModelId


preferredProviderId?​

optional preferredProviderId: string

Defined in: packages/agentos/src/api/types/AgentOSExternalToolRequest.ts:26

Inherited from​

AgentOSResumeExternalToolRequestOptions.preferredProviderId


userApiKeys?​

optional userApiKeys: Record<string, string>

Defined in: packages/agentos/src/api/types/AgentOSExternalToolRequest.ts:24

Inherited from​

AgentOSResumeExternalToolRequestOptions.userApiKeys


userContext?​

optional userContext: Partial<UserContext>

Defined in: packages/agentos/src/api/runtime/resumeExternalToolRequestWithRegisteredTools.ts:52

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

Inherited from​

PendingExternalToolExecutionOptions.userContext