Workflows - Modus Docs

WorkflowsResource

class WorkflowsResource(http: HttpClient, config: ModusConfig, ops: ManagementWorkflowsOperations = ManagementWorkflowsOperations(list='WorkflowsController_list', get='WorkflowsController_get', create='WorkflowsController_create', update='WorkflowsController_update', deploy='WorkflowsController_deploy', delete='WorkflowsController_delete', restore='WorkflowsController_restore', request_ownership_transfer='WorkflowsController_requestOwnershipTransfer', cancel_ownership_transfer='WorkflowsController_cancelOwnershipTransfer', accept_ownership_transfer='WorkflowsController_acceptOwnershipTransfer', toggle='WorkflowsController_toggle'))

Bases: object Full CRUD access to Modus workflows. mgmt.workflows.list() → Page[Agent] mgmt.workflows.get(workflow_id) → Agent (with variation fields) mgmt.workflows.create(name, type) → Agent mgmt.workflows.update(workflow_id, ..) → Agent mgmt.workflows.deploy(workflow_id) → Agent mgmt.workflows.delete(workflow_id) → None

list()

list(*, page_size: int = 25, page_token: str | None = None, search: str | None = None, type: AgentType | None = None, view: Literal['active', 'draft'] | None = None, include_variation: bool | None = None) → Page[WorkflowDto]

List all Modus workflows in the organisation.

Parameters:
- page_size – Maximum number of items to return (default 25).
- page_token – Token from a previous page’s next_page_token; omit for the first page.
- search – Case-insensitive substring filter on the workflow name.
- type – Filter by workflow type: "task" or "workflow".
- view – Variation view — "active" (deployed) or "draft".
- include_variation – Include variation payload on each list row.

get()

get(workflow_id: int | str, *, view: Literal['active', 'draft'] | None = None) → WorkflowDto

Retrieve a Modus workflow with full configuration.

interfaces()

interfaces(workflow_id: int | str) → WorkflowInterfacesResource

Return the interfaces sub-resource scoped to workflow_id.

create()

create(name: str, type: AgentType, *, description: str | None = None, trigger: TriggerInput | None = None, agent_selection: AgentSelectionInput | None = None, workflow_structure: WorkflowGraphInput | None = None, guardrails: List[str] | None = None) → Agent

Create a new Modus workflow.

Parameters:
- name – Display name for the workflow.
- type – "task" for single-step skill orchestration, or "workflow" for a multi-step graph.
- guardrails – Runtime guardrail labels (for example "no-pii"). When set, the workflow is created with these labels under the organisation default sharing rules. Omit (None) to create with no guardrails. ACL fields cannot be set from the SDK.

update()

update(workflow_id: int | str, *, name: str | None = None, type: AgentType | None = None, description: str | None = None, trigger: TriggerInput | None = None, agent_selection: AgentSelectionInput | None = None, workflow_structure: WorkflowGraphInput | None = None, guardrails: List[str] | None = None, update_mask: str | None = None) → Agent

Update a Modus workflow’s configuration. Only the fields you pass are changed. To clear a field, name it in update_mask (a comma-separated list of field names) and leave its argument unset — the server sets each masked field to null and leaves fields not named in the mask untouched.

Parameters: guardrails – Runtime guardrail labels to set on the workflow. Fetches the current workflow first and merges these labels into its access configuration (an extra get request). Omit (None) to leave guardrails unchanged. Pass [] to clear all guardrails.

deploy()

deploy(workflow_id: int | str) → WorkflowDto

Publish the current draft of a Modus workflow.

Parameters: workflow_id – Workflow to publish.
Returns: The workflow with its newly published configuration.

toggle()

toggle(workflow_id: int | str, *, active: bool) → WorkflowDto

Enable or disable a workflow.

delete()

delete(workflow_id: int | str) → None

Delete a Modus workflow.

Parameters: workflow_id – Workflow to remove.

request_ownership_transfer()

request_ownership_transfer(workflow_id: int | str, *, new_owner_user_id: str) → WorkflowDto

Start transferring ownership of a workflow to another organisation member.

cancel_ownership_transfer()

cancel_ownership_transfer(workflow_id: int | str) → WorkflowDto

Cancel a pending workflow ownership transfer.

accept_ownership_transfer()

accept_ownership_transfer(workflow_id: int | str) → WorkflowDto

Accept a pending workflow ownership transfer.

restore()

restore(workflow_id: int | str) → WorkflowDto

Restore a deleted workflow.

AsyncWorkflowsResource

class AsyncWorkflowsResource(http: AsyncHttpClient, config: ModusConfig, ops: ManagementWorkflowsOperations = ManagementWorkflowsOperations(list='WorkflowsController_list', get='WorkflowsController_get', create='WorkflowsController_create', update='WorkflowsController_update', deploy='WorkflowsController_deploy', delete='WorkflowsController_delete', restore='WorkflowsController_restore', request_ownership_transfer='WorkflowsController_requestOwnershipTransfer', cancel_ownership_transfer='WorkflowsController_cancelOwnershipTransfer', accept_ownership_transfer='WorkflowsController_acceptOwnershipTransfer', toggle='WorkflowsController_toggle'))

Bases: object

list()

async list(*, page_size: int = 25, page_token: str | None = None, search: str | None = None, type: AgentType | None = None, view: Literal['active', 'draft'] | None = None, include_variation: bool | None = None) → AsyncPage[WorkflowDto]

List all Modus workflows in the organisation.

Parameters:
- page_size – Maximum number of items to return (default 25).
- page_token – Token from a previous page’s next_page_token; omit for the first page.
- search – Case-insensitive substring filter on the workflow name.
- type – Filter by workflow type: "task" or "workflow".
- view – Variation view — "active" (deployed) or "draft".
- include_variation – Include variation payload on each list row.

get()

async get(workflow_id: int | str, *, view: Literal['active', 'draft'] | None = None) → WorkflowDto

Retrieve a Modus workflow with full configuration.

interfaces()

interfaces(workflow_id: int | str) → AsyncWorkflowInterfacesResource

Return the interfaces sub-resource scoped to workflow_id.

create()

async create(name: str, type: AgentType, *, description: str | None = None, trigger: TriggerInput | None = None, agent_selection: AgentSelectionInput | None = None, workflow_structure: WorkflowGraphInput | None = None, guardrails: List[str] | None = None) → Agent

Create a new Modus workflow.

Parameters:
- name – Display name for the workflow.
- type – "task" for single-step skill orchestration, or "workflow" for a multi-step graph.
- guardrails – Runtime guardrail labels (for example "no-pii"). When set, the workflow is created with these labels under the organisation default sharing rules. Omit (None) to create with no guardrails. ACL fields cannot be set from the SDK.

update()

async update(workflow_id: int | str, *, name: str | None = None, type: AgentType | None = None, description: str | None = None, trigger: TriggerInput | None = None, agent_selection: AgentSelectionInput | None = None, workflow_structure: WorkflowGraphInput | None = None, guardrails: List[str] | None = None, update_mask: str | None = None) → Agent

Parameters: guardrails – Runtime guardrail labels to set on the workflow. Fetches the current workflow first and merges these labels into its access configuration (an extra get request). Omit (None) to leave guardrails unchanged. Pass [] to clear all guardrails.

deploy()

async deploy(workflow_id: int | str) → WorkflowDto

Publish the current draft of a Modus workflow. See the sync deploy for argument details.

toggle()

async toggle(workflow_id: int | str, *, active: bool) → WorkflowDto

Enable or disable a workflow. See the sync toggle for argument details.

delete()

async delete(workflow_id: int | str) → None

Delete a Modus workflow. See the sync delete for argument details.

request_ownership_transfer()

async request_ownership_transfer(workflow_id: int | str, *, new_owner_user_id: str) → WorkflowDto

Start transferring ownership of a workflow to another organisation member.

cancel_ownership_transfer()

async cancel_ownership_transfer(workflow_id: int | str) → WorkflowDto

Cancel a pending workflow ownership transfer.

accept_ownership_transfer()

async accept_ownership_transfer(workflow_id: int | str) → WorkflowDto

Accept a pending workflow ownership transfer.

restore()

async restore(workflow_id: int | str) → WorkflowDto

Restore a deleted workflow.

WorkflowInterfacesResource

class WorkflowInterfacesResource(http: HttpClient, config: ModusConfig, workflow_id: int | str)

Bases: object

list()

list() → list[AgentInterfaceDto]

List interfaces attached to this workflow.

create()

create(interface: AddAgentInterfaceDto | Mapping[str, Any]) → AgentInterfaceDto

Add an interface to this workflow.

Parameters: interface – Interface configuration to attach, as a DTO or plain mapping.

update()

update(interface_id: str, interface: UpdateAgentInterfaceDto, *, update_mask: str | None = None) → AgentInterfaceDto

Update an interface attached to this workflow.

delete()

delete(interface_id: str) → None

Delete an interface from this workflow.

delete_all()

delete_all() → None

Delete every interface from this workflow.

AsyncWorkflowInterfacesResource

class AsyncWorkflowInterfacesResource(http: AsyncHttpClient, config: ModusConfig, workflow_id: int | str)

Bases: object

list()

async list() → list[AgentInterfaceDto]

List interfaces attached to this workflow.

create()

async create(interface: AddAgentInterfaceDto | Mapping[str, Any]) → AgentInterfaceDto

Add an interface to this workflow.

Parameters: interface – Interface configuration to attach, as a DTO or plain mapping.

update()

async update(interface_id: str, interface: UpdateAgentInterfaceDto, *, update_mask: str | None = None) → AgentInterfaceDto

Update an interface attached to this workflow.

Parameters:
- interface_id – Identifier of the interface to update.
- interface – Updated interface values.
- update_mask – Optional comma-separated list of fields to update.

delete()

async delete(interface_id: str) → None

Delete an interface from this workflow.

Parameters: interface_id – Identifier of the interface to delete.

delete_all()

async delete_all() → None

Delete every interface from this workflow.

​WorkflowsResource

​list()

​get()

​interfaces()

​create()

​update()

​deploy()

​toggle()

​delete()

​request_ownership_transfer()

​cancel_ownership_transfer()

​accept_ownership_transfer()

​restore()

​AsyncWorkflowsResource

​list()

​get()

​interfaces()

​create()

​update()

​deploy()

​toggle()

​delete()

​request_ownership_transfer()

​cancel_ownership_transfer()

​accept_ownership_transfer()

​restore()

​WorkflowInterfacesResource

​list()

​create()

​update()

​delete()

​delete_all()

​AsyncWorkflowInterfacesResource

​list()

​create()

​update()

​delete()

​delete_all()

WorkflowsResource

list()

get()

interfaces()

create()

update()

deploy()

toggle()

delete()

request_ownership_transfer()

cancel_ownership_transfer()

accept_ownership_transfer()

restore()

AsyncWorkflowsResource

list()

get()

interfaces()

create()

update()

deploy()

toggle()

delete()

request_ownership_transfer()

cancel_ownership_transfer()

accept_ownership_transfer()

restore()

WorkflowInterfacesResource

list()

create()

update()

delete()

delete_all()

AsyncWorkflowInterfacesResource

list()

create()

update()

delete()

delete_all()