Skip to main content

Run

@forge/monorepo


@forge/monorepo / backend/src / Run

Type Alias: Run

Run = object

Defined in: backend/src/runtime/index.ts:110

Properties

agentId

readonly agentId: AgentId

Defined in: backend/src/runtime/index.ts:115


agentVersion

readonly agentVersion: number

Defined in: backend/src/runtime/index.ts:116


cancelRequestedAt?

readonly optional cancelRequestedAt?: string

Defined in: backend/src/runtime/index.ts:137

Set when a cancel was requested; the owning worker observes it and stops. Durable so a cancel issued to one process is honored by whichever worker holds the run.


claimedBy?

readonly optional claimedBy?: string

Defined in: backend/src/runtime/index.ts:131

Identifies the worker holding the claim; used to reap stale streams.


conversationId?

readonly optional conversationId?: ConversationId

Defined in: backend/src/runtime/index.ts:114

Absent for a run that belongs to no conversation — see NewRun.conversationId (#198).


createdAt

readonly createdAt: string

Defined in: backend/src/runtime/index.ts:126


error?

readonly optional error?: PlatformError

Defined in: backend/src/runtime/index.ts:129


finishedAt?

readonly optional finishedAt?: string

Defined in: backend/src/runtime/index.ts:128


id

readonly id: RunId

Defined in: backend/src/runtime/index.ts:111


input?

readonly optional input?: unknown

Defined in: backend/src/runtime/index.ts:118

What this run was asked to do, for a run with no conversation to read — see NewRun.input (#202).


keepaliveAt?

readonly optional keepaliveAt?: string

Defined in: backend/src/runtime/index.ts:132


leaseExpiresAt?

readonly optional leaseExpiresAt?: string

Defined in: backend/src/runtime/index.ts:134

When the current claim's lease expires. A past value marks the run reclaimable.


limits?

readonly optional limits?: object

Defined in: backend/src/runtime/index.ts:120

Per-run ceilings from admission, overriding the manifest's — see NewRun.limits (#202).

costCeilingMinorUnits?

readonly optional costCeilingMinorUnits?: number

maxSteps?

readonly optional maxSteps?: number

wallClockTimeoutMs?

readonly optional wallClockTimeoutMs?: number


principalId?

readonly optional principalId?: PrincipalId

Defined in: backend/src/runtime/index.ts:145

The caller this run was admitted for — #164.

Absent for runs created before this was recorded, and for a caller that did not supply it. That absence is deliberately visible rather than defaulted: buildContext substituting an identity is the bug this exists to end, and a default here would move the substitution one layer down where it is harder to see.


roleIds?

readonly optional roleIds?: readonly string[]

Defined in: backend/src/runtime/index.ts:146


startedAt?

readonly optional startedAt?: string

Defined in: backend/src/runtime/index.ts:127


status

readonly status: RunStatus

Defined in: backend/src/runtime/index.ts:125


tenantId

readonly tenantId: TenantId

Defined in: backend/src/runtime/index.ts:112