API Reference · public documentation
Historical Retell preview.1 API
Historical preview.1 adapter declarations; use the current preview.3 guide for integration.
For a current integration, use Retell adapter preview.3 and equipment example preview.4. They run the current package set locally.
This API page documents only @answerup/retell@0.2.0-preview.1, the historical declaration line. These signatures do not describe the current preview.3 adapter.
Historical declaration compatibility
These declarations describe @answerup/retell@0.2.0-preview.1 with @answerup/runtime@0.2.0-preview.1 and @answerup/actions@0.2.0-preview.2. That older line was not validated against Runtime preview.5 / Actions preview.8. It supplies no executable download or raw Retell declaration download here. Use the current adapter's supplied README for its documented API.
Package-root boundary
ESM · Node >=22
No current adapter import is shown on this historical API page. Follow the current Retell guide and its supplied README.
Public package exports
Consumes bounded Actions results at the adapter boundary. Every export has a stable URL fragment; the versioned declarations define these signatures.
Functions
createRetellAdapterfunction
export declare function createRetellAdapter(options: { readonly actions: ActionsFacade; readonly trustedContextResolver: Function; readonly invocationStore?: unknown; readonly webhookUrlResolver?: Function }): RetellAdapter;Interfaces
ActionsBoundedResultinterface
export interface ActionsBoundedResult { readonly kind: "COMMITTED" | "DISPROVED" | "UNKNOWN" | "NEEDS_CLARIFICATION" | "DENIED" | "INTEGRATION_FAILURE"; readonly claims?: Readonly<{ readonly safeClaims: readonly Readonly<{ readonly claimType: string }>[] }>; readonly clarification?: unknown; }ActionsFacadeinterface
export interface ActionsFacade { readonly getTools: () => readonly ActionsTool[]; readonly run: (request: Readonly<{ readonly action: string; readonly input: unknown; readonly context: unknown }>) => Promise<ActionsBoundedResult>; readonly reconcile: (result: ActionsBoundedResult) => Promise<ActionsBoundedResult>; }ActionsToolinterface
export interface ActionsTool { readonly name: string; readonly version: string; readonly description?: string; readonly inputSchema?: Readonly<Record<string, unknown>>; }RetellAdapterinterface
export interface RetellAdapter { readonly getTools: (config?: unknown) => readonly Readonly<Record<string, unknown>>[]; readonly handleToolCall: (call: RetellCall, hostContext?: unknown) => Promise<RetellResult>; readonly reconcile: (invocationId: string, hostContext?: unknown) => Promise<RetellResult>; readonly conformance: () => Readonly<{ passed: boolean; checks: Readonly<Record<string, boolean>> }> }RetellCallinterface
export interface RetellCall { readonly callId?: string; readonly call_id?: string; readonly toolCallId?: string; readonly tool_call_id?: string; readonly name?: string; readonly args?: unknown; readonly arguments?: unknown; readonly input?: unknown; readonly [key: string]: unknown; }RetellResultinterface
export interface RetellResult { readonly status: string; readonly safeClaims: readonly Readonly<{ readonly claimType: string }>[]; readonly needsClarification: boolean; readonly needsReconciliation: boolean; readonly messageDirective: string; readonly correlation: Readonly<Record<string, unknown>>; readonly diagnosticCode?: string; }Examples and deeper guidance
Executable package pages show a package-specific, non-executing import example. Use the exact declaration surface for signatures and types; no credentials or external execution are provided here.
Read the related lifecycle guidance for the package’s documented role.