API ReferenceΒΆ
Automatically generated reference for the public Kaval.AI package. The most
common classes and functions are re-exported from the top-level kavalai
namespace, so from kavalai import WorkflowEngine, Agent, FunctionKernel works
out of the box. The pages below document each subsystem in detail.
Looking for the workflow YAML keys, the bundled tools or the environment variables instead? Those are in Reference.
- Workflow API
- Agents API
- LLM Clients API
- Function Kernel API
- Network Guard API
- Text API
- kavalai.text.CHROME_TAGS
- kavalai.text.CONTENT_TAGS
- kavalai.text.DROP_ROLES
- kavalai.text.DROP_TAGS
- kavalai.text.HEADING_SEPARATOR
- kavalai.text.MAX_CHARS
- kavalai.text.ROBOTS_NAMES
- kavalai.text.TARGET_CHARS
- kavalai.text.Block
- kavalai.text.Chunk
- kavalai.text.ParsedPage
- kavalai.text.chunk_blocks
- kavalai.text.chunk_markdown
- kavalai.text.parse_html
- Agent Server API
- Evaluation API
- Testing API
- Backoffice API
- kavalai.backoffice.server.get_backoffice_session
- kavalai.backoffice.server.get_project_session
- kavalai.backoffice.server.required_setting
- kavalai.backoffice.server.authenticate_and_sync_user
- kavalai.backoffice.server.is_logged_in
- kavalai.backoffice.server.assert_logged_in
- kavalai.backoffice.server.assert_is_admin
- kavalai.backoffice.server.assert_is_owner
- kavalai.backoffice.server.assert_is_admin_or_owner
- kavalai.backoffice.server.assert_is_member
- kavalai.backoffice.server.get_project_and_assert_access
- kavalai.backoffice.server.login
- kavalai.backoffice.server.logout
- kavalai.backoffice.server.user_details
- kavalai.backoffice.server.google_auth_callback
- kavalai.backoffice.server.set_active_project
- kavalai.backoffice.server.projects_create
- kavalai.backoffice.server.projects_get_by_id
- kavalai.backoffice.server.projects_get_all
- kavalai.backoffice.server.projects_update
- kavalai.backoffice.server.projects_delete
- kavalai.backoffice.server.users_get_all
- kavalai.backoffice.server.users_create
- kavalai.backoffice.server.users_update
- kavalai.backoffice.server.users_delete
- kavalai.backoffice.server.agents_get_by_id
- kavalai.backoffice.server.workflows_render_svg
- kavalai.backoffice.server.agents_get_all
- kavalai.backoffice.server.agents_get_stats
- kavalai.backoffice.server.agents_get_summary_stats
- kavalai.backoffice.server.agents_get_sessions
- kavalai.backoffice.server.agents_get_session_details
- kavalai.backoffice.server.projects_get_llm_call_stats
- kavalai.backoffice.server.rag_service_for_project
- kavalai.backoffice.server.projects_rag_query
- kavalai.backoffice.server.projects_rag_stats
- kavalai.backoffice.server.projects_rag_collections
- kavalai.backoffice.server.projects_train_pca
- kavalai.backoffice.server.projects_test_connection
- kavalai.backoffice.server.projects_get_members
- kavalai.backoffice.server.projects_add_member
- kavalai.backoffice.server.projects_update_member
- kavalai.backoffice.server.projects_remove_member
- kavalai.backoffice.project_service.PROJECT_FIELDS
- kavalai.backoffice.project_service.project_fields
- kavalai.backoffice.project_service.ProjectService
- kavalai.backoffice.project_service.project_db_uri
- kavalai.backoffice.project_service.project_schema
- kavalai.backoffice.project_service.project_rag_schema
- kavalai.backoffice.project_service.project_read_only
- kavalai.backoffice.project_service.project_sessionmaker
- kavalai.backoffice.project_service.describe_project_database