> ## Documentation Index > Fetch the complete documentation index at: https://docs.pinkfish.ai/llms.txt > Use this file to discover all available pages before exploring further. # mistral-workflows > Mistral Workflows - workflow execution and management **Server path:** `/mistral-workflows` | **Type:** Application | **PCID required:** Yes ## Tools | Tool | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------ | | [`mistral_workflows_archive_workflow_v1_workflows_workflow_identifier_archive_put`](#mistral_workflows_archive_workflow_v1_workflows_workflow_identifier_archive_put) | Archive Workflow | | [`mistral_workflows_batch_cancel_workflow_executions_v1_workflows_executions_cancel_post`](#mistral_workflows_batch_cancel_workflow_executions_v1_workflows_executions_cancel_post) | Batch Cancel Workflow Executions | | [`mistral_workflows_batch_terminate_workflow_executions_v1_workflows_executions_terminate_post`](#mistral_workflows_batch_terminate_workflow_executions_v1_workflows_executions_terminate_post) | Batch Terminate Workflow Executions | | [`mistral_workflows_cancel_workflow_execution_v1_workflows_executions_execution_id_cancel_post`](#mistral_workflows_cancel_workflow_execution_v1_workflows_executions_execution_id_cancel_post) | Cancel Workflow Execution | | [`mistral_workflows_execute_workflow_v1_workflows_workflow_identifier_execute_post`](#mistral_workflows_execute_workflow_v1_workflows_workflow_identifier_execute_post) | Execute Workflow | | [`mistral_workflows_get_deployment_v1_workflows_deployments_name_get`](#mistral_workflows_get_deployment_v1_workflows_deployments_name_get) | Get Deployment | | [`mistral_workflows_get_run_history_v1_workflows_runs_run_id_history_get`](#mistral_workflows_get_run_history_v1_workflows_runs_run_id_history_get) | Get Run History | | [`mistral_workflows_get_run_v1_workflows_runs_run_id_get`](#mistral_workflows_get_run_v1_workflows_runs_run_id_get) | Get Run | | [`mistral_workflows_get_schedules_v1_workflows_schedules_get`](#mistral_workflows_get_schedules_v1_workflows_schedules_get) | Get Schedules | | [`mistral_workflows_get_stream_events_v1_workflows_events_stream_get`](#mistral_workflows_get_stream_events_v1_workflows_events_stream_get) | Get Stream Events | | [`mistral_workflows_get_worker_info_v1_workflows_workers_whoami_get`](#mistral_workflows_get_worker_info_v1_workflows_workers_whoami_get) | Get Worker Info | | [`mistral_workflows_get_workflow_events_v1_workflows_events_list_get`](#mistral_workflows_get_workflow_events_v1_workflows_events_list_get) | Get Workflow Events | | [`mistral_workflows_get_workflow_execution_history_v1_workflows_executions_execution_id_history_get`](#mistral_workflows_get_workflow_execution_history_v1_workflows_executions_execution_id_history_get) | Get Workflow Execution History | | [`mistral_workflows_get_workflow_execution_trace_events`](#mistral_workflows_get_workflow_execution_trace_events) | Get Workflow Execution Trace Events | | [`mistral_workflows_get_workflow_execution_trace_otel`](#mistral_workflows_get_workflow_execution_trace_otel) | Get Workflow Execution Trace Otel | | [`mistral_workflows_get_workflow_execution_trace_summary`](#mistral_workflows_get_workflow_execution_trace_summary) | Get Workflow Execution Trace Summary | | [`mistral_workflows_get_workflow_execution_v1_workflows_executions_execution_id_get`](#mistral_workflows_get_workflow_execution_v1_workflows_executions_execution_id_get) | Get Workflow Execution | | [`mistral_workflows_get_workflow_metrics_v1_workflows_workflow_name_metrics_get`](#mistral_workflows_get_workflow_metrics_v1_workflows_workflow_name_metrics_get) | Get Workflow Metrics | | [`mistral_workflows_get_workflow_registration_v1_workflows_registrations_workflow_registration_id_get`](#mistral_workflows_get_workflow_registration_v1_workflows_registrations_workflow_registration_id_get) | Get Workflow Registration | | [`mistral_workflows_get_workflow_registrations_v1_workflows_registrations_get`](#mistral_workflows_get_workflow_registrations_v1_workflows_registrations_get) | Get Workflow Registrations | | [`mistral_workflows_get_workflow_v1_workflows_workflow_identifier_get`](#mistral_workflows_get_workflow_v1_workflows_workflow_identifier_get) | Get Workflow | | [`mistral_workflows_list_deployments_v1_workflows_deployments_get`](#mistral_workflows_list_deployments_v1_workflows_deployments_get) | List Deployments | | [`mistral_workflows_list_runs_v1_workflows_runs_get`](#mistral_workflows_list_runs_v1_workflows_runs_get) | List Runs | | [`mistral_workflows_query_workflow_execution_v1_workflows_executions_execution_id_queries_post`](#mistral_workflows_query_workflow_execution_v1_workflows_executions_execution_id_queries_post) | Query Workflow Execution | | [`mistral_workflows_reset_workflow_v1_workflows_executions_execution_id_reset_post`](#mistral_workflows_reset_workflow_v1_workflows_executions_execution_id_reset_post) | Reset Workflow | | [`mistral_workflows_schedule_workflow_v1_workflows_schedules_post`](#mistral_workflows_schedule_workflow_v1_workflows_schedules_post) | Schedule Workflow | | [`mistral_workflows_signal_workflow_execution_v1_workflows_executions_execution_id_signals_post`](#mistral_workflows_signal_workflow_execution_v1_workflows_executions_execution_id_signals_post) | Signal Workflow Execution | | [`mistral_workflows_stream_v1_workflows_executions_execution_id_stream_get`](#mistral_workflows_stream_v1_workflows_executions_execution_id_stream_get) | Stream | | [`mistral_workflows_terminate_workflow_execution_v1_workflows_executions_execution_id_terminate_post`](#mistral_workflows_terminate_workflow_execution_v1_workflows_executions_execution_id_terminate_post) | Terminate Workflow Execution | | [`mistral_workflows_unarchive_workflow_v1_workflows_workflow_identifier_unarchive_put`](#mistral_workflows_unarchive_workflow_v1_workflows_workflow_identifier_unarchive_put) | Unarchive Workflow | | [`mistral_workflows_unschedule_workflow_v1_workflows_schedules_schedule_id_delete`](#mistral_workflows_unschedule_workflow_v1_workflows_schedules_schedule_id_delete) | Unschedule Workflow | | [`mistral_workflows_update_workflow_execution_v1_workflows_executions_execution_id_updates_post`](#mistral_workflows_update_workflow_execution_v1_workflows_executions_execution_id_updates_post) | Update Workflow Execution | | [`mistral_workflows_update_workflow_v1_workflows_workflow_identifier_put`](#mistral_workflows_update_workflow_v1_workflows_workflow_identifier_put) | Update Workflow | *** ## mistral\_workflows\_archive\_workflow\_v1\_workflows\_workflow\_identifier\_archive\_put Archive Workflow **Parameters:** | Parameter | Type | Required | Default | Description | | --------------------- | ------ | -------- | ------- | ------------------- | | `workflow_identifier` | string | Yes | — | Workflow Identifier | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "workflow_identifier": { "type": "string", "description": "Workflow Identifier" } }, "required": [ "PCID", "workflow_identifier" ] } ``` *** ## mistral\_workflows\_batch\_cancel\_workflow\_executions\_v1\_workflows\_executions\_cancel\_post Batch Cancel Workflow Executions **Parameters:** | Parameter | Type | Required | Default | Description | | --------------- | --------- | -------- | ------- | -------------------------------- | | `execution_ids` | string\[] | Yes | — | List of execution IDs to process | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "execution_ids": { "type": "array", "items": { "type": "string" }, "description": "List of execution IDs to process" } }, "required": [ "PCID", "execution_ids" ] } ``` *** ## mistral\_workflows\_batch\_terminate\_workflow\_executions\_v1\_workflows\_executions\_terminate\_post Batch Terminate Workflow Executions **Parameters:** | Parameter | Type | Required | Default | Description | | --------------- | --------- | -------- | ------- | -------------------------------- | | `execution_ids` | string\[] | Yes | — | List of execution IDs to process | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "execution_ids": { "type": "array", "items": { "type": "string" }, "description": "List of execution IDs to process" } }, "required": [ "PCID", "execution_ids" ] } ``` *** ## mistral\_workflows\_cancel\_workflow\_execution\_v1\_workflows\_executions\_execution\_id\_cancel\_post Cancel Workflow Execution **Parameters:** | Parameter | Type | Required | Default | Description | | -------------- | ------ | -------- | ------- | ------------ | | `execution_id` | string | Yes | — | Execution Id | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "execution_id": { "type": "string", "description": "Execution Id" } }, "required": [ "PCID", "execution_id" ] } ``` *** ## mistral\_workflows\_execute\_workflow\_v1\_workflows\_workflow\_identifier\_execute\_post Execute Workflow **Parameters:** | Parameter | Type | Required | Default | Description | | | --------------------------- | ------- | -------- | ------- | ------------------------------------------------------------------------------------------------ | -------------------------------------------------------------------------------------------- | | `workflow_identifier` | string | Yes | — | Workflow Identifier | | | `custom_tracing_attributes` | object | No | — | Custom Tracing Attributes | | | `deployment_name` | string | null | No | — | Name of the deployment to route this execution to | | `encoded_input` | object | No | — | Encoded input to the workflow, used when payload encoding is enabled. | | | `execution_id` | string | null | No | — | Allows you to specify a custom execution ID. If not provided, a random ID will be generated. | | `input` | object | No | — | The input to the workflow. This should be a dictionary that matches the workflow's input schema. | | | `task_queue` | string | null | No | — | Deprecated. Use deployment\_name instead. | | `timeout_seconds` | number | null | No | — | Maximum time to wait for completion when wait\_for\_result is true. | | `wait_for_result` | boolean | No | — | If true, wait for the workflow to complete and return the result directly. | | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "workflow_identifier": { "type": "string", "description": "Workflow Identifier" }, "custom_tracing_attributes": { "type": "object", "description": "Custom Tracing Attributes" }, "deployment_name": { "type": [ "string", "null" ], "description": "Name of the deployment to route this execution to" }, "encoded_input": { "type": "object", "description": "Encoded input to the workflow, used when payload encoding is enabled.", "properties": { "b64payload": { "type": "string", "description": "The encoded payload" }, "encoding_options": { "type": "array", "items": { "type": "string", "enum": [ "offloaded", "encrypted", "encrypted-partial" ] }, "description": "The encoding of the payload" }, "empty": { "type": "boolean", "description": "Whether the payload is empty" } }, "required": [ "b64payload" ] }, "execution_id": { "type": [ "string", "null" ], "description": "Allows you to specify a custom execution ID. If not provided, a random ID will be generated." }, "input": { "type": "object", "description": "The input to the workflow. This should be a dictionary that matches the workflow's input schema." }, "task_queue": { "type": [ "string", "null" ], "description": "Deprecated. Use deployment_name instead." }, "timeout_seconds": { "type": [ "number", "null" ], "description": "Maximum time to wait for completion when wait_for_result is true." }, "wait_for_result": { "type": "boolean", "description": "If true, wait for the workflow to complete and return the result directly." } }, "required": [ "PCID", "workflow_identifier" ] } ``` *** ## mistral\_workflows\_get\_deployment\_v1\_workflows\_deployments\_name\_get Get Deployment **Parameters:** | Parameter | Type | Required | Default | Description | | --------- | ------ | -------- | ------- | -------------- | | `name` | string | Yes | — | The name value | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "name": { "type": "string", "description": "The name value" } }, "required": [ "PCID", "name" ] } ``` *** ## mistral\_workflows\_get\_run\_history\_v1\_workflows\_runs\_run\_id\_history\_get Get Run History **Parameters:** | Parameter | Type | Required | Default | Description | | ----------------- | ------- | -------- | ------- | --------------- | | `run_id` | string | Yes | — | Run Id | | `decode_payloads` | boolean | No | — | Decode Payloads | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "run_id": { "type": "string", "description": "Run Id" }, "decode_payloads": { "type": "boolean", "description": "Decode Payloads" } }, "required": [ "PCID", "run_id" ] } ``` *** ## mistral\_workflows\_get\_run\_v1\_workflows\_runs\_run\_id\_get Get Run **Parameters:** | Parameter | Type | Required | Default | Description | | --------- | ------ | -------- | ------- | ----------- | | `run_id` | string | Yes | — | Run Id | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "run_id": { "type": "string", "description": "Run Id" } }, "required": [ "PCID", "run_id" ] } ``` *** ## mistral\_workflows\_get\_schedules\_v1\_workflows\_schedules\_get Get Schedules ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" } }, "required": [ "PCID" ] } ``` *** ## mistral\_workflows\_get\_stream\_events\_v1\_workflows\_events\_stream\_get Get Stream Events **Parameters:** | Parameter | Type | Required | Default | Description | | ------------------------- | --------- | -------- | ------- | ----------------------- | | `scope` | string | No | — | The scope value | | `activity_name` | string | No | — | Activity Name | | `activity_id` | string | No | — | Activity Id | | `workflow_name` | string | No | — | Workflow Name | | `workflow_exec_id` | string | No | — | Workflow Exec Id | | `root_workflow_exec_id` | string | No | — | Root Workflow Exec Id | | `parent_workflow_exec_id` | string | No | — | Parent Workflow Exec Id | | `stream` | string | No | — | The stream value | | `start_seq` | integer | No | — | Start Seq | | `metadata_filters` | object | No | — | Metadata Filters | | `workflow_event_types` | string\[] | No | — | Workflow Event Types | | `last-event-id` | string | No | — | The last-event-id value | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "scope": { "type": "string", "description": "The scope value", "enum": [ "activity", "workflow", "*" ] }, "activity_name": { "type": "string", "description": "Activity Name" }, "activity_id": { "type": "string", "description": "Activity Id" }, "workflow_name": { "type": "string", "description": "Workflow Name" }, "workflow_exec_id": { "type": "string", "description": "Workflow Exec Id" }, "root_workflow_exec_id": { "type": "string", "description": "Root Workflow Exec Id" }, "parent_workflow_exec_id": { "type": "string", "description": "Parent Workflow Exec Id" }, "stream": { "type": "string", "description": "The stream value" }, "start_seq": { "type": "integer", "description": "Start Seq" }, "metadata_filters": { "type": "object", "description": "Metadata Filters" }, "workflow_event_types": { "type": "array", "items": { "type": "string", "enum": [ "WORKFLOW_EXECUTION_STARTED", "WORKFLOW_EXECUTION_COMPLETED", "WORKFLOW_EXECUTION_FAILED", "WORKFLOW_EXECUTION_CANCELED", "WORKFLOW_EXECUTION_CONTINUED_AS_NEW", "WORKFLOW_TASK_TIMED_OUT", "WORKFLOW_TASK_FAILED", "CUSTOM_TASK_STARTED", "CUSTOM_TASK_IN_PROGRESS", "CUSTOM_TASK_COMPLETED", "CUSTOM_TASK_FAILED", "CUSTOM_TASK_TIMED_OUT", "CUSTOM_TASK_CANCELED", "ACTIVITY_TASK_STARTED", "ACTIVITY_TASK_COMPLETED", "ACTIVITY_TASK_RETRYING", "ACTIVITY_TASK_FAILED" ] }, "description": "Workflow Event Types" }, "last-event-id": { "type": "string", "description": "The last-event-id value" } }, "required": [ "PCID" ] } ``` *** ## mistral\_workflows\_get\_worker\_info\_v1\_workflows\_workers\_whoami\_get Get Worker Info ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" } }, "required": [ "PCID" ] } ``` *** ## mistral\_workflows\_get\_workflow\_events\_v1\_workflows\_events\_list\_get Get Workflow Events **Parameters:** | Parameter | Type | Required | Default | Description | | ----------------------- | ------- | -------- | ------- | ---------------------------------------------------------------------- | | `root_workflow_exec_id` | string | No | — | Execution ID of the root workflow that initiated this execution chain. | | `workflow_exec_id` | string | No | — | Execution ID of the workflow that emitted this event. | | `workflow_run_id` | string | No | — | Run ID of the workflow that emitted this event. | | `limit` | integer | No | — | Maximum number of events to return. | | `cursor` | string | No | — | Cursor for pagination. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "root_workflow_exec_id": { "type": "string", "description": "Execution ID of the root workflow that initiated this execution chain." }, "workflow_exec_id": { "type": "string", "description": "Execution ID of the workflow that emitted this event." }, "workflow_run_id": { "type": "string", "description": "Run ID of the workflow that emitted this event." }, "limit": { "type": "integer", "description": "Maximum number of events to return." }, "cursor": { "type": "string", "description": "Cursor for pagination." } }, "required": [ "PCID" ] } ``` *** ## mistral\_workflows\_get\_workflow\_execution\_history\_v1\_workflows\_executions\_execution\_id\_history\_get Get Workflow Execution History **Parameters:** | Parameter | Type | Required | Default | Description | | ----------------- | ------- | -------- | ------- | --------------- | | `execution_id` | string | Yes | — | Execution Id | | `decode_payloads` | boolean | No | — | Decode Payloads | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "execution_id": { "type": "string", "description": "Execution Id" }, "decode_payloads": { "type": "boolean", "description": "Decode Payloads" } }, "required": [ "PCID", "execution_id" ] } ``` *** ## mistral\_workflows\_get\_workflow\_execution\_trace\_events Get Workflow Execution Trace Events **Parameters:** | Parameter | Type | Required | Default | Description | | ------------------------- | ------- | -------- | ------- | ----------------------- | | `execution_id` | string | Yes | — | Execution Id | | `merge_same_id_events` | boolean | No | — | Merge Same Id Events | | `include_internal_events` | boolean | No | — | Include Internal Events | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "execution_id": { "type": "string", "description": "Execution Id" }, "merge_same_id_events": { "type": "boolean", "description": "Merge Same Id Events" }, "include_internal_events": { "type": "boolean", "description": "Include Internal Events" } }, "required": [ "PCID", "execution_id" ] } ``` *** ## mistral\_workflows\_get\_workflow\_execution\_trace\_otel Get Workflow Execution Trace Otel **Parameters:** | Parameter | Type | Required | Default | Description | | -------------- | ------ | -------- | ------- | ------------ | | `execution_id` | string | Yes | — | Execution Id | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "execution_id": { "type": "string", "description": "Execution Id" } }, "required": [ "PCID", "execution_id" ] } ``` *** ## mistral\_workflows\_get\_workflow\_execution\_trace\_summary Get Workflow Execution Trace Summary **Parameters:** | Parameter | Type | Required | Default | Description | | -------------- | ------ | -------- | ------- | ------------ | | `execution_id` | string | Yes | — | Execution Id | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "execution_id": { "type": "string", "description": "Execution Id" } }, "required": [ "PCID", "execution_id" ] } ``` *** ## mistral\_workflows\_get\_workflow\_execution\_v1\_workflows\_executions\_execution\_id\_get Get Workflow Execution **Parameters:** | Parameter | Type | Required | Default | Description | | -------------- | ------ | -------- | ------- | ------------ | | `execution_id` | string | Yes | — | Execution Id | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "execution_id": { "type": "string", "description": "Execution Id" } }, "required": [ "PCID", "execution_id" ] } ``` *** ## mistral\_workflows\_get\_workflow\_metrics\_v1\_workflows\_workflow\_name\_metrics\_get Get Workflow Metrics **Parameters:** | Parameter | Type | Required | Default | Description | | --------------- | ------ | -------- | ------- | ---------------------------------------------------- | | `workflow_name` | string | Yes | — | Workflow Name | | `start_time` | string | No | — | Filter workflows started after this time (ISO 8601) | | `end_time` | string | No | — | Filter workflows started before this time (ISO 8601) | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "workflow_name": { "type": "string", "description": "Workflow Name" }, "start_time": { "type": "string", "description": "Filter workflows started after this time (ISO 8601)" }, "end_time": { "type": "string", "description": "Filter workflows started before this time (ISO 8601)" } }, "required": [ "PCID", "workflow_name" ] } ``` *** ## mistral\_workflows\_get\_workflow\_registration\_v1\_workflows\_registrations\_workflow\_registration\_id\_get Get Workflow Registration **Parameters:** | Parameter | Type | Required | Default | Description | | -------------------------- | ------- | -------- | ------- | ------------------------------------------- | | `workflow_registration_id` | string | Yes | — | Workflow Registration Id | | `with_workflow` | boolean | No | — | Whether to include the workflow definition | | `include_shared` | boolean | No | — | Whether to include shared workflow versions | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "workflow_registration_id": { "type": "string", "description": "Workflow Registration Id" }, "with_workflow": { "type": "boolean", "description": "Whether to include the workflow definition" }, "include_shared": { "type": "boolean", "description": "Whether to include shared workflow versions" } }, "required": [ "PCID", "workflow_registration_id" ] } ``` *** ## mistral\_workflows\_get\_workflow\_registrations\_v1\_workflows\_registrations\_get Get Workflow Registrations **Parameters:** | Parameter | Type | Required | Default | Description | | ----------------------------- | ------- | -------- | ------- | -------------------------------------------------------------------------------------- | | `workflow_id` | string | No | — | The workflow ID to filter by | | `task_queue` | string | No | — | The task queue to filter by | | `active_only` | boolean | No | — | Whether to only return active workflows versions | | `include_shared` | boolean | No | — | Whether to include shared workflow versions | | `workflow_search` | string | No | — | The workflow name to filter by | | `archived` | boolean | No | — | Filter by archived state. False=exclude archived, True=only archived, None=include all | | `with_workflow` | boolean | No | — | Whether to include the workflow definition | | `available_in_chat_assistant` | boolean | No | — | Whether to only return workflows compatible with chat assistant | | `limit` | integer | No | — | The maximum number of workflows versions to return | | `cursor` | string | No | — | The cursor for pagination | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "workflow_id": { "type": "string", "description": "The workflow ID to filter by" }, "task_queue": { "type": "string", "description": "The task queue to filter by" }, "active_only": { "type": "boolean", "description": "Whether to only return active workflows versions" }, "include_shared": { "type": "boolean", "description": "Whether to include shared workflow versions" }, "workflow_search": { "type": "string", "description": "The workflow name to filter by" }, "archived": { "type": "boolean", "description": "Filter by archived state. False=exclude archived, True=only archived, None=include all" }, "with_workflow": { "type": "boolean", "description": "Whether to include the workflow definition" }, "available_in_chat_assistant": { "type": "boolean", "description": "Whether to only return workflows compatible with chat assistant" }, "limit": { "type": "integer", "description": "The maximum number of workflows versions to return" }, "cursor": { "type": "string", "description": "The cursor for pagination" } }, "required": [ "PCID" ] } ``` *** ## mistral\_workflows\_get\_workflow\_v1\_workflows\_workflow\_identifier\_get Get Workflow **Parameters:** | Parameter | Type | Required | Default | Description | | --------------------- | ------ | -------- | ------- | ------------------- | | `workflow_identifier` | string | Yes | — | Workflow Identifier | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "workflow_identifier": { "type": "string", "description": "Workflow Identifier" } }, "required": [ "PCID", "workflow_identifier" ] } ``` *** ## mistral\_workflows\_list\_deployments\_v1\_workflows\_deployments\_get List Deployments **Parameters:** | Parameter | Type | Required | Default | Description | | --------------- | ------- | -------- | ------- | ------------- | | `active_only` | boolean | No | — | Active Only | | `workflow_name` | string | No | — | Workflow Name | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "active_only": { "type": "boolean", "description": "Active Only" }, "workflow_name": { "type": "string", "description": "Workflow Name" } }, "required": [ "PCID" ] } ``` *** ## mistral\_workflows\_list\_runs\_v1\_workflows\_runs\_get List Runs **Parameters:** | Parameter | Type | Required | Default | Description | | --------------------- | ------- | -------- | ------- | ------------------------------------------- | | `workflow_identifier` | string | No | — | Filter by workflow name or id | | `search` | string | No | — | Search by workflow name, display name or id | | `status` | object | No | — | Filter by workflow status | | `page_size` | integer | No | — | Number of items per page | | `next_page_token` | string | No | — | Token for the next page of results | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "workflow_identifier": { "type": "string", "description": "Filter by workflow name or id" }, "search": { "type": "string", "description": "Search by workflow name, display name or id" }, "status": { "description": "Filter by workflow status" }, "page_size": { "type": "integer", "description": "Number of items per page" }, "next_page_token": { "type": "string", "description": "Token for the next page of results" } }, "required": [ "PCID" ] } ``` *** ## mistral\_workflows\_query\_workflow\_execution\_v1\_workflows\_executions\_execution\_id\_queries\_post Query Workflow Execution **Parameters:** | Parameter | Type | Required | Default | Description | | -------------- | ------ | -------- | ------- | --------------------------------------------- | | `execution_id` | string | Yes | — | Execution Id | | `input` | object | No | — | Input data for the query, matching its schema | | `name` | string | Yes | — | The name of the query to request | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "execution_id": { "type": "string", "description": "Execution Id" }, "input": { "description": "Input data for the query, matching its schema" }, "name": { "type": "string", "description": "The name of the query to request" } }, "required": [ "PCID", "execution_id", "name" ] } ``` *** ## mistral\_workflows\_reset\_workflow\_v1\_workflows\_executions\_execution\_id\_reset\_post Reset Workflow **Parameters:** | Parameter | Type | Required | Default | Description | | | ----------------- | ------- | -------- | ------- | -------------------------------------------------------------- | ------------------------------------------- | | `execution_id` | string | Yes | — | Execution Id | | | `event_id` | integer | Yes | — | The event ID to reset the workflow execution to | | | `exclude_signals` | boolean | No | — | Whether to exclude signals that happened after the reset point | | | `exclude_updates` | boolean | No | — | Whether to exclude updates that happened after the reset point | | | `reason` | string | null | No | — | Reason for resetting the workflow execution | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "execution_id": { "type": "string", "description": "Execution Id" }, "event_id": { "type": "integer", "description": "The event ID to reset the workflow execution to" }, "exclude_signals": { "type": "boolean", "description": "Whether to exclude signals that happened after the reset point" }, "exclude_updates": { "type": "boolean", "description": "Whether to exclude updates that happened after the reset point" }, "reason": { "type": [ "string", "null" ], "description": "Reason for resetting the workflow execution" } }, "required": [ "PCID", "execution_id", "event_id" ] } ``` *** ## mistral\_workflows\_schedule\_workflow\_v1\_workflows\_schedules\_post Schedule Workflow **Parameters:** | Parameter | Type | Required | Default | Description | | | -------------------------- | ------ | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------- | | `deployment_name` | string | null | No | — | Name of the deployment to route this schedule to | | `schedule` | object | Yes | — | Specification of the times scheduled actions may occur. The times are the union of :py:attr:`calendars`, :py:attr:`intervals`, and :py:attr:`cron_expressions` excluding anything in :py:attr:`skip`. Used for input where schedule\_id is optional (can be provided or auto-generated). | | | `schedule_id` | string | null | No | — | Allows you to specify a custom schedule ID. If not provided, a random ID will be generated. | | `workflow_identifier` | string | null | No | — | The name or ID of the workflow to schedule | | `workflow_registration_id` | string | null | No | — | The ID of the workflow registration to schedule | | `workflow_task_queue` | string | null | No | — | Deprecated. Use deployment\_name instead. | | `workflow_version_id` | string | null | No | — | Deprecated: use workflow\_registration\_id | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "deployment_name": { "type": [ "string", "null" ], "description": "Name of the deployment to route this schedule to" }, "schedule": { "type": "object", "description": "Specification of the times scheduled actions may occur. The times are the union of :py:attr:`calendars`, :py:attr:`intervals`, and :py:attr:`cron_expressions` excluding anything in :py:attr:`skip`. Used for input where schedule_id is optional (can be provided or auto-generated).", "properties": { "input": { "description": "Input to provide to the workflow when starting it." }, "calendars": { "type": "array", "items": { "type": "object" }, "description": "Calendar-based specification of times." }, "intervals": { "type": "array", "items": { "type": "object" }, "description": "Interval-based specification of times." }, "cron_expressions": { "type": "array", "items": { "type": "string" }, "description": "Cron-based specification of times." }, "skip": { "type": "array", "items": { "type": "object" }, "description": "Set of calendar times to skip." }, "start_at": { "type": "string", "description": "Time after which the first action may be run." }, "end_at": { "type": "string", "description": "Time after which no more actions will be run." }, "jitter": { "type": "string", "description": "Jitter to apply each action. An action's scheduled time will be incremented by a random value between 0 and this value if present (but not past the next schedule)." }, "time_zone_name": { "type": "string", "description": "IANA time zone name, for example ``US/Central``." }, "policy": { "type": "object", "description": "The policy value" }, "schedule_id": { "type": "string", "description": "Unique identifier for the schedule." } }, "required": [ "input" ] }, "schedule_id": { "type": [ "string", "null" ], "description": "Allows you to specify a custom schedule ID. If not provided, a random ID will be generated." }, "workflow_identifier": { "type": [ "string", "null" ], "description": "The name or ID of the workflow to schedule" }, "workflow_registration_id": { "type": [ "string", "null" ], "description": "The ID of the workflow registration to schedule" }, "workflow_task_queue": { "type": [ "string", "null" ], "description": "Deprecated. Use deployment_name instead." }, "workflow_version_id": { "type": [ "string", "null" ], "description": "Deprecated: use workflow_registration_id" } }, "required": [ "PCID", "schedule" ] } ``` *** ## mistral\_workflows\_signal\_workflow\_execution\_v1\_workflows\_executions\_execution\_id\_signals\_post Signal Workflow Execution **Parameters:** | Parameter | Type | Required | Default | Description | | -------------- | ------ | -------- | ------- | ---------------------------------------------- | | `execution_id` | string | Yes | — | Execution Id | | `input` | object | No | — | Input data for the signal, matching its schema | | `name` | string | Yes | — | The name of the signal to send | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "execution_id": { "type": "string", "description": "Execution Id" }, "input": { "description": "Input data for the signal, matching its schema" }, "name": { "type": "string", "description": "The name of the signal to send" } }, "required": [ "PCID", "execution_id", "name" ] } ``` *** ## mistral\_workflows\_stream\_v1\_workflows\_executions\_execution\_id\_stream\_get Stream **Parameters:** | Parameter | Type | Required | Default | Description | | --------------- | ------ | -------- | ------- | ------------- | | `execution_id` | string | Yes | — | Execution Id | | `event_source` | string | No | — | Event Source | | `last_event_id` | string | No | — | Last Event Id | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "execution_id": { "type": "string", "description": "Execution Id" }, "event_source": { "type": "string", "description": "Event Source", "enum": [ "DATABASE", "LIVE" ] }, "last_event_id": { "type": "string", "description": "Last Event Id" } }, "required": [ "PCID", "execution_id" ] } ``` *** ## mistral\_workflows\_terminate\_workflow\_execution\_v1\_workflows\_executions\_execution\_id\_terminate\_post Terminate Workflow Execution **Parameters:** | Parameter | Type | Required | Default | Description | | -------------- | ------ | -------- | ------- | ------------ | | `execution_id` | string | Yes | — | Execution Id | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "execution_id": { "type": "string", "description": "Execution Id" } }, "required": [ "PCID", "execution_id" ] } ``` *** ## mistral\_workflows\_unarchive\_workflow\_v1\_workflows\_workflow\_identifier\_unarchive\_put Unarchive Workflow **Parameters:** | Parameter | Type | Required | Default | Description | | --------------------- | ------ | -------- | ------- | ------------------- | | `workflow_identifier` | string | Yes | — | Workflow Identifier | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "workflow_identifier": { "type": "string", "description": "Workflow Identifier" } }, "required": [ "PCID", "workflow_identifier" ] } ``` *** ## mistral\_workflows\_unschedule\_workflow\_v1\_workflows\_schedules\_schedule\_id\_delete Unschedule Workflow **Parameters:** | Parameter | Type | Required | Default | Description | | ------------- | ------ | -------- | ------- | ----------- | | `schedule_id` | string | Yes | — | Schedule Id | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "schedule_id": { "type": "string", "description": "Schedule Id" } }, "required": [ "PCID", "schedule_id" ] } ``` *** ## mistral\_workflows\_update\_workflow\_execution\_v1\_workflows\_executions\_execution\_id\_updates\_post Update Workflow Execution **Parameters:** | Parameter | Type | Required | Default | Description | | -------------- | ------ | -------- | ------- | ---------------------------------------------- | | `execution_id` | string | Yes | — | Execution Id | | `input` | object | No | — | Input data for the update, matching its schema | | `name` | string | Yes | — | The name of the update to request | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "execution_id": { "type": "string", "description": "Execution Id" }, "input": { "description": "Input data for the update, matching its schema" }, "name": { "type": "string", "description": "The name of the update to request" } }, "required": [ "PCID", "execution_id", "name" ] } ``` *** ## mistral\_workflows\_update\_workflow\_v1\_workflows\_workflow\_identifier\_put Update Workflow **Parameters:** | Parameter | Type | Required | Default | Description | | | ----------------------------- | ------- | -------- | ------- | ------------------- | ------------------------------------------------------------ | | `workflow_identifier` | string | Yes | — | Workflow Identifier | | | `available_in_chat_assistant` | boolean | null | No | — | Whether to make the workflow available in the chat assistant | | `description` | string | null | No | — | New description value | | `display_name` | string | null | No | — | New display name value | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "workflow_identifier": { "type": "string", "description": "Workflow Identifier" }, "available_in_chat_assistant": { "type": [ "boolean", "null" ], "description": "Whether to make the workflow available in the chat assistant" }, "description": { "type": [ "string", "null" ], "description": "New description value" }, "display_name": { "type": [ "string", "null" ], "description": "New display name value" } }, "required": [ "PCID", "workflow_identifier" ] } ```