Skip to content

rulvar API reference


rulvar API reference / @rulvar/rulvar / UsageLimits

Interface: UsageLimits

Defined in: packages/core/dist/index.d.ts

UsageLimits (M1-T06): normative limit vocabulary and the per-spawn merge.

Full contract: https://docs.rulvar.com/guide/agents. Expiry of maxTurns, maxToolCalls, or timeoutMs produces the terminal status 'limit' (paid partial work); streamIdleTimeoutMs expiry is a retryable transport-class AgentError, never 'limit'. The run-level deadline is RunOptions.deadlineAt, not a UsageLimits field.

Properties

PropertyTypeDescriptionDefined in
maxOutputTokensPerTurn?numberUnlimited by default (model caps still apply).packages/core/dist/index.d.ts
maxToolCalls?numberUnlimited by default.packages/core/dist/index.d.ts
maxTurns?numberDefault 32.packages/core/dist/index.d.ts
noProgressTurns?numberThe no-progress detector N (committed at 3): consecutive turns without tool calls or artifact deltas before the engine aborts with the dedicated class (M3-T08).packages/core/dist/index.d.ts
streamIdleTimeoutMs?numberGap between stream events; default 120000.packages/core/dist/index.d.ts
timeoutMs?numberPer-agent wall clock; unlimited by default.packages/core/dist/index.d.ts