CreateRuntimeOptions — @personaai/runtime
Generated field table for CreateRuntimeOptions — do not edit
Generated from
sdk/runtime/dist/typedoc.json— do not edit.
CreateRuntimeOptions
Source: types/options.ts:99
Interface
| Field | Type | Description |
|---|---|---|
baseUrl | string | Base URL of the Persona Developer Platform API, e.g. "". — _ types/options.ts:101_ |
credential | string | Project credential, shaped "." — never expose this to a browser. — _ types/options.ts:103_ |
resolveUser | ResolveUser | — _ types/options.ts:104_ |
hooks? | RuntimeHooks | — _ types/options.ts:105_ |
mountPath? | string | Prefix to strip from request.path before routing, e.g. '/api/persona'. — _ types/options.ts:107_ |
mode? | "development" | "production" | 'development' includes error detail (message/stack/upstream response) in error responses; 'production' hides it behind a generic message. — _ types/options.ts:113_ |
fetch? | object | Override fetch (proxying, tracing, or test injection). Forwarded to every per-request PersonaClient. — _ types/options.ts:115_ |
heartbeatIntervalMs? | number | How often to send an SSE comment-line heartbeat (: heartbeat\n\n) during a gap in the /chat stream — e.g. a long-running tool call with no token output — so intermediary proxies/load balancers with an idle timeout don't kill the connection. Comment lines are invisible to any data:-only SSE parser (including @personaai/sdk's own), so this never changes the AG-UI event sequence a consumer sees. — _ types/options.ts:125_ |
runGraceMs? | number | How long a finished /chat run stays resumable via GET /chat/:runId/resume before an internal eviction sweep removes it. — _ types/options.ts:131_ |
maxTrackedRuns? | number | Safety valve on the in-memory resumable-run registry — once over this many tracked runs, the oldest-finished ones are evicted first (still in-flight runs are never evicted by this cap). — _ types/options.ts:138_ |
capabilities? | RuntimeCapabilities | Opt-in switches for Project-level admin surface. See RuntimeCapabilities — everything defaults to off. — _ types/options.ts:140_ |
restToolsManifest? | RestToolsManifestOptions | Serves a code-defined REST tool list for a Persona REST Tool Source to discover. See RestToolsManifestOptions. Unset by default — the route only exists when this is provided. — _ types/options.ts:142_ |
rcpManifest? | RcpManifestOptions | Serves a conformant RCP manifest for any RCP client to discover. See RcpManifestOptions. Unset by default — the route only exists when this is provided. — _ types/options.ts:144_ |
logLevel? | LogLevel | Log level for the runtime — off by default. Overrides the global level set via setLogLevel() from @personaai/sdk. — _ types/options.ts:146_ |
logger? | Logger | Custom logger instance — when provided, logLevel is ignored. — _ types/options.ts:148_ |