API reference

• zhivex_ai
• zhivex_ai.workflows
• zhivex_ai.evals
• zhivex_ai.integrations.protocols
• zhivex_ai.integrations.responses
• zhivex_ai.experimental
• zhivex_ai.experimental.providers
• zhivex_ai.experimental.realtime

Documentation artifact

Version 0.24.0 · published · package maturity Beta.

Wheel SHA256: 49cc7344e833ff12c1293b8a5a66f1b306727dddf9ef3bed9deaafc9d966549f. Source: ae0a01c2453be0bda64b3824c88b0995a9a5089c.

These identifiers describe the documented package; site changes do not publish a new SDK release.

Find a public symbol

Filter Python symbols

• A2AAgentCard · Beta
• A2AAgentExecutor · Beta
• A2AAgentSkill · Beta
• A2A_PROTOCOL_VERSION · Beta
• AGENT_EVALUATION_ARTIFACT_SCHEMA_VERSION · Beta
• AGENT_RUN_STATE_SCHEMA_VERSION · Beta
• AGUIEvent · Beta
• Agent · Stable
• AgentCancellationToken · Beta
• AgentCapabilities · Stable
• AgentCheckpoint · Stable
• AgentCheckpointEvent · Beta
• AgentChildRun · Stable
• AgentContext · Stable
• AgentDelegationFinishEvent · Beta
• AgentDelegationStartEvent · Beta
• AgentErrorEvent · Beta
• AgentEvaluationAgentFactory · Beta
• AgentEvaluationCase · Beta
• AgentEvaluationCaseResult · Beta
• AgentEvaluationCostEstimator · Beta
• AgentEvaluationExpectations · Beta
• AgentEvaluationExperimentResult · Beta
• AgentEvaluationFixture · Beta
• AgentEvaluationGate · Beta
• AgentEvaluationGateResult · Beta
• AgentEvaluationJudgeResult · Beta
• AgentEvaluationMetric · Beta
• AgentEvaluationReport · Beta
• AgentEvaluationResult · Beta
• AgentEvaluationScorer · Beta
• AgentEvaluationTraceExpectationsExtractor · Beta
• AgentEvaluationTraceMetadataExtractor · Beta
• AgentEvaluationTraceNameExtractor · Beta
• AgentEvaluationTracePromptExtractor · Beta
• AgentEvaluationTrajectory · Beta
• AgentEvaluationTrajectoryEvent · Beta
• AgentEvaluationTrialResult · Beta
• AgentEvaluationVariant · Beta
• AgentEvaluationVariantResult · Beta
• AgentEvent · Beta
• AgentEventDeliveryError · Stable
• AgentFinishEvent · Beta
• AgentGroupMember · Beta
• AgentGroupMemberResult · Beta
• AgentGroupRunResult · Beta
• AgentGuardrailEvent · Beta
• AgentHandoff · Stable
• AgentHandoffEvent · Beta
• AgentHandoffFailedEvent · Beta
• AgentHandoffRequestedEvent · Beta
• AgentHandoffResolvedEvent · Beta
• AgentHooks · Stable
• AgentLiveEvent · Experimental
• AgentMemoryState · Stable
• AgentMiddleware · Stable
• AgentMiddlewareNext · Stable
• AgentObserver · Stable
• AgentRegistry · Stable
• AgentReplayEvent · Stable
• AgentReplayResult · Stable
• AgentResolver · Beta
• AgentRunCancelled · Stable
• AgentRunRequest · Stable
• AgentRunResult · Stable
• AgentRunSnapshot · Stable
• AgentRunStartEvent · Beta
• AgentRunState · Stable
• AgentRunStatus · Stable
• AgentRunStep · Stable
• AgentRunStore · Stable
• AgentRunTreeCancellationResult · Stable
• AgentRunTreeNode · Beta
• AgentRunTreeSnapshot · Beta
• AgentRuntime · Stable
• AgentSession · Stable
• AgentSkillActivatedEvent · Stable
• AgentSkillArtifactCreatedEvent · Beta
• AgentSkillDependencyCheckEvent · Beta
• AgentSkillExecutionFinishEvent · Beta
• AgentSkillExecutionStartEvent · Beta
• AgentSkillResolvedEvent · Beta
• AgentSkillSkippedEvent · Stable
• AgentStreamResult · Stable
• AgentSummaryUpdateEvent · Beta
• AgentSupportTier · Stable
• AgentTextDeltaEvent · Beta
• AgentToolApprovalEvent · Stable
• AgentToolCallEvent · Beta
• AgentToolResultEvent · Beta
• AgentTrace · Stable
• AgentTraceArtifact · Beta
• AgentTraceCollector · Beta
• AgentTraceSegment · Beta
• AgentTraceStep · Beta
• AgentTraceSummary · Beta
• AnyToolDefinition · Beta
• ApprovalDecision · Stable
• ApprovalPolicyOptions · Beta
• ApprovalPolicyPreset · Beta
• AudioFrame · Beta
• AudioInput · Beta
• AzureOpenAIMcpApprovalRequest · Beta
• AzureOpenAIMcpApprovalResponse · Beta
• AzureOpenAIMcpCall · Beta
• AzureOpenAIMcpListTools · Beta
• AzureOpenAIProviderData · Beta
• AzureOpenAIResponseReference · Beta
• BatchesClient · Beta
• BudgetGuard · Beta
• CachedContent · Beta
• CachedContentListResult · Beta
• CachedContentsClient · Beta
• CallbackWorkflowAdapter · Stable
• CatalogProviderId · Stable
• CircuitBreakerState · Beta
• ConfigurationError · Stable
• ContainersClient · Beta
• ContentPart · Beta
• ConversationsClient · Beta
• CostEstimate · Beta
• CountTokensClient · Beta
• CountTokensResult · Beta
• DynamicInstructions · Stable
• EmbedOutput · Stable
• EmbeddingContent · Stable
• EmbeddingModel · Stable
• EmbeddingPart · Beta
• FilePart · Beta
• FileSearchBatch · Beta
• FileSearchDocument · Beta
• FileSearchDocumentListResult · Beta
• FileSearchOperation · Beta
• FileSearchSearchResult · Beta
• FileSearchStore · Beta
• FileSearchStoreListResult · Beta
• FileSearchStoresClient · Beta
• FilesClient · Beta
• FinishReason · Stable
• GatewayAttempt · Stable
• GatewayConfig · Stable
• GatewayError · Stable
• GatewayImageAttachment · Stable
• GatewayMessage · Stable
• GatewayModelTarget · Stable
• GatewayObjectResponse · Stable
• GatewayResponse · Stable
• GenerateGroundedTextOutput · Stable
• GenerateObjectOutput · Stable
• GenerateResult · Beta
• GenerateTextOutput · Stable
• GeneratedMedia · Beta
• GraphWorkflow · Stable
• GroundedLanguageModel · Stable
• GroundingSource · Beta
• GuardrailResult · Beta
• GuardrailTripwireTriggered · Beta
• HTTPResponse · Stable
• HTTPTransport · Stable
• HierarchicalAgentTrace · Beta
• HierarchicalAgentTraceNode · Beta
• HostedAgentRunOptions · Beta
• HostedToolClass · Beta
• HostedToolDefinition · Beta
• ImagePart · Beta
• ImagesClient · Beta
• ImagesResult · Beta
• InMemoryAgentRunStore · Stable
• InMemoryResponsesEventStore · Beta
• InMemoryWorkflowCheckpointStore · Stable
• InMemoryWorkflowLeaseManager · Stable
• InputGuardrail · Beta
• InputGuardrailRequest · Beta
• InstalledSkill · Beta
• InteractionsClient · Beta
• JsonValue · Stable
• KIMI_OFFICIAL_TOOL_URIS · Beta
• KimiFormulaClient · Beta
• LanguageModel · Stable
• LiveAgentStreamResult · Experimental
• LoopAgent · Stable
• MCPServerConfig · Beta
• MCPToolConfig · Beta
• MediaClient · Beta
• MediaResult · Beta
• MessageRole · Beta
• ModelApiSurface · Stable
• ModelAvailability · Stable
• ModelCapabilities · Stable
• ModelCatalog · Stable
• ModelCatalogEntry · Stable
• ModelGenerateInput · Beta
• ModelMessage · Stable
• ModelPricing · Stable
• ModelSupportEvidence · Stable
• ModerationsClient · Beta
• NativeSupport · Beta
• OTelAgentObserver · Beta
• OpenAIMcpApprovalRequest · Beta
• OpenAIMcpApprovalResponse · Beta
• OpenAIMcpCall · Beta
• OpenAIMcpListTools · Beta
• OpenAIProviderData · Beta
• OpenAIResponseReference · Beta
• OutputGuardrail · Beta
• OutputGuardrailRequest · Beta
• ParallelAgent · Stable
• ParseError · Beta
• PendingApproval · Stable
• PortableDocument · Beta
• PortableGroundingConfig · Beta
• PortableProviderNamespace · Beta
• PortableProviderTier · Beta
• PortableRetrievalConfig · Beta
• PortableSpeechConfig · Beta
• PortableSupport · Beta
• PortableTranscriptionConfig · Beta
• PostgresAgentRunStore · Stable
• PostgresWorkflowCheckpointStore · Stable
• PostgresWorkflowLeaseManager · Stable
• ProtocolErrorMapper · Beta
• ProtocolEventCallback · Beta
• ProtocolInvocation · Beta
• ProtocolLimits · Beta
• ProtocolRunOptionsResolver · Beta
• ProviderBundle · Beta
• ProviderDataPart · Beta
• ProviderFile · Beta
• ProviderHTTPError · Stable
• ProviderImage · Beta
• ProviderSupportRow · Beta
• ProviderUpload · Beta
• ProviderUploadPart · Beta
• RealtimeAudioOutputEvent · Experimental
• RealtimeConnectOptions · Experimental
• RealtimeErrorEvent · Experimental
• RealtimeEvent · Experimental
• RealtimeModel · Experimental
• RealtimeResponseCompletedEvent · Experimental
• RealtimeSession · Experimental
• RealtimeSessionConfig · Experimental
• RealtimeSessionEndedEvent · Experimental
• RealtimeSessionStartedEvent · Experimental
• RealtimeTextDeltaEvent · Experimental
• RealtimeTokenResult · Experimental
• RealtimeToolCallEvent · Experimental
• RealtimeToolResultEvent · Experimental
• RealtimeTranscriptEvent · Experimental
• ReasoningConfig · Beta
• RecommendedUse · Stable
• RedactionPolicy · Beta
• RedactionRule · Beta
• RemoteHTTPToolConfig · Beta
• ResponsesAgentHost · Beta
• ResponsesClient · Beta
• ResponsesEventStore · Beta
• RunLimits · Beta
• SQLiteAgentRunStore · Stable
• SQLiteWorkflowCheckpointStore · Stable
• SQLiteWorkflowLeaseManager · Stable
• SafetyPolicy · Beta
• SafetyPolicyPreset · Beta
• SequentialAgent · Stable
• SkillArtifact · Beta
• SkillDefinition · Stable
• SkillDependency · Stable
• SkillEntrypoint · Beta
• SkillPackageManifest · Beta
• SkillPermissions · Beta
• SkillRegistry · Stable
• SkillRegistryIndex · Beta
• SkillRunResult · Beta
• SkillsClient · Beta
• SpeechModel · Beta
• SpeechOutput · Beta
• StoredResponsesRun · Beta
• StreamEvent · Stable
• StreamFinishEvent · Beta
• StreamObjectResult · Stable
• StreamProviderDataEvent · Beta
• StreamTextDeltaEvent · Beta
• StreamTextResult · Stable
• SummaryConfig · Stable
• TextPart · Beta
• TokenCountDetail · Beta
• TokenPricing · Beta
• TokenUsage · Stable
• ToolApprovalRequest · Stable
• ToolCall · Stable
• ToolChoiceName · Beta
• ToolDefinition · Stable
• ToolExecutionContext · Stable
• ToolExecutionError · Stable
• ToolExecutionOptions · Stable
• ToolExecutionOutcomeUnknown · Stable
• ToolExecutionResult · Stable
• ToolGuardrailResult · Beta
• ToolGuardrailStage · Beta
• ToolGuardrailTripwireTriggered · Beta
• ToolInputGuardrail · Beta
• ToolInputGuardrailRequest · Beta
• ToolOutputGuardrail · Beta
• ToolOutputGuardrailRequest · Beta
• ToolRegistry · Stable
• ToolSet · Stable
• ToolSource · Beta
• TranscriptionModel · Beta
• TranscriptionOutput · Beta
• UIMessage · Beta
• UIMessageChunk · Beta
• UIMessageProviderDataChunk · Beta
• UIMessageToolApprovalChunk · Beta
• UnsupportedFeatureError · Stable
• UploadsClient · Beta
• ValidationError · Stable
• VideoOperation · Beta
• VideoResult · Beta
• VideosClient · Beta
• WORKFLOW_ADAPTER_SCHEMA_VERSION · Stable
• WORKFLOW_CHECKPOINT_SCHEMA_VERSION · Stable
• WorkflowAdapter · Stable
• WorkflowAdapterCapabilities · Stable
• WorkflowAgent · Stable
• WorkflowBuilder · Stable
• WorkflowCheckpoint · Stable
• WorkflowCheckpointMigration · Stable
• WorkflowCheckpointStatus · Stable
• WorkflowCheckpointStore · Stable
• WorkflowConflictError · Stable
• WorkflowContext · Stable
• WorkflowDefinitionMismatchError · Stable
• WorkflowEdge · Stable
• WorkflowEdgeCondition · Stable
• WorkflowErrorPolicy · Stable
• WorkflowExecutionLease · Stable
• WorkflowFunctionContext · Stable
• WorkflowFunctionExecutor · Stable
• WorkflowFunctionResult · Stable
• WorkflowGraph · Stable
• WorkflowInterrupt · Stable
• WorkflowInterruptError · Stable
• WorkflowInterruptPhase · Stable
• WorkflowLeaseLostError · Stable
• WorkflowLeaseManager · Stable
• WorkflowNodeCheckpoint · Stable
• WorkflowNodeStatus · Stable
• WorkflowRetryPolicy · Stable
• WorkflowRetryPredicate · Stable
• WorkflowRunNotFoundError · Stable
• WorkflowRunResult · Stable
• WorkflowRunStatus · Stable
• WorkflowState · Stable
• WorkflowStep · Stable
• WorkflowStepExecutor · Stable
• WorkflowStepExecutorRegistry · Stable
• WorkflowStepOutcome · Stable
• WorkflowStepRequest · Stable
• WorkflowStepResult · Stable
• WorkflowStepStatus · Stable
• WorkflowStopCondition · Stable
• WorkflowTraceEvent · Stable
• WorkflowTransition · Stable
• aclose_default_clients · Stable
• agent_child_run_from_state · Beta
• agent_run_state_from_json · Stable
• agent_run_state_to_json · Stable
• allow_all_approval_policy · Beta
• anthropic_code_execution_tool · Beta
• anthropic_mcp_server · Beta
• anthropic_web_fetch_tool · Beta
• anthropic_web_search_tool · Beta
• apply_safety_policy_to_agent · Beta
• assistant · Beta
• azure_openai_computer_use_tool · Beta
• azure_openai_file_search_tool · Beta
• azure_openai_mcp_approval_response · Beta
• azure_openai_mcp_tool · Beta
• azure_openai_response_reference · Beta
• azure_openai_web_search_tool · Beta
• build_provider_support_rows · Beta
• cancel_agent_run · Stable
• cancel_agent_run_tree · Stable
• cancel_workflow · Stable
• clear_agent_session_skills · Stable
• collect_ui_message · Beta
• create_a2a_agent_card · Beta
• create_a2a_app · Beta
• create_agent_evaluation_dataset_from_traces · Beta
• create_agent_evaluation_fixture · Beta
• create_agent_evaluation_report · Beta
• create_agent_evaluation_trajectory · Beta
• create_agent_playground_app · Beta
• create_agent_run_snapshot · Stable
• create_agent_run_tree_snapshot · Beta
• create_agent_session · Stable
• create_agent_trace_artifact · Beta
• create_agent_trace_collector · Beta
• create_anthropic · Stable
• create_approval_policy · Beta
• create_azure_openai · Stable
• create_bedrock · Experimental
• create_budget_guard · Beta
• create_cached_generate_middleware · Beta
• create_circuit_breaker_middleware · Beta
• create_dbos_workflow_adapter · Beta
• create_deepseek · Stable
• create_file_generate_cache · Beta
• create_gateway · Stable
• create_gemini · Stable
• create_hierarchical_agent_trace · Beta
• create_in_memory_agent_memory_store · Stable
• create_in_memory_agent_run_store · Stable
• create_in_memory_checkpoint_store · Stable
• create_in_memory_generate_cache · Beta
• create_in_memory_workflow_checkpoint_store · Stable
• create_in_memory_workflow_lease_manager · Stable
• create_kimi · Stable
• create_mcp_tool_registry · Stable
• create_meta · Stable
• create_mock_language_model · Beta
• create_mock_tool · Beta
• create_model_catalog · Stable
• create_ollama · Experimental
• create_openai · Stable
• create_openrouter · Experimental
• create_otel_agent_observer · Beta
• create_postgres_agent_memory_store · Stable
• create_postgres_agent_run_store · Stable
• create_postgres_checkpoint_store · Stable
• create_postgres_workflow_checkpoint_store · Stable
• create_postgres_workflow_lease_manager · Stable
• create_prefect_workflow_adapter · Beta
• create_qwen · Stable
• create_redaction_policy · Beta
• create_responses_app · Beta
• create_restate_workflow_adapter · Beta
• create_safety_policy · Beta
• create_sqlite_agent_memory_store · Stable
• create_sqlite_agent_run_store · Stable
• create_sqlite_checkpoint_store · Stable
• create_sqlite_workflow_checkpoint_store · Stable
• create_sqlite_workflow_lease_manager · Stable
• create_subagent_tool · Beta
• create_telemetry_middleware · Beta
• create_temporal_workflow_adapter · Beta
• create_text_message · Beta
• create_ui_message_json_response · Beta
• create_ui_message_lines_response · Beta
• create_vertex · Stable
• create_vllm · Stable
• default_model_catalog · Beta
• deny_all_approval_policy · Beta
• deserialize_agent_run_state · Stable
• deserialize_ui_message · Beta
• deserialize_ui_message_chunk · Beta
• deserialize_workflow_checkpoint · Stable
• discover_mcp_tools · Stable
• discover_skills · Stable
• embed · Stable
• embed_content · Stable
• embed_content_many · Stable
• embed_many · Stable
• estimate_agent_run_cost · Beta
• estimate_token_cost · Beta
• fail_agent_run_resume_claim · Beta
• fork_workflow · Stable
• from_ui_message · Beta
• from_ui_messages · Beta
• gemini_code_execution_tool · Beta
• gemini_computer_use_tool · Beta
• gemini_file_search_tool · Beta
• gemini_google_maps_tool · Beta
• gemini_google_search_tool · Beta
• gemini_hosted_tool · Beta
• gemini_url_context_tool · Beta
• generate_grounded_text · Stable
• generate_object · Stable
• generate_speech · Beta
• generate_text · Stable
• get_agent_capabilities · Beta
• get_agent_session_skills · Stable
• get_agent_support_tier · Beta
• get_azure_openai_response_id · Beta
• get_azure_openai_response_reference · Beta
• get_hosted_tool_class · Beta
• get_last_provider_data_part · Beta
• get_openai_response_id · Beta
• get_openai_response_reference · Beta
• get_pending_agent_approvals · Stable
• get_provider_data_parts · Beta
• handoff_to · Stable
• hosted_tool · Beta
• install_skill · Beta
• is_callable_tool_definition · Beta
• is_hosted_tool_class · Beta
• is_hosted_tool_definition · Beta
• judge_agent_evaluation · Beta
• kimi_formula_toolset · Beta
• list_installed_skills · Beta
• load_agent_session · Stable
• load_skill · Stable
• load_skill_package · Beta
• mcp_http_server · Stable
• mcp_stdio_server · Stable
• meta_hosted_tool · Beta
• meta_tool_search_tool · Beta
• meta_web_search_tool · Beta
• migrate_workflow_checkpoint · Stable
• migrate_workflow_checkpoint_payload · Stable
• migrate_workflow_run_checkpoint · Stable
• open_websocket_connection · Experimental
• openai_apply_patch_tool · Beta
• openai_code_interpreter_container · Beta
• openai_code_interpreter_tool · Beta
• openai_computer_use_tool · Beta
• openai_custom_tool · Beta
• openai_custom_tool_format_grammar · Beta
• openai_custom_tool_format_text · Beta
• openai_domain_secret · Beta
• openai_file_search_filter · Beta
• openai_file_search_filter_group · Beta
• openai_file_search_tool · Beta
• openai_hosted_tool · Beta
• openai_image_generation_tool · Beta
• openai_image_mask · Beta
• openai_inline_skill · Beta
• openai_inline_skill_source · Beta
• openai_local_shell_tool · Experimental
• openai_local_skill · Beta
• openai_mcp_approval_response · Beta
• openai_mcp_tool · Beta
• openai_namespace_tool · Beta
• openai_network_policy_allowlist · Beta
• openai_network_policy_disabled · Beta
• openai_programmatic_tool_calling_tool · Beta
• openai_response_options · Beta
• openai_response_reference · Beta
• openai_shell_environment · Experimental
• openai_shell_tool · Experimental
• openai_skill_reference · Beta
• openai_tool_search_tool · Beta
• openai_user_location · Beta
• openai_web_search_tool · Beta
• parse_azure_openai_provider_data_part · Beta
• parse_openai_provider_data_part · Beta
• parse_ui_message_request · Beta
• permission_allowlist_approval_policy · Beta
• prepare_subagents_for_agent · Beta
• provider_data_part · Beta
• publish_skill · Beta
• qwen_code_interpreter_tool · Beta
• qwen_file_search_tool · Beta
• qwen_hosted_tool · Beta
• qwen_image_search_tool · Beta
• qwen_mcp_tool · Beta
• qwen_web_extractor_tool · Beta
• qwen_web_search_image_tool · Beta
• qwen_web_search_tool · Beta
• remote_tool · Beta
• render_provider_support_markdown · Beta
• replay_agent_run · Stable
• resume_agent · Stable
• resume_agent_run · Stable
• resume_workflow · Stable
• run_agent · Stable
• run_agent_evaluation · Beta
• run_agent_evaluation_experiment · Beta
• run_agent_evaluation_fixture · Beta
• run_agent_group · Beta
• run_skill · Beta
• run_workflow · Stable
• serialize_agent_run_state · Stable
• serialize_ui_message · Beta
• serialize_ui_message_chunk · Beta
• serialize_workflow_checkpoint · Stable
• set_agent_session_skills · Stable
• skill · Stable
• stream_agent · Stable
• stream_agent_ag_ui · Beta
• stream_live_agent · Experimental
• stream_object · Stable
• stream_sse · Stable
• stream_text · Stable
• summarize_agent_trace · Beta
• system · Beta
• text_part · Beta
• to_ag_ui_sse_response · Beta
• to_sse_response · Stable
• to_sse_stream · Stable
• to_text_stream · Stable
• to_text_stream_response · Stable
• to_ui_message · Beta
• to_ui_message_stream · Beta
• to_ui_message_stream_response · Stable
• to_ui_messages · Beta
• tool · Stable
• tool_call_part · Beta
• tool_result_part · Beta
• transcribe_audio · Beta
• user · Beta
• validate_skill · Beta
• validate_workflow_expectations · Stable
• vertex_code_execution_tool · Beta
• vertex_computer_use_tool · Beta
• vertex_external_search_tool · Beta
• vertex_google_maps_tool · Beta
• vertex_google_search_tool · Beta
• vertex_url_context_tool · Beta
• vertex_vertex_ai_search_tool · Beta
• workflow_checkpoint_from_json · Stable
• workflow_checkpoint_to_json · Stable
• workflow_step · Stable
• wrap_language_model · Beta