API Reference

This section contains the API reference for the Runtimee SDK.

Runtimee

The main entry point for the SDK.

Constructor

new Runtimee(config: RuntimeeConfig)

Parameters

• config: Runtimee configuration object

Returns

A Runtimee instance.

Properties

actors

Type: ActorClient

Provides methods to manage actors and make payments.

ActorClient

Handles actor operations and payments.

Methods

create(params: CreateActorParams): Promise<ActorSummary>

Creates a new actor.

pay(actorId: string, params: PayParams): Promise<ExecutionReceipt>

Sends a payment from the actor.

previewPay(actorId: string, params: PreviewPayParams): Promise<{ decision: string; policyResults: unknown[] }>

Previews whether a payment would be approved.

status(actorId: string): Promise<ActorStatus>

Gets the current status of an actor.

Types

Refer to the Types page for detailed type definitions.