Go SDK symbol index

This index is derived only from the declared public sdk/go source files. It lists documented public declarations and methods in github.com/0x63616c/agent-runtime/sdk/go (package agentruntime); it does not claim runtime availability beyond the current public contract.

Kind	Symbol	Documentation
type	AgentID	AgentID identifies an Agent without carrying tenancy or routing information.
method	AgentID.LogValue	LogValue returns a redacted Agent ID for structured logs.
method	AgentID.MarshalJSON	MarshalJSON encodes a validated Agent ID.
method	AgentID.Redacted	Redacted returns a safe diagnostic Agent ID.
method	AgentID.String	String returns the canonical Agent ID.
method	AgentID.UnmarshalJSON	UnmarshalJSON decodes and validates an Agent ID.
type	AgentRevisionID	AgentRevisionID identifies one immutable Agent specification revision.
method	AgentRevisionID.LogValue	LogValue returns a redacted Agent revision ID for structured logs.
method	AgentRevisionID.MarshalJSON	MarshalJSON encodes a validated Agent revision ID.
method	AgentRevisionID.Redacted	Redacted returns a safe diagnostic Agent revision ID.
method	AgentRevisionID.String	String returns the canonical Agent revision ID.
method	AgentRevisionID.UnmarshalJSON	UnmarshalJSON decodes and validates an Agent revision ID.
type	AgentSpecification	AgentSpecification is one immutable, versioned definition of Agent behavior.
method	AgentSpecification.Clone	Clone returns an independent Agent specification snapshot.
type	Approval	Approval is a caller-safe immutable projection of a pending or terminal human decision.
method	Approval.Clone	Clone returns an independent Approval snapshot.
type	ApprovalAction	ApprovalAction is the fixed, human-readable description of an elevated operation. It deliberately contains no raw model arguments or credentials.
const	ApprovalApproved	ApprovalApproved records an owner decision that created a bounded internal grant.
const	ApprovalCancelled	ApprovalCancelled records that its owning Turn was cancelled before a decision. It can never create or preserve a grant.
const	ApprovalDenied	ApprovalDenied records an owner decision that forbids the requested effect.
const	ApprovalExpired	ApprovalExpired records that the decision window elapsed before a decision.
type	ApprovalID	ApprovalID identifies one owner-actionable Approval request.
method	ApprovalID.LogValue	LogValue returns a redacted Approval ID for structured logs.
method	ApprovalID.MarshalJSON	MarshalJSON encodes a validated Approval ID.
method	ApprovalID.Redacted	Redacted returns a safe diagnostic Approval ID.
method	ApprovalID.String	String returns the canonical Approval ID.
method	ApprovalID.UnmarshalJSON	UnmarshalJSON decodes and validates an Approval ID.
type	ApprovalPage	ApprovalPage is one bounded owner-scoped Approval inbox projection.
method	ApprovalPage.Clone	Clone returns an independent Approval inbox snapshot.
const	ApprovalPending	ApprovalPending awaits an owner decision before any tool execution may be authorized.
type	ApprovalScope	ApprovalScope is the public bounded-use projection of a proposed capability. Capability bytes and digests never cross this boundary.
type	ApprovalState	ApprovalState is the public lifecycle state of one human decision request.
type	ArtifactDownload	ArtifactDownload is one authorized immutable artifact read. It contains metadata chosen by runtime state and bounded bytes, never a storage URL.
method	ArtifactDownload.Clone	Clone returns an independent authorized artifact read.
type	ArtifactID	ArtifactID identifies an authorized immutable Artifact reference.
method	ArtifactID.LogValue	LogValue returns a redacted Artifact ID for structured logs.
method	ArtifactID.MarshalJSON	MarshalJSON encodes a validated Artifact ID.
method	ArtifactID.Redacted	Redacted returns a safe diagnostic Artifact ID.
method	ArtifactID.String	String returns the canonical Artifact ID.
method	ArtifactID.UnmarshalJSON	UnmarshalJSON decodes and validates an Artifact ID.
type	ArtifactPage	ArtifactPage is one bounded owner-scoped Artifact index for a Session. It exposes immutable metadata only; Artifact bytes require ReadArtifact or OpenArtifact and are authorized again for the exact caller.
method	ArtifactPage.Clone	Clone returns an independent ArtifactPage snapshot.
type	ArtifactReference	ArtifactReference identifies immutable content without exposing a storage URL.
type	ArtifactStream	ArtifactStream is an authorized immutable Artifact transfer. Callers must Close it; reading to EOF verifies the HTTP Digest trailer and exact size.
type	ArtifactStreamer	ArtifactStreamer is the additive streaming Artifact capability. It remains separate from RuntimeClient so existing RuntimeClient implementations keep their v1 source compatibility.
method	ArtifactStreamer.OpenArtifact	OpenArtifact opens a caller-authorized Artifact without buffering it.
type	AuthorizationSink	AuthorizationSink accepts one request-scoped bearer credential.
method	AuthorizationSink.SetBearerToken	SetBearerToken accepts one request-scoped bearer credential.
type	CancelSessionRequest	CancelSessionRequest terminally cancels a drained Session.
type	CancelTurnRequest	CancelTurnRequest explicitly cancels one active or queued Turn.
type	CapabilityGrant	CapabilityGrant is a caller-safe projection of bounded grant consumption. It deliberately omits capability bytes, policy digests, and grant identity.
type	Client	Client is the concrete HTTP implementation of RuntimeClient.
method	Client.CancelSession	CancelSession terminally cancels a drained Session.
method	Client.CancelTurn	CancelTurn explicitly requests durable Turn cancellation.
method	Client.CloseSession	CloseSession closes Input admission and drains accepted work.
method	Client.CreateAgent	CreateAgent creates the first immutable Agent revision through the admin surface.
method	Client.CreatePolicy	CreatePolicy creates the first immutable revision of a tenant Policy.
method	Client.CreateSession	CreateSession creates a principal-owned Session pinned to one Agent revision.
method	Client.DecideApproval	DecideApproval records one idempotent owner decision for a pending Approval.
method	Client.Events	Events resumes bounded Product-event observation after an opaque Cursor.
method	Client.GetAgentRevision	GetAgentRevision reads one immutable Agent revision through the admin surface.
method	Client.GetPolicy	GetPolicy reads one immutable Policy revision through the admin surface.
method	Client.IdempotencyStatus	IdempotencyStatus reads the caller-scoped durable status of one mutation key.
method	Client.InspectApproval	InspectApproval returns the caller-authorized state of one Approval.
method	Client.InspectSession	InspectSession returns caller-safe Session state without backend identifiers.
method	Client.InspectToolCalls	InspectToolCalls returns bounded owner-scoped Tool-call lifecycle projections.
method	Client.InspectTurn	InspectTurn returns one caller-safe Turn snapshot.
method	Client.ListApprovals	ListApprovals returns the caller-authorized bounded Approval inbox.
method	Client.ListSessionArtifacts	ListSessionArtifacts returns one bounded owner-scoped Artifact index for a Session without downloading artifact bytes or exposing content storage.
method	Client.OpenArtifact	OpenArtifact opens a bounded Artifact response. Reaching EOF verifies its declared Digest trailer; Close permits cancellation before completion.
method	Client.ReadArtifact	ReadArtifact downloads a Content-Length-bounded immutable response only after the server has authorized the exact tenant/principal/artifact tuple. Call OpenArtifact for a trailer-verified streaming response.
method	Client.ReviseAgent	ReviseAgent creates another immutable Agent revision through the admin surface.
method	Client.RevisePolicy	RevisePolicy creates the next immutable revision of a tenant Policy.
method	Client.SendInput	SendInput idempotently admits bounded Input into a Session.
type	ClientConfig	ClientConfig contains every dependency and finite bound required by Client.
type	CloseSessionRequest	CloseSessionRequest stops new admission and drains already accepted Input.
const	ContentArtifact	ContentArtifact refers to authorized immutable content by metadata.
type	ContentPart	ContentPart carries either bounded text or an Artifact reference.
method	ContentPart.Clone	Clone returns an independent content snapshot.
type	ContentPartKind	ContentPartKind identifies one bounded Input content representation.
const	ContentText	ContentText contains bounded UTF-8 text.
type	CreateAgentRequest	CreateAgentRequest registers the first immutable revision of an Agent specification.
type	CreatePolicyRequest	CreatePolicyRequest creates the first immutable revision of a named Policy.
type	CreateSessionRequest	CreateSessionRequest creates a Session pinned to one exact Agent revision.
type	CredentialSource	CredentialSource authorizes one request without exposing credential bytes to Client diagnostics.
method	CredentialSource.Authorize	Authorize applies one request-scoped credential without exposing it to Client diagnostics.
type	Cursor	Cursor identifies an opaque Product-event replay position.
method	Cursor.LogValue	LogValue returns a redacted Product-event Cursor for structured logs.
method	Cursor.MarshalJSON	MarshalJSON encodes a validated Product-event Cursor.
method	Cursor.Redacted	Redacted returns a safe diagnostic Product-event Cursor.
method	Cursor.String	String returns the canonical Product-event Cursor.
method	Cursor.UnmarshalJSON	UnmarshalJSON decodes and validates a Product-event Cursor.
type	DecideApprovalRequest	DecideApprovalRequest idempotently records one owner decision for a pending Approval.
type	Error	Error is a safe runtime-owned command failure suitable for errors.As.
method	Error.Error	Error returns only the stable code and safe bounded message.
type	Event	Event is a bounded, ordered, caller-safe Product event.
const	EventApprovalCancelled	EventApprovalCancelled reports that a pending approval was withdrawn without exposing an action or capability value.
const	EventApprovalExpired	EventApprovalExpired reports a terminal approval expiry without exposing an action or capability value.
const	EventApprovalResolved	EventApprovalResolved reports a terminal approved or denied approval without exposing an action or capability value.
type	EventGap	EventGap explicitly says a requested replay position is no longer available.
type	EventID	EventID identifies one Product event.
method	EventID.LogValue	LogValue returns a redacted Product-event ID for structured logs.
method	EventID.MarshalJSON	MarshalJSON encodes a validated Product-event ID.
method	EventID.Redacted	Redacted returns a safe diagnostic Product-event ID.
method	EventID.String	String returns the canonical Product-event ID.
method	EventID.UnmarshalJSON	UnmarshalJSON decodes and validates a Product-event ID.
const	EventInputAccepted	EventInputAccepted reports durable idempotent Input admission.
type	EventKind	EventKind identifies a stable Product-event vocabulary entry.
type	EventPage	EventPage is one bounded replay page and its next opaque position.
const	EventProducerGap	EventProducerGap reports that a producer outcome could not be recovered and the following terminal event is the durable finalization boundary.
const	EventSandboxOperationFinalized	EventSandboxOperationFinalized reports that a sandbox-backed operation reached a durable terminal outcome. Backend handles remain private.
const	EventSessionCancelled	EventSessionCancelled reports a terminal caller-requested Session cancellation.
const	EventSessionClosing	EventSessionClosing reports that no new Input is accepted while queued work drains.
const	EventSessionCompleted	EventSessionCompleted reports a terminal drained Session.
const	EventSessionCreated	EventSessionCreated reports durable Session creation.
const	EventSessionFailed	EventSessionFailed reports a terminal runtime-owned Session failure.
const	EventTurnCancelled	EventTurnCancelled reports one terminal cancelled outcome.
const	EventTurnFailed	EventTurnFailed reports one terminal safe Failure outcome.
const	EventTurnQueued	EventTurnQueued reports a Turn ordered behind active work.
const	EventTurnStarted	EventTurnStarted reports that a Turn became active.
const	EventTurnSucceeded	EventTurnSucceeded reports one terminal successful outcome.
type	Failure	Failure is a bounded, provider-neutral terminal Turn failure.
method	Failure.Clone	Clone returns an independent Failure snapshot.
type	FailureCode	FailureCode is a stable runtime-owned failure classification.
const	FailureConflict	FailureConflict means an idempotency key or state transition conflicted.
const	FailureInternal	FailureInternal means the runtime failed without exposing backend details.
const	FailureInvalidInput	FailureInvalidInput means a request violated the public contract.
const	FailureNotFound	FailureNotFound safely covers absent or unauthorized resources.
const	FailureUnavailable	FailureUnavailable means durable progress may be retried later.
type	IdempotencyStatus	IdempotencyStatus is the safe durable outcome lookup for one exact caller scope and idempotency key. It never exposes request bytes or backend IDs.
type	Input	Input is an immutable accepted Input snapshot.
method	Input.Clone	Clone returns an independent Input snapshot.
type	InputID	InputID identifies one accepted Input.
method	InputID.LogValue	LogValue returns a redacted Input ID for structured logs.
method	InputID.MarshalJSON	MarshalJSON encodes a validated Input ID.
method	InputID.Redacted	Redacted returns a safe diagnostic Input ID.
method	InputID.String	String returns the canonical Input ID.
method	InputID.UnmarshalJSON	UnmarshalJSON decodes and validates an Input ID.
const	MaxApprovalsPerPage	MaxApprovalsPerPage bounds one owner-scoped approval inbox response.
const	MaxArtifactBytes	MaxArtifactBytes is the largest immutable Artifact the public runtime contract can retain and serve. Applications that use ArtifactStreamer must admit this complete contract size by default rather than failing a valid large result at the client boundary.
const	MaxArtifactsPerSession	MaxArtifactsPerSession bounds one owner-scoped Session Artifact index response.
const	MaxIdempotencyKeyBytes	MaxIdempotencyKeyBytes bounds one public idempotency key before transport-specific limits apply.
const	MaxInputParts	MaxInputParts bounds the number of public Input parts accepted in one request.
const	MaxSessionViewQueuedTurns	MaxSessionViewQueuedTurns bounds the queued Turns included in one Session inspection.
const	MaxTextPartBytes	MaxTextPartBytes bounds one public text Input part.
const	MaxToolCallsPerTurn	MaxToolCallsPerTurn bounds one public Tool-call inspection response.
type	ModelUsage	ModelUsage retains provider-neutral token accounting for the latest recorded model invocation. Nil values remain unknown; they are never coerced to zero.
method	ModelUsage.Clone	Clone returns an independent ModelUsage snapshot.
func	NewClient	NewClient validates a bounded, explicit public HTTP client configuration.
func	NewStaticBearerCredential	NewStaticBearerCredential validates and owns a copy of one bearer token.
func	ParseAgentID	ParseAgentID validates an externally supplied Agent ID.
func	ParseAgentRevisionID	ParseAgentRevisionID validates an externally supplied Agent revision ID.
func	ParseApprovalID	ParseApprovalID validates an externally supplied Approval ID.
func	ParseArtifactID	ParseArtifactID validates an externally supplied Artifact ID.
func	ParseCursor	ParseCursor validates an externally supplied Product-event Cursor.
func	ParseEventID	ParseEventID validates an externally supplied Product-event ID.
func	ParseInputID	ParseInputID validates an externally supplied Input ID.
func	ParseRequestID	ParseRequestID validates an externally supplied request correlation ID.
func	ParseSessionID	ParseSessionID validates an externally supplied Session ID.
func	ParseTurnID	ParseTurnID validates an externally supplied Turn ID.
type	Policy	Policy is one immutable, versioned tenant authorization policy. Tool execution consumes its durable revision digest; it never receives policy administration authority.
method	Policy.Clone	Clone returns an independent immutable Policy snapshot.
type	PolicyDecision	PolicyDecision is the closed disposition an immutable Policy revision gives one named Tool. It conveys no credential or executable capability.
const	PolicyDenied	PolicyDenied prevents the named Tool from receiving execution authority.
const	PolicyRequiresApproval	PolicyRequiresApproval requires a later durable human decision before the named Tool can receive a bounded capability grant.
type	PolicyRule	PolicyRule is one bounded, model-independent authorization rule for a named Tool.
type	RequestID	RequestID correlates one HTTP attempt without identifying durable work.
method	RequestID.LogValue	LogValue returns a redacted request correlation ID for structured logs.
method	RequestID.MarshalJSON	MarshalJSON encodes a validated request correlation ID.
method	RequestID.Redacted	Redacted returns a safe diagnostic request correlation ID.
method	RequestID.String	String returns the canonical request correlation ID.
method	RequestID.UnmarshalJSON	UnmarshalJSON decodes and validates a request correlation ID.
type	RequestIDSource	RequestIDSource creates a fresh opaque correlation ID for each HTTP attempt.
method	RequestIDSource.NextRequestID	NextRequestID creates one fresh opaque correlation ID.
type	ReviseAgentRequest	ReviseAgentRequest creates another immutable revision of an existing Agent.
type	RevisePolicyRequest	RevisePolicyRequest creates the next immutable revision of one named Policy.
type	RuntimeClient	RuntimeClient is the Temporal-free application contract for durable Agent Runtime commands.
method	RuntimeClient.CancelTurn	CancelTurn explicitly requests durable Turn cancellation.
method	RuntimeClient.CloseSession	CloseSession closes Input admission and drains accepted work.
method	RuntimeClient.CreateAgent	CreateAgent creates the first immutable Agent revision through the admin surface.
method	RuntimeClient.CreatePolicy	CreatePolicy creates the first immutable revision of a tenant Policy.
method	RuntimeClient.CreateSession	CreateSession creates a principal-owned Session pinned to one Agent revision.
method	RuntimeClient.DecideApproval	DecideApproval records one idempotent owner decision for a pending Approval.
method	RuntimeClient.Events	Events resumes bounded Product-event observation after an opaque Cursor.
method	RuntimeClient.GetAgentRevision	GetAgentRevision reads one immutable Agent revision through the admin surface.
method	RuntimeClient.GetPolicy	GetPolicy reads one immutable Policy revision through the admin surface.
method	RuntimeClient.IdempotencyStatus	IdempotencyStatus reads one retained receipt without re-executing work.
method	RuntimeClient.InspectApproval	InspectApproval returns the caller-authorized state of one Approval.
method	RuntimeClient.InspectSession	InspectSession returns caller-safe Session state without backend identifiers.
method	RuntimeClient.InspectTurn	InspectTurn returns one caller-safe Turn snapshot.
method	RuntimeClient.ListApprovals	ListApprovals returns the caller-authorized bounded Approval inbox.
method	RuntimeClient.ReadArtifact	ReadArtifact downloads one caller-authorized immutable artifact.
method	RuntimeClient.ReviseAgent	ReviseAgent creates another immutable Agent revision through the admin surface.
method	RuntimeClient.RevisePolicy	RevisePolicy creates the next immutable revision of a tenant Policy.
method	RuntimeClient.SendInput	SendInput idempotently admits bounded Input into a Session.
type	SendInputRequest	SendInputRequest idempotently submits bounded content to a Session.
type	SendInputResult	SendInputResult identifies both the accepted Input and its exactly-one Turn.
type	Session	Session is an immutable caller snapshot of a durable Session.
type	SessionArtifactLister	SessionArtifactLister is the additive public capability for discovering a caller’s immutable artifacts for one exact Session.
method	SessionArtifactLister.ListSessionArtifacts	ListSessionArtifacts returns bounded metadata only; bytes require a separate caller-authorized Artifact read.
const	SessionCancelled	SessionCancelled ended through explicit cancellation.
type	SessionCanceller	SessionCanceller is the additive public capability for caller-owned cancellation of a drained Session. It remains separate from RuntimeClient so existing v1 client implementations keep their source compatibility.
method	SessionCanceller.CancelSession	CancelSession terminally cancels a drained Session.
const	SessionClosing	SessionClosing drains already accepted Input and rejects new Input.
const	SessionCompleted	SessionCompleted has drained its accepted work.
const	SessionFailed	SessionFailed ended because the runtime could not safely continue.
type	SessionID	SessionID identifies a durable Session.
method	SessionID.LogValue	LogValue returns a redacted Session ID for structured logs.
method	SessionID.MarshalJSON	MarshalJSON encodes a validated Session ID.
method	SessionID.Redacted	Redacted returns a safe diagnostic Session ID.
method	SessionID.String	String returns the canonical Session ID.
method	SessionID.UnmarshalJSON	UnmarshalJSON decodes and validates a Session ID.
const	SessionOpen	SessionOpen accepts Input and may run a Turn.
type	SessionState	SessionState is the durable lifecycle state of a Session.
type	SessionView	SessionView contains only runtime-owned public Session state and references.
method	SessionView.Clone	Clone returns an independent Session inspection snapshot.
type	StaticBearerCredential	StaticBearerCredential is a redacted in-memory credential adapter for explicitly supplied tokens.
method	StaticBearerCredential.Authorize	Authorize applies the credential to one request-scoped sink.
method	StaticBearerCredential.GoString	GoString keeps detailed formatter diagnostics secret-safe.
method	StaticBearerCredential.String	String returns a secret-safe credential diagnostic.
type	ToolCall	ToolCall is a caller-safe model intent and its derived authorization/execution state.
method	ToolCall.Clone	Clone returns an independent ToolCall snapshot.
const	ToolCallAuthorized	ToolCallAuthorized has a bounded capability grant but no execution outcome.
const	ToolCallAwaitingApproval	ToolCallAwaitingApproval awaits a permitted human decision.
const	ToolCallExecuting	ToolCallExecuting has committed a capability-bound execution intent.
const	ToolCallFailed	ToolCallFailed has a durable terminal safe failure.
type	ToolCallInspector	ToolCallInspector is the additive public capability for owner-scoped Tool-call inspection.
method	ToolCallInspector.InspectToolCalls	InspectToolCalls returns bounded safe Tool intent, approval, grant, and execution projections.
const	ToolCallIntent	ToolCallIntent records model intent without execution authority.
type	ToolCallPage	ToolCallPage is one bounded owner-scoped Tool-call inspection result.
method	ToolCallPage.Clone	Clone returns an independent ToolCallPage snapshot.
type	ToolCallState	ToolCallState is the safe public lifecycle of one model Tool intent.
const	ToolCallSucceeded	ToolCallSucceeded has a durable terminal successful observation.
const	ToolCallUncertain	ToolCallUncertain has an unresolved external-effect outcome.
type	ToolDefinition	ToolDefinition describes model-visible intent without granting execution authority.
type	ToolExecution	ToolExecution is a caller-safe terminal or in-progress tool observation.
method	ToolExecution.Clone	Clone returns an independent ToolExecution snapshot.
type	Turn	Turn is an immutable snapshot of one durable progression from Input to outcome.
method	Turn.Clone	Clone returns an independent Turn snapshot.
const	TurnCancelled	TurnCancelled completed after explicit cancellation.
const	TurnFailed	TurnFailed completed with a safe Failure.
type	TurnID	TurnID identifies one durable Turn.
method	TurnID.LogValue	LogValue returns a redacted Turn ID for structured logs.
method	TurnID.MarshalJSON	MarshalJSON encodes a validated Turn ID.
method	TurnID.Redacted	Redacted returns a safe diagnostic Turn ID.
method	TurnID.String	String returns the canonical Turn ID.
method	TurnID.UnmarshalJSON	UnmarshalJSON decodes and validates a Turn ID.
const	TurnQueued	TurnQueued is durably ordered behind an active Turn.
const	TurnRunning	TurnRunning is the only Turn currently allowed to progress a Session.
type	TurnState	TurnState is the durable lifecycle state of one Turn.
const	TurnSucceeded	TurnSucceeded completed successfully.
const	TurnWaitingForApproval	TurnWaitingForApproval has durably paused one active Turn at a bounded human-approval boundary. It is non-terminal and remains cancellable.