Skip to content

API

Every object marked @agent_facing in the τ source, grouped by topic. This is the surface an extension author or an agent calls; it is generated from the docstrings, so a page here is as current as the code it was built from.

Generated

Built from τ 0.9.7 by scripts/export_site_reference.py in the τ repository. Of the 924 marked objects, 481 (52.1%) document every parameter and every return value. The rest appear here with whatever they carry — omitting them would make this page quietly incomplete instead of visibly so.

The prose pages one level up say how the packages fit together; these say what each name is.

Page Defines
Messages and content AssistantMessage, Attachment, AttachmentCompletions, ImageContent, Model, PathCompletion, RenderedAttachments, TextContent, ThinkingContent, ToolCall, ToolResultMessage, Usage, UserMessage, clamp_thinking_level, complete_attachment, elide_attachment_bodies, get_supported_thinking_levels, is_valid_thinking_level, remove_attachment, render_attachments, scan_attachments
Providers and the client AbortSignal, ApiFactory, AssistantMessageEventStream, Compat, DoneEvent, ErrorEvent, Provider, ProviderSpec, ResolvedCompat, StreamEventStream, TextDeltaEvent, ThinkingDeltaEvent, ToolCallDeltaEvent, aclose_providers, complete_simple, detect_compat, get_api_factory, get_provider_spec, register_api, register_provider, registered_apis, registered_providers, resolve_compat, split_tool_result_content, stream_simple, unregister_api, unregister_provider
Constrained decoding ConstraintViolation, DecodeConstraints
Tools AgentTool, AgentToolResult, ExtensionToolDefinition, ToolBatchResult, tau_agent_core.tools.base.ToolDefinition, tau_llm.tools.ToolDefinition, ToolSpec, define_tool, validate_tool_arguments
The agent loop AgentLoop, AgentLoopConfig, BlockedCall, ErrorCall, FinalizedToolCall, PreparedToolCall, completed_messages
Sessions and the conversation tree AgentSession, Argument, BranchPlan, BranchSummary, BranchView, Capability, CloneResult, CompactionEntry, CompactionRecord, ConversationSession, ConversationTree, CustomMessageEntry, Domain, DomainValue, DomainValues, ExtensionActionResult, ExtensionCommandResult, Flow, FlowStep, ForkResult, InMemorySessionLog, MessageEntry, MessageIdCompletion, MessageIdMatch, PasteMint, PastePlan, Performed, Ready, SessionCatalog, SessionEntry, tau_agent_core.session.SessionInfo, tau_agent_core.session_catalog.SessionInfo, tau_agent_core.session_manager.SessionInfo, SessionLog, SessionManager, tau_agent_core.session.SessionState, tau_agent_core.session_manager.SessionState, SessionStats, ToolResultEntry, TreeNode, View, admission_reason, agent_spec_in_force, bind_command_args, bind_text, branch_refusal_reason, commit_branch, copy_of, elide_span, entries_to_messages, enumerate_domain, flow_arguments, flow_form_spec, last_assistant_text, navigate, next_step, open_branch, paste_refusal_reason, paste_subtree, plan_branch, plan_paste, planned_messages, resolve_cursor, selection_order, session_log_is_addressable, slash_vocabulary, summarize_and_navigate, summarize_branch, tool_group
Events AgentEvent, EventBus
The SDK entry point ContextFile, ContextFileError, Settings, SystemPromptFieldError, append_system_prompt, create_agent_session, load_project_context_files, resolve_model
Extensions BranchResult, ExtensionAPI, ExtensionCapabilityError, ExtensionContext, ExtensionInfo, ExtensionLoadError, ExtensionUI, HeadlessDialogError, LoadExtensionsResult, LoadedExtension, apply_session_name, ext_channel, form_headless_value, read_session_name, summarize_extensions, validate_form_spec, validate_form_values, validate_panel_spec
Compaction CompactionDetails, CompactionError, CompactionPolicy, CompactionPolicyError, CompactionPolicyViolation, CompactionPreparation, CompactionResult, CompactionSettings, ContextUsageEstimate, calculate_context_tokens, compact, estimate_context_tokens, estimate_span_tokens, estimate_tokens, policy_for_scenario, prepare_compaction, should_compact
The RPC protocol RPCEvent, RPCHandler, RPCRequest, RPCResponse
Export ExportConfig, HTMLExporter, MarkdownExporter, export_session
Run manifests and latency PromptLatencyCollector, PromptLatencySample, build_run_manifest, extension_manifest_entries, require_compaction_policy, summarize, write_run_manifest