Runtime - PraisonAI

runtime hands the whole turn to a registered runtime instead of running the local chat loop.

Quick Start

Use the builtin runtime

import { Agent } from 'praisonai';

const agent = new Agent({ instructions: 'Delegated', runtime: true });
await agent.chat('Do the work');

runtime: true selects DEFAULT_RUNTIME_ID ('praisonai').

Name a runtime and require capabilities

import { Agent } from 'praisonai';

const agent = new Agent({
  instructions: 'Streamed',
  runtime: { runtime: 'praisonai', requiredCapabilities: ['streaming'] },
});

`AgentRuntimeConfig`

Field	Type	Notes
`runtime`	`string`	Runtime id. Defaults to `DEFAULT_RUNTIME_ID` (`'praisonai'`).
`requiredCapabilities`	`string[]`	Checked before the agent is built; a missing capability throws.
`configOverrides`	`Record<string, unknown>`	Runtime-specific options forwarded on every turn.
`metadata`	`Record<string, unknown>`	Free-form metadata.

runtime accepts true, a string id, an AgentRuntimeConfig object (snake_case keys accepted), or an object that already satisfies AgentRuntimeProtocol.

When it throws

# a required capability the runtime does not report
Error: Runtime 'praisonai' does not provide the required capability: streaming.
  It reports: (none).

# runtime combined with backend or runOn (both say where the loop runs)
TypeError: Agent(runtime, backend/runOn) sets where the loop runs twice. ...

# an invalid runtime type
TypeError: Invalid runtime type: number. Expected boolean, string, object, or an AgentRuntimeProtocol instance.

runtime and backend / runOn answer the same question — where the loop runs — so naming both is rejected as a contradiction.

Reading the resolved runtime

import { Agent } from 'praisonai';

const agent = new Agent({ instructions: 'x', runtime: true });
console.log(agent.getRuntime()); // the resolved runtime, or undefined

Placement

backend / runOn / toolsRunOn

Agent

Constructor options

​Quick Start

​AgentRuntimeConfig

​When it throws

​Reading the resolved runtime

​Related