chariot.awm package

Submodules

chariot.awm.activity module

Activity and session operations for AWM workflows.

chariot.awm.activity.get_activities(workflow_id: str, session_id: str | None = None, types: list[str] | None = None, from_time: datetime | None = None, sort_order: str = 'asc', limit: int | None = None, after_key: str | None = None) → Generator[Activity, None, None][source]

List activities for a workflow, optionally filtered by session and type.

Parameters:

  • workflow_id – Workflow id

  • session_id – Filter to a specific session

  • types – Activity types to include (e.g. [“agent_to_user_message”])

  • from_time – Only include activities created at or after this time

  • sort_order – “asc” or “desc”

  • limit – Maximum number of results to return

  • after_key – The pagination key to fetch more items

Return type:

Generator[models.Activity, None, None]

chariot.awm.activity.get_sessions(workflow_id: str, session_ids: list[str] | None = None, user_ids: list[str] | None = None, agents: list[str] | None = None, from_time: datetime | None = None, to_time: datetime | None = None, limit: int | None = None, sort_order: str = 'desc', after_key: str | None = None) → Generator[SessionDetails, None, None][source]

List sessions for a workflow.

Parameters:

  • workflow_id – Workflow id

  • session_ids – Filter to specific session IDs

  • user_ids – Filter to sessions for one or more users

  • agents – Filter to sessions containing one or more agents

  • from_time – Only include sessions created at or after this time

  • to_time – Only include sessions created before this time

  • limit – Maximum number of results to return

  • sort_order – “asc” or “desc”

  • after_key – The pagination key to fetch more items

Return type:

Generator[models.SessionDetails, None, None]

chariot.awm.activity.send_clear_context(workflow_id: str, agent_name: str, session_id: str) → Activity[source]

Send a clear_context activity to reset an agent’s context within a session.

chariot.awm.activity.send_message(workflow_id: str, agent_name: str, body: str, session_id: str | None = None) → Activity[source]

Send a user-to-agent message activity to a workflow.

Parameters:

  • workflow_id – Workflow id

  • agent_name – Target agent name

  • body – Message text

  • session_id – Existing session ID; a new KSUID is generated server-side if omitted

Return type:

models.Activity

chariot.awm.activity.send_tool_call_approvals(workflow_id: str, agent_name: str, session_id: str, request_activity_id: str, approvals: list[dict[str, Any]]) → Activity[source]

Send tool-call approvals for a pending tool_call_requests activity.

Parameters:

  • workflow_id – Workflow id

  • agent_name – Target agent name

  • session_id – Session id

  • request_activity_id – ID of the tool_call_requests activity being approved

  • approvals – Array of approval objects: [{“toolCallRequest”: {…}, “approved”: bool, “userResponse”: str?}, …]

Return type:

models.Activity

chariot.awm.configurations module

Configuration component CRUD helpers for AWM.

chariot.awm.configurations.create_agent_configuration(project_id: str, name: str, key: str, description: str, config: dict[str, Any] | str) → ConfigurationComponentVersion[source]

Create an agent configuration component.

chariot.awm.configurations.create_agent_configuration_stage(version_id: str, stage: str) → None[source]

Create a stage for an agent configuration component version.

chariot.awm.configurations.create_agent_configuration_version(component_id: str, config: dict[str, Any] | str, version_changelog: str, description: str | None = None) → ConfigurationComponentVersion[source]

Create a new agent configuration component version.

chariot.awm.configurations.create_evaluator_configuration(project_id: str, name: str, key: str, description: str, config: dict[str, Any] | str) → ConfigurationComponentVersion[source]

Create an evaluator configuration component.

chariot.awm.configurations.create_evaluator_configuration_stage(version_id: str, stage: str) → None[source]

Create a stage for an evaluator configuration component version.

chariot.awm.configurations.create_evaluator_configuration_version(component_id: str, config: dict[str, Any] | str, version_changelog: str, description: str | None = None) → ConfigurationComponentVersion[source]

Create a new evaluator configuration component version.

chariot.awm.configurations.create_mcp_connection_configuration(project_id: str, name: str, key: str, description: str, config: dict[str, Any] | str) → ConfigurationComponentVersion[source]

Create an MCP connection configuration component.

chariot.awm.configurations.create_mcp_connection_configuration_stage(version_id: str, stage: str) → None[source]

Create a stage for an MCP connection configuration component version.

chariot.awm.configurations.create_mcp_connection_configuration_version(component_id: str, config: dict[str, Any] | str, version_changelog: str, description: str | None = None) → ConfigurationComponentVersion[source]

Create a new MCP connection configuration component version.

chariot.awm.configurations.create_shared_configuration(project_id: str, name: str, key: str, description: str, config: dict[str, Any] | str) → ConfigurationComponentVersion[source]

Create a shared configuration component.

chariot.awm.configurations.create_shared_configuration_stage(version_id: str, stage: str) → None[source]

Create a stage for a shared configuration component version.

chariot.awm.configurations.create_shared_configuration_version(component_id: str, config: dict[str, Any] | str, version_changelog: str, description: str | None = None) → ConfigurationComponentVersion[source]

Create a new shared configuration component version.

chariot.awm.configurations.create_tool_profile_configuration(project_id: str, name: str, key: str, description: str, config: dict[str, Any] | str) → ConfigurationComponentVersion[source]

Create a tool profile configuration component.

chariot.awm.configurations.create_tool_profile_configuration_stage(version_id: str, stage: str) → None[source]

Create a stage for a tool profile configuration component version.

chariot.awm.configurations.create_tool_profile_configuration_version(component_id: str, config: dict[str, Any] | str, version_changelog: str, description: str | None = None) → ConfigurationComponentVersion[source]

Create a new tool profile configuration component version.

chariot.awm.configurations.create_workflow_configuration(project_id: str, name: str, key: str, description: str, config: dict[str, Any] | str) → ConfigurationComponentVersion[source]

Create a workflow configuration component.

chariot.awm.configurations.create_workflow_configuration_stage(version_id: str, stage: str) → None[source]

Create a stage for a workflow configuration component version.

chariot.awm.configurations.create_workflow_configuration_version(component_id: str, config: dict[str, Any] | str, version_changelog: str, description: str | None = None) → ConfigurationComponentVersion[source]

Create a new workflow configuration component version.

chariot.awm.configurations.delete_agent_configuration_version(version_id: str) → None[source]

Delete an agent configuration component version.

chariot.awm.configurations.delete_evaluator_configuration_version(version_id: str) → None[source]

Delete an evaluator configuration component version.

chariot.awm.configurations.delete_mcp_connection_configuration_version(version_id: str) → None[source]

Delete an MCP connection configuration component version.

chariot.awm.configurations.delete_shared_configuration_version(version_id: str) → None[source]

Delete a shared configuration component version.

chariot.awm.configurations.delete_tool_profile_configuration_version(version_id: str) → None[source]

Delete a tool profile configuration component version.

chariot.awm.configurations.delete_workflow_configuration_version(version_id: str) → None[source]

Delete a workflow configuration component version.

chariot.awm.configurations.get_agent_configuration_version(version_id: str, resolved: bool | None = None) → ResolvedConfiguration[source]

Get an agent configuration component version.

chariot.awm.configurations.get_configuration_by_reference(project_id: str, component_type: str, key: str, version_or_stage: str, resolved: bool | None = None) → ResolvedConfiguration[source]

Get a configuration component by project, type, key, and version or stage.

chariot.awm.configurations.get_evaluator_configuration_version(version_id: str, resolved: bool | None = None) → ResolvedConfiguration[source]

Get an evaluator configuration component version.

chariot.awm.configurations.get_mcp_connection_configuration_version(version_id: str, resolved: bool | None = None) → ResolvedConfiguration[source]

Get an MCP connection configuration component version.

chariot.awm.configurations.get_shared_configuration_version(version_id: str, resolved: bool | None = None) → ResolvedConfiguration[source]

Get a shared configuration component version.

chariot.awm.configurations.get_tool_profile_configuration_version(version_id: str, resolved: bool | None = None) → ResolvedConfiguration[source]

Get a tool profile configuration component version.

chariot.awm.configurations.get_workflow_configuration_version(version_id: str, resolved: bool | None = None) → ResolvedConfiguration[source]

Get a workflow configuration component version.

chariot.awm.configurations.list_agent_configuration_components(name: str | None = None, project_ids: list[str] | None = None, include_deleted: bool | None = None, limit: int | None = None, after_key: str | None = None, sort_type: str | None = None, sort_order: str | None = None) → Generator[ConfigurationComponent, None, None][source]

List agent configuration components.

chariot.awm.configurations.list_agent_configuration_versions(component_id: str, include_deleted: bool | None = None, limit: int | None = None, after_key: str | None = None, sort_order: str | None = None) → Generator[ConfigurationComponentVersionSummary, None, None][source]

List agent configuration component versions.

chariot.awm.configurations.list_evaluator_configuration_components(name: str | None = None, project_ids: list[str] | None = None, include_deleted: bool | None = None, limit: int | None = None, after_key: str | None = None, sort_type: str | None = None, sort_order: str | None = None) → Generator[ConfigurationComponent, None, None][source]

List evaluator configuration components.

chariot.awm.configurations.list_evaluator_configuration_versions(component_id: str, include_deleted: bool | None = None, limit: int | None = None, after_key: str | None = None, sort_order: str | None = None) → Generator[ConfigurationComponentVersionSummary, None, None][source]

List evaluator configuration component versions.

chariot.awm.configurations.list_mcp_connection_configuration_components(name: str | None = None, project_ids: list[str] | None = None, include_deleted: bool | None = None, limit: int | None = None, after_key: str | None = None, sort_type: str | None = None, sort_order: str | None = None) → Generator[ConfigurationComponent, None, None][source]

List MCP connection configuration components.

chariot.awm.configurations.list_mcp_connection_configuration_versions(component_id: str, include_deleted: bool | None = None, limit: int | None = None, after_key: str | None = None, sort_order: str | None = None) → Generator[ConfigurationComponentVersionSummary, None, None][source]

List MCP connection configuration component versions.

chariot.awm.configurations.list_shared_configuration_components(name: str | None = None, project_ids: list[str] | None = None, include_deleted: bool | None = None, limit: int | None = None, after_key: str | None = None, sort_type: str | None = None, sort_order: str | None = None) → Generator[ConfigurationComponent, None, None][source]

List shared configuration components.

chariot.awm.configurations.list_shared_configuration_versions(component_id: str, include_deleted: bool | None = None, limit: int | None = None, after_key: str | None = None, sort_order: str | None = None) → Generator[ConfigurationComponentVersionSummary, None, None][source]

List shared configuration component versions.

chariot.awm.configurations.list_tool_profile_configuration_components(name: str | None = None, project_ids: list[str] | None = None, include_deleted: bool | None = None, limit: int | None = None, after_key: str | None = None, sort_type: str | None = None, sort_order: str | None = None) → Generator[ConfigurationComponent, None, None][source]

List tool profile configuration components.

chariot.awm.configurations.list_tool_profile_configuration_versions(component_id: str, include_deleted: bool | None = None, limit: int | None = None, after_key: str | None = None, sort_order: str | None = None) → Generator[ConfigurationComponentVersionSummary, None, None][source]

List tool profile configuration component versions.

chariot.awm.configurations.list_workflow_configuration_components(name: str | None = None, project_ids: list[str] | None = None, include_deleted: bool | None = None, limit: int | None = None, after_key: str | None = None, sort_type: str | None = None, sort_order: str | None = None) → Generator[ConfigurationComponent, None, None][source]

List workflow configuration components.

chariot.awm.configurations.list_workflow_configuration_versions(component_id: str, include_deleted: bool | None = None, limit: int | None = None, after_key: str | None = None, sort_order: str | None = None) → Generator[ConfigurationComponentVersionSummary, None, None][source]

List workflow configuration component versions.

chariot.awm.models module

Dataclass models for AWM resources and activities.

class chariot.awm.models.Activity(id: str, workflow_id: str, type: str, body: Any, session_id: str, final: bool, created_at: datetime, from_agent: str = '', to_agent: str = '', user_id: str = '', processed_at: datetime | None = None, session_context_size: int | None = None)[source]

Bases: Base

An activity event within a workflow session.

body: Any
created_at: datetime
final: bool
from_agent: str = ''
id: str
processed_at: datetime | None = None
session_context_size: int | None = None
session_id: str
to_agent: str = ''
type: str
user_id: str = ''
workflow_id: str
class chariot.awm.models.ConfigurationComponent(id: str, project_id: str, component_type: str, name: str, key: str, deleted_at: datetime | None = None)[source]

Bases: Base

A configuration component.

component_type: str
deleted_at: datetime | None = None
id: str
key: str
name: str
project_id: str
class chariot.awm.models.ConfigurationComponentVersion(id: str, component_id: str, component_type: str, project_id: str, name: str, key: str, description: str, version: int, created_at: datetime, created_by: str, config: dict[str, Any] | None = None, raw_config: list[int] | None = None, version_changelog: str | None = None, stages: list[str] | None = None, deleted_at: datetime | None = None, deleted_by: str | None = None)[source]

Bases: Base

A configuration component version.

component_id: str
component_type: str
config: dict[str, Any] | None = None
created_at: datetime
created_by: str
deleted_at: datetime | None = None
deleted_by: str | None = None
description: str
id: str
key: str
name: str
project_id: str
raw_config: list[int] | None = None
stages: list[str] | None = None
version: int
version_changelog: str | None = None
class chariot.awm.models.ConfigurationComponentVersionSummary(id: str, component_id: str, component_type: str, project_id: str, name: str, key: str, description: str, version: int, created_at: datetime, created_by: str, version_changelog: str | None = None, stages: list[str] | None = None, deleted_at: datetime | None = None, deleted_by: str | None = None)[source]

Bases: Base

Summary metadata for a configuration component version.

component_id: str
component_type: str
created_at: datetime
created_by: str
deleted_at: datetime | None = None
deleted_by: str | None = None
description: str
id: str
key: str
name: str
project_id: str
stages: list[str] | None = None
version: int
version_changelog: str | None = None
chariot.awm.models.ConfigurationStage

alias of str

chariot.awm.models.ConfigurationType

alias of str

class chariot.awm.models.PodDetails(name: str, status: str)[source]

Bases: Base

Pod details.

name: str
status: str
class chariot.awm.models.ResolvedConfiguration(data: ConfigurationComponentVersion, resolved: dict[str, Any] | None = None)[source]

Bases: Base

A configuration component version with optional resolved config.

data: ConfigurationComponentVersion
resolved: dict[str, Any] | None = None
class chariot.awm.models.Schedule(id: str, workflow_id: str, name: str, to_agent: str, prompt: str, active: bool, schedule: str, created_by: str, created_at: datetime, expires_at: datetime | None = None, expires_in: str | None = None)[source]

Bases: Base

A scheduled task for a workflow.

active: bool
created_at: datetime
created_by: str
expires_at: datetime | None = None
expires_in: str | None = None
id: str
name: str
prompt: str
schedule: str
to_agent: str
workflow_id: str
class chariot.awm.models.SessionDetails(session_id: str, status: str, agents: list[str], user_ids: list[str], total_activity_count: int, user_activity_count: int, tool_activity_count: int, created_at: datetime, updated_at: datetime, schedule_id: str | None = None, total_request_duration_micros: int | None = None)[source]

Bases: Base

Summary of a workflow session.

agents: list[str]
created_at: datetime
schedule_id: str | None = None
session_id: str
status: str
tool_activity_count: int
total_activity_count: int
total_request_duration_micros: int | None = None
updated_at: datetime
user_activity_count: int
user_ids: list[str]
class chariot.awm.models.Workflow(id: str, name: str, description: str, project_id: str, paused: bool, config: dict[str, Any] | None, public_settings: dict[str, WorkflowPublicSettingRef] | None, created_at: datetime, created_by: str, updated_at: datetime, updated_by: str, deleted_at: datetime | None, deleted_by: str | None)[source]

Bases: Base

An instance of a workflow.

config: dict[str, Any] | None
created_at: datetime
created_by: str
deleted_at: datetime | None
deleted_by: str | None
description: str
id: str
name: str
paused: bool
project_id: str
public_settings: dict[str, WorkflowPublicSettingRef] | None
updated_at: datetime
updated_by: str
class chariot.awm.models.WorkflowPublicSettingRef(ref: str, schema: Any | None = None)[source]

Bases: Base

A reference to a public setting, with optional schema.

ref: str
schema: Any | None = None
class chariot.awm.models.WorkflowPublicSettingValue(value: Any, schema: Any | None = None)[source]

Bases: Base

A public setting value. The schema (if one exists), should be treated as read-only and is used for documentation purposes.

schema: Any | None = None
value: Any
class chariot.awm.models.WorkflowResourceDetails(valid: bool, deployment: str, pods: list[PodDetails])[source]

Bases: Base

Resources of a workflow. Valid is false if any resources are missing, and any attempts to use this workflow will likely fail.

deployment: str
pods: list[PodDetails]
valid: bool

chariot.awm.schedules module

Schedule CRUD helpers for AWM workflows.

chariot.awm.schedules.create_schedule(workflow_id: str, to_agent: str, prompt: str, schedule: str, active: bool, name: str | None = None, expires_at: datetime | str | None = None, expires_in: str | None = None) → Schedule[source]

Create a schedule for a workflow.

chariot.awm.schedules.delete_schedule(schedule_id: str) → None[source]

Delete a schedule by id.

chariot.awm.schedules.get_schedule(schedule_id: str) → Schedule[source]

Get a schedule by id.

chariot.awm.schedules.get_schedules(workflow_id: str, name: str | None = None, active: bool | None = None, agents: list[str] | None = None, limit: int | None = None, after_key: str | None = None) → Generator[Schedule, None, None][source]

List schedules matching the specified filters.

Parameters:

  • workflow_id – Workflow id

  • name – Optional schedule name filter

  • active – Optional active/inactive filter

  • agents – Optional list of target agents

  • limit – Maximum number of results to return

  • after_key – The pagination key to fetch more items

Return type:

Generator[models.Schedule, None, None]

chariot.awm.schedules.update_schedule(schedule_id: str, to_agent: str, prompt: str, schedule: str, active: bool, name: str | None = None, expires_at: datetime | str | None = None, expires_in: str | None = None) → Schedule[source]

Update a schedule by id.

chariot.awm.workflows module

chariot.awm.workflows.create_workflow(project_id: str, name: str, description: str, config: dict[str, Any], paused: bool = False, public_settings: dict[str, WorkflowPublicSettingRef] | None = None) → Workflow[source]

Create a workflow for a project.

Parameters:

  • project_id (str) – Project id

  • name (str) – Name of the workflow

  • description (str) – Description of the workflow

  • config (Dict[str, Any]) – The workflow configuration

  • paused (bool) – Set to true to not create an agent process pod

  • public_settings (Optional[Dict[str, models.WorkflowPublicSettingRef]]) – Public settings for the workflow

Return type:

models.Workflow

chariot.awm.workflows.delete_workflow(workflow_id: str)[source]

Delete a workflow for a project.

Parameters:

workflow_id (str) – Workflow id

Return type:

None

chariot.awm.workflows.get_public_setting_values(workflow_id: str) → dict[str, WorkflowPublicSettingValue][source]

Get workflow public setting values.

Parameters:

workflow_id (str) – Workflow id

Return type:

dict[str, models.WorkflowPublicSettingValue]

chariot.awm.workflows.get_workflow(workflow_id: str) → Workflow[source]

Get a workflow for a project.

Parameters:

workflow_id (str) – Workflow id

Return type:

models.Workflow

chariot.awm.workflows.get_workflows(name: str | None = None, project_ids: list[str] | None = None, include_deleted: bool | None = None, limit: int | None = None, after_key: str | None = None) → Generator[Workflow, None, None][source]

List workflows matching the specified filters.

Parameters:

  • name (Optional[str]) – Partial, case-insensitive name filter

  • project_ids (Optional[List[str]]) – List of project ids to filter

  • include_deleted (Optional[bool]) – Set to True to include deleted workflows

  • limit (Optional[int]) – The max total number of items to return

  • after_key (Optional[str]) – The pagination key to fetch more items

Return type:

Generator[models.Workflow, None, None]

chariot.awm.workflows.initialize_workflow_user(workflow_id: str, agent_name: str)[source]

Initialize a user for a particular workflow and agent.

Parameters:

  • workflow_id (str) – Workflow id

  • agent_name (str) – Agent name

Return type:

None

chariot.awm.workflows.patch_public_setting_values(workflow_id: str, public_setting_values: dict[str, WorkflowPublicSettingValue]) → dict[str, WorkflowPublicSettingValue][source]

Patch workflow public setting values.

Parameters:
Return type:

dict[str, models.WorkflowPublicSettingValue]

chariot.awm.workflows.patch_workflow_paused(workflow_id: str, paused: bool) → None[source]

PATCH only the paused flag without touching any other workflow fields.

chariot.awm.workflows.update_workflow(workflow_id: str, name: str, description: str, config: dict[str, Any], paused: bool = False, public_settings: dict[str, WorkflowPublicSettingRef] | None = None) → Workflow[source]

Update a workflow by the id.

Parameters:

  • workflow_id (str) – Workflow id

  • name (str) – Name of the workflow

  • description (str) – Description of the workflow

  • config (Dict[str, Any]) – The workflow configuration

  • paused (bool) – Set to true to not create an agent process pod

  • public_settings (Optional[Dict[str, models.WorkflowPublicSettingRef]]) – Public settings for the workflow

Return type:

models.Workflow

Module contents