api

package

Go to main page

Versions in this module

v0

v0.3.0

Oct 22, 2026

Changes in this version

+ var ErrCheckpointPending = errors.New("runtime: checkpoint upload is pending")

+ var ErrComputeBusy = errors.New("runtime: compute is busy with another operation")

+ var ErrInvalidCallerIdentity = errors.New("api: caller identity requires issuer and subject")

+ var ErrInvalidCheckpoint = errors.New("runtime: checkpoint does not meet the required contract")

+ var ErrInvalidModelPolicy = errors.New("model policy requires an explicit allowed default and nonempty model IDs")

+ var ErrMemoryStateLost = errors.New("runtime: session's in-memory harness state is lost")

+ var ErrModelNotAllowed = errors.New("model is not allowed by the host policy")

+ var ErrPermissionDenied = errors.New("api: permission denied")

+ type Action string

+ const ActionApprove

+ const ActionCancel

+ const ActionCreate

+ const ActionDelete

+ const ActionExec

+ const ActionFork

+ const ActionList

+ const ActionMint

+ const ActionRead

+ const ActionRegistryList

+ const ActionRegistryRead

+ const ActionRegistryRegister

+ const ActionRegistryRetire

+ const ActionResume

+ const ActionSuspend

+ type AuthorizationRequest struct

+ Action Action

+ Caller CallerIdentity

+ Method string

+ Owner CallerIdentity

+ SessionUID string

+ type Authorizer interface

+ Authorize func(context.Context, AuthorizationRequest) error

+ type CallerIdentity struct

+ Issuer string

+ Subject string

+ func (c CallerIdentity) Valid() bool

type ExecutionStart

+ ComputeInstance string

+ Model string

type Incarnation

+ ComputeInstance string

+ RecordedCheckpoint SnapshotRef

+ type InstanceRestorer interface

+ RestoreInstance func(ctx context.Context, ref SnapshotRef, recorded func() (string, error)) (Incarnation, error)

type Lifecycle

+ ComputeInstance string

+ type ModelPolicy struct

+ Allowed []string

+ Default string

+ func (p ModelPolicy) Resolve(model string) (string, error)

+ func (p ModelPolicy) ValidateDescriptor(desc Descriptor) error

+ type OwnerAllowlistAuthorizer struct

+ Allow map[Action][]CallerIdentity

+ func (p OwnerAllowlistAuthorizer) Authorize(ctx context.Context, r AuthorizationRequest) error

+ type OwnerAuthorizer struct

+ func (OwnerAuthorizer) Authorize(ctx context.Context, r AuthorizationRequest) error

type SessionSpec

+ RecordedCheckpoint func() (SnapshotRef, error)

+ StartedTurns func() (int, error)

type Start

+ Model string

v0.2.0

Oct 16, 2026

Changes in this version

+ var ErrApprovalParked = errors.New("approval parked")

+ var ErrSnapshotSuperseded = errors.New("runtime: fork source snapshot was superseded")

+ func IsParkUnwind(err error, ref ApprovalRef) bool

+ type ApprovalDecision struct

+ Approved bool

+ ExecutionID string

+ Identity IdentityRef

+ Reason string

+ RequestSeq int64

+ ToolCallID string

+ type ApprovalParkedError struct

+ Ref ApprovalRef

+ func (e *ApprovalParkedError) Error() string

+ func (e *ApprovalParkedError) Unwrap() error

+ type ApprovalRef struct

+ ExecutionID string

+ RequestSeq int64

+ ToolCallID string

+ type ApprovalRequest struct

+ Reason string

+ ToolCallID string

+ type ApprovalResult struct

+ Approved bool

+ Reason string

+ RequestSeq int64

+ ToolCallID string

+ type Capabilities struct

+ ForkSafe bool

+ ReasoningReplay bool

+ RequiresGPU bool

+ Resumability Resumability

+ Streaming bool

+ type ComputeRef struct

+ Attributes map[string]string

+ Capabilities RuntimeCapabilities

+ Runtime string

+ Snapshot *SnapshotRef

+ Worker string

+ type ComputeState string

+ const ComputeCold

+ const ComputeLive

+ const ComputeNone

+ const ComputeTerminated

+ const ComputeWarm

+ type DeletionState string

+ const DeletionActive

+ const DeletionPending

+ type Delta struct

+ Chunk string

+ Done bool

+ ExecutionID string

+ PartIndex int32

+ type Descriptor struct

+ Capabilities Capabilities

+ ID string

+ Models []string

+ Tools []ToolSpec

+ Version string

+ type Error struct

+ Code int32

+ Description string

+ type Event struct

+ Actor IdentityRef

+ Approval *ApprovalRequest

+ ApprovalResult *ApprovalResult

+ End *HarnessEnd

+ Err *Error

+ ExecutionID string

+ ExecutionStart *ExecutionStart

+ Kind EventKind

+ Lifecycle *Lifecycle

+ Message *Message

+ ModelCall *ModelCall

+ Parked *ApprovalRef

+ Result *ToolResult

+ SchemaVersion int32

+ Timestamp time.Time

+ ToolCall *ToolCall

+ Usage *Usage

+ type EventKind string

+ const EventApprovalRequest

+ const EventApprovalResult

+ const EventEnd

+ const EventError

+ const EventExecutionStart

+ const EventInput

+ const EventLifecycle

+ const EventModelCall

+ const EventOutput

+ const EventParked

+ const EventToolCall

+ const EventToolResult

+ const EventUsage

+ type EventSink interface

+ Model func(ctx context.Context, req ModelRequest) (ModelResponse, error)

+ Output func(ctx context.Context, delta string) error

+ Report func(ctx context.Context, tr ToolResult) error

+ ToolCall func(ctx context.Context, tc ToolCall) (ToolResult, error)

+ Usage func(ctx context.Context, u Usage) error

+ type ExecState string

+ const ExecAwaiting

+ const ExecCanceled

+ const ExecCompleted

+ const ExecFailed

+ const ExecPending

+ const ExecRunning

+ type ExecutionStart struct

+ Config []byte

+ Harness string

+ HarnessVersion string

+ InputCount *int64

+ ResumeFromSeq int64

+ type FilePart struct

+ Bytes []byte

+ Digest string

+ MIME string

+ Name string

+ URI string

+ type ForkOpts struct

+ ChildSessionUID string

+ type Harness interface

+ Describe func(ctx context.Context) (Descriptor, error)

+ Run func(ctx context.Context, s *Start, sink EventSink) error

+ type HarnessEnd struct

+ Error *Error

+ State string

+ type IdentityContext struct

+ MintToken TokenMinter

+ Principal IdentityRef

+ type IdentityRef struct

+ Issuer string

+ Principal string

+ Subject string

+ type Incarnation struct

+ Address string

+ CallMetadata map[string]string

+ FenceToken int64

+ ID string

+ Runtime string

+ Worker string

+ type Lifecycle struct

+ Detail string

+ Kind LifecycleKind

+ Snapshot *SnapshotRef

+ type LifecycleKind string

+ const LifecycleBaseline

+ const LifecycleCancel

+ const LifecycleDelete

+ const LifecycleFork

+ const LifecycleResume

+ const LifecycleSuspend

+ type Mediation string

+ const MediationControllerMediated

+ const MediationInHarnessReported

+ const MediationRequiresApproval

+ type Message struct

+ Parts []Part

+ Role string

+ func TextMessage(role, text string) *Message

+ func (m *Message) Text() string

+ type ModelCall struct

+ ID string

+ InputHash string

+ Model string

+ Params map[string]string

+ type ModelRequest struct

+ Messages []Message

+ Model string

+ Params map[string]string

+ ToolChoice *ToolChoice

+ Tools []ToolDefinition

+ type ModelResponse struct

+ Message Message

+ Usage Usage

+ type Origin struct

+ Attributes map[string]string

+ Source string

+ Subject string

+ URI string

+ type Part struct

+ Data map[string]any

+ File *FilePart

+ Reasoning *ReasoningPart

+ Text *TextPart

+ ToolCall *ToolCall

+ ToolResult *ToolResult

+ type ReasoningPart struct

+ ItemID string

+ ModelID string

+ Opaque []byte

+ OpaqueDigest string

+ OpaqueURI string

+ Ordinal int32

+ Provider string

+ Summary []Part

+ ValidityScope string

+ type Resumability string

+ const ResumabilityRequiresMemorySnapshot

+ const ResumabilityStatelessReplay

+ type Runtime interface

+ Capabilities func() RuntimeCapabilities

+ Create func(ctx context.Context, s *SessionSpec) (Incarnation, error)

+ Fork func(ctx context.Context, ref SnapshotRef, opts ForkOpts) (Incarnation, error)

+ Restore func(ctx context.Context, ref SnapshotRef) (Incarnation, error)

+ Snapshot func(ctx context.Context, in Incarnation, kind SnapshotKind) (SnapshotRef, error)

+ Status func(ctx context.Context, in Incarnation) (ComputeState, error)

+ Stop func(ctx context.Context, in Incarnation) error

+ type RuntimeCapabilities struct

+ Attest bool

+ CoWFork bool

+ GPUState bool

+ MemorySnapshot bool

+ type Session struct

+ Annotations map[string]string

+ Compute *ComputeRef

+ ComputeState ComputeState

+ Exec ExecState

+ ForkSeq int64

+ Harness string

+ Identity IdentityRef

+ Labels map[string]string

+ LastSeq int64

+ Model string

+ Name string

+ Origin *Origin

+ ParentUID string

+ Project string

+ UID string

+ type SessionSpec struct

+ Harness string

+ Identity IdentityRef

+ Image string

+ SessionUID string

+ type SnapshotKind string

+ const SnapshotExternal

+ const SnapshotLocal

+ type SnapshotRef struct

+ ExternalURI string

+ Local string

+ Memory bool

+ Sealed bool

+ type Start struct

+ Config []byte

+ ExecutionID string

+ History []Event

+ Identity IdentityContext

+ Inputs []Message

+ ResumeFromSeq int64

+ SessionUID string

+ type TextPart struct

+ Text string

+ type TokenMinter func(ctx context.Context, audience []string) (string, error)

+ type ToolCall struct

+ Args map[string]any

+ ID string

+ IdempotencyKey string

+ Mediation Mediation

+ Tool string

+ type ToolChoice struct

+ Mode ToolChoiceMode

+ Name string

+ type ToolChoiceMode string

+ const ToolChoiceAuto

+ const ToolChoiceNone

+ const ToolChoiceRequired

+ type ToolDefinition struct

+ Description string

+ InputSchema map[string]any

+ Name string

+ type ToolResult struct

+ Approval *ApprovalResult

+ ApprovalDecisionSeq int64

+ ApprovalRequestSeq int64

+ Code ToolResultCode

+ Content []Part

+ Error string

+ ID string

+ IsError bool

+ Output map[string]any

+ OutputDigest string

+ OutputURI string

+ type ToolResultCode int32

+ const ToolResultCodeApprovalDenied

+ const ToolResultCodeExecutorError

+ const ToolResultCodeUnspecified

+ type ToolSpec struct

+ Description string

+ Mediation Mediation

+ Name string

+ type Usage struct

+ InputTokens int64

+ Model string

+ OutputTokens int64

+ ReasoningTokens int64

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL