Skip to main content
Temporal logo
  • Category: developer tools
  • Auth: API_KEY
  • Composio-managed OAuth available? N/A
  • Tools: 63
  • Triggers: 0
  • Slug: TEMPORAL
  • Version: 20261101_00

Tools

Slug: TEMPORAL_BATCH_CANCEL_WORKFLOWSRequest cancellation of selected Temporal Workflows. Cancellation is cooperative: Workflow code can perform cleanup and external side effects before closing. Preview the exact Visibility query with COUNT_WORKFLOWS and obtain approval for the observed scope; its approximate count is not a hard upper bound because matches can change. Use explicit target_executions when a fixed cardinality bound is required. A stable job_id identifies this operation but does not make retries idempotently successful. After an ambiguous timeout, a retry may return 409 because Temporal rejects duplicate job IDs. Call DESCRIBE_BATCH_OPERATION with the same namespace_id and job_id to reconcile before creating any other batch operation. Requires Namespace Write access.

Input Parameters

string
required
Stable ID that identifies this batch operation. Temporal rejects duplicate job IDs instead of treating a retry as idempotent success. After an ambiguous timeout, a retry with this ID may return a conflict even if the operation started; call DESCRIBE_BATCH_OPERATION with the same namespace_id and job_id to reconcile before creating any other batch operation.
string
required
Human-readable audit reason recorded for this batch operation.
string
Optional caller name recorded by Temporal for audit attribution. Keep the default unless a specific service or operator identity should be recorded.
string
required
Full Temporal Cloud Namespace ID including its account suffix. This validated value deterministically selects its web.tmprl.cloud host.
string
SQL-like filter scoped to this Namespace. Attribute names are case-sensitive. Use =, !=, >, >=, <, <=, IN (…), BETWEEN … AND …, IS NULL, IS NOT NULL, STARTS_WITH, AND, OR, and parentheses. Quote strings and RFC3339 timestamps with single or double quotes; wrap custom attribute names containing non-alphanumeric characters in backticks. Common attributes include WorkflowId, WorkflowType, ExecutionStatus, StartTime, CloseTime, ExecutionTime, RunId, and TaskQueue. Temporal Cloud does not support ORDER BY. Example: ExecutionStatus = 'Running' AND WorkflowType = 'OrderWorkflow'. Before starting, call COUNT_WORKFLOWS with this exact query and obtain approval for the observed scope. Its count is approximate and matches can change, so the preview is not a hard upper bound. Mutually exclusive with target_executions.
array
Explicit non-empty Workflow targets. Use these instead of a Visibility query when the list length must be a hard cardinality bound. Mutually exclusive with visibility_query.
number
Positive processing-rate ceiling. Temporal may enforce a lower rate. This limits throughput, not the number of matching Workflows, and is not a cardinality safety bound.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TEMPORAL_BATCH_DELETE_WORKFLOWSWARNING: Permanently delete selected Temporal Workflow Executions and their Event Histories. This cannot be undone. Preview the exact Visibility query with COUNT_WORKFLOWS and obtain approval for the observed scope; its approximate count is not a hard upper bound because matches can change. Use explicit target_executions when a fixed cardinality bound is required. A stable job_id identifies this operation but does not make retries idempotently successful. After an ambiguous timeout, a retry may return 409 because Temporal rejects duplicate job IDs. Call DESCRIBE_BATCH_OPERATION with the same namespace_id and job_id to reconcile before creating any other batch operation. Requires Namespace Write access.

Input Parameters

string
required
Stable ID that identifies this batch operation. Temporal rejects duplicate job IDs instead of treating a retry as idempotent success. After an ambiguous timeout, a retry with this ID may return a conflict even if the operation started; call DESCRIBE_BATCH_OPERATION with the same namespace_id and job_id to reconcile before creating any other batch operation.
string
required
Human-readable audit reason recorded for this batch operation.
string
Optional caller name recorded by Temporal for audit attribution. Keep the default unless a specific service or operator identity should be recorded.
string
required
Full Temporal Cloud Namespace ID including its account suffix. This validated value deterministically selects its web.tmprl.cloud host.
string
SQL-like filter scoped to this Namespace. Attribute names are case-sensitive. Use =, !=, >, >=, <, <=, IN (…), BETWEEN … AND …, IS NULL, IS NOT NULL, STARTS_WITH, AND, OR, and parentheses. Quote strings and RFC3339 timestamps with single or double quotes; wrap custom attribute names containing non-alphanumeric characters in backticks. Common attributes include WorkflowId, WorkflowType, ExecutionStatus, StartTime, CloseTime, ExecutionTime, RunId, and TaskQueue. Temporal Cloud does not support ORDER BY. Example: ExecutionStatus = 'Running' AND WorkflowType = 'OrderWorkflow'. Before starting, call COUNT_WORKFLOWS with this exact query and obtain approval for the observed scope. Its count is approximate and matches can change, so the preview is not a hard upper bound. Mutually exclusive with target_executions.
array
Explicit non-empty Workflow targets. Use these instead of a Visibility query when the list length must be a hard cardinality bound. Mutually exclusive with visibility_query.
number
Positive processing-rate ceiling. Temporal may enforce a lower rate. This limits throughput, not the number of matching Workflows, and is not a cardinality safety bound.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TEMPORAL_BATCH_RESET_WORKFLOWSWARNING: Irreversibly reset selected Temporal Workflows. Each successful reset terminates the current run and creates a new run; replay and reapplied events can repeat application code and external side effects. Preview the exact Visibility query with COUNT_WORKFLOWS and obtain approval for the observed scope; its approximate count is not a hard upper bound because matches can change. Use explicit target_executions when a fixed cardinality bound is required. A stable job_id identifies this operation but does not make retries idempotently successful. After an ambiguous timeout, a retry may return 409 because Temporal rejects duplicate job IDs. Call DESCRIBE_BATCH_OPERATION with the same namespace_id and job_id to reconcile before creating any other batch operation. Requires Namespace Write access.

Input Parameters

string
required
Stable ID that identifies this batch operation. Temporal rejects duplicate job IDs instead of treating a retry as idempotent success. After an ambiguous timeout, a retry with this ID may return a conflict even if the operation started; call DESCRIBE_BATCH_OPERATION with the same namespace_id and job_id to reconcile before creating any other batch operation.
string
required
Human-readable audit reason recorded for this batch operation.
object
required
Typed reset point and event-reapplication policy. Every selected current run is terminated and replaced by a new run when its reset succeeds.
string
Optional caller name recorded by Temporal for audit attribution. Keep the default unless a specific service or operator identity should be recorded.
string
required
Full Temporal Cloud Namespace ID including its account suffix. This validated value deterministically selects its web.tmprl.cloud host.
string
SQL-like filter scoped to this Namespace. Attribute names are case-sensitive. Use =, !=, >, >=, <, <=, IN (…), BETWEEN … AND …, IS NULL, IS NOT NULL, STARTS_WITH, AND, OR, and parentheses. Quote strings and RFC3339 timestamps with single or double quotes; wrap custom attribute names containing non-alphanumeric characters in backticks. Common attributes include WorkflowId, WorkflowType, ExecutionStatus, StartTime, CloseTime, ExecutionTime, RunId, and TaskQueue. Temporal Cloud does not support ORDER BY. Example: ExecutionStatus = 'Running' AND WorkflowType = 'OrderWorkflow'. Before starting, call COUNT_WORKFLOWS with this exact query and obtain approval for the observed scope. Its count is approximate and matches can change, so the preview is not a hard upper bound. Mutually exclusive with target_executions.
array
Explicit non-empty Workflow targets. Use these instead of a Visibility query when the list length must be a hard cardinality bound. Mutually exclusive with visibility_query.
number
Positive processing-rate ceiling. Temporal may enforce a lower rate. This limits throughput, not the number of matching Workflows, and is not a cardinality safety bound.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TEMPORAL_BATCH_SIGNAL_WORKFLOWSSend a named Signal to selected Temporal Workflows. Signal handlers run application code and can cause arbitrary, non-idempotent external side effects. Preview the exact Visibility query with COUNT_WORKFLOWS and obtain approval for the observed scope; its approximate count is not a hard upper bound because matches can change. Use explicit target_executions when a fixed cardinality bound is required. A stable job_id identifies this operation but does not make retries idempotently successful. After an ambiguous timeout, a retry may return 409 because Temporal rejects duplicate job IDs. Call DESCRIBE_BATCH_OPERATION with the same namespace_id and job_id to reconcile before creating any other batch operation. Requires Namespace Write access.

Input Parameters

string
required
Stable ID that identifies this batch operation. Temporal rejects duplicate job IDs instead of treating a retry as idempotent success. After an ambiguous timeout, a retry with this ID may return a conflict even if the operation started; call DESCRIBE_BATCH_OPERATION with the same namespace_id and job_id to reconcile before creating any other batch operation.
string
required
Human-readable audit reason recorded for this batch operation.
string
Optional caller name recorded by Temporal for audit attribution. Keep the default unless a specific service or operator identity should be recorded.
array
Signal arguments as ordinary JSON values. Each value is encoded as one Temporal json/plain Payload. Mutually exclusive with raw_payloads.
string
required
Workflow-author-defined Signal name sent to every selected Workflow.
string
required
Full Temporal Cloud Namespace ID including its account suffix. This validated value deterministically selects its web.tmprl.cloud host.
array
Exact custom-codec Signal Payloads. Mutually exclusive with arguments.
string
SQL-like filter scoped to this Namespace. Attribute names are case-sensitive. Use =, !=, >, >=, <, <=, IN (…), BETWEEN … AND …, IS NULL, IS NOT NULL, STARTS_WITH, AND, OR, and parentheses. Quote strings and RFC3339 timestamps with single or double quotes; wrap custom attribute names containing non-alphanumeric characters in backticks. Common attributes include WorkflowId, WorkflowType, ExecutionStatus, StartTime, CloseTime, ExecutionTime, RunId, and TaskQueue. Temporal Cloud does not support ORDER BY. Example: ExecutionStatus = 'Running' AND WorkflowType = 'OrderWorkflow'. Before starting, call COUNT_WORKFLOWS with this exact query and obtain approval for the observed scope. Its count is approximate and matches can change, so the preview is not a hard upper bound. Mutually exclusive with target_executions.
array
Explicit non-empty Workflow targets. Use these instead of a Visibility query when the list length must be a hard cardinality bound. Mutually exclusive with visibility_query.
number
Positive processing-rate ceiling. Temporal may enforce a lower rate. This limits throughput, not the number of matching Workflows, and is not a cardinality safety bound.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TEMPORAL_BATCH_TERMINATE_WORKFLOWSWARNING: Irreversibly terminate selected Temporal Workflows immediately; Workflow cleanup code does not run. Preview the exact Visibility query with COUNT_WORKFLOWS and obtain approval for the observed scope; its approximate count is not a hard upper bound because matches can change. Use explicit target_executions when a fixed cardinality bound is required. A stable job_id identifies this operation but does not make retries idempotently successful. After an ambiguous timeout, a retry may return 409 because Temporal rejects duplicate job IDs. Call DESCRIBE_BATCH_OPERATION with the same namespace_id and job_id to reconcile before creating any other batch operation. Requires Namespace Write access.

Input Parameters

string
required
Stable ID that identifies this batch operation. Temporal rejects duplicate job IDs instead of treating a retry as idempotent success. After an ambiguous timeout, a retry with this ID may return a conflict even if the operation started; call DESCRIBE_BATCH_OPERATION with the same namespace_id and job_id to reconcile before creating any other batch operation.
string
required
Human-readable audit reason recorded for this batch operation.
array
Optional termination details as ordinary JSON values. Each value is encoded as one Temporal json/plain Payload. Mutually exclusive with raw_payloads.
string
Optional caller name recorded by Temporal for audit attribution. Keep the default unless a specific service or operator identity should be recorded.
string
required
Full Temporal Cloud Namespace ID including its account suffix. This validated value deterministically selects its web.tmprl.cloud host.
array
Optional exact custom-codec termination Payloads. Mutually exclusive with details.
string
SQL-like filter scoped to this Namespace. Attribute names are case-sensitive. Use =, !=, >, >=, <, <=, IN (…), BETWEEN … AND …, IS NULL, IS NOT NULL, STARTS_WITH, AND, OR, and parentheses. Quote strings and RFC3339 timestamps with single or double quotes; wrap custom attribute names containing non-alphanumeric characters in backticks. Common attributes include WorkflowId, WorkflowType, ExecutionStatus, StartTime, CloseTime, ExecutionTime, RunId, and TaskQueue. Temporal Cloud does not support ORDER BY. Example: ExecutionStatus = 'Running' AND WorkflowType = 'OrderWorkflow'. Before starting, call COUNT_WORKFLOWS with this exact query and obtain approval for the observed scope. Its count is approximate and matches can change, so the preview is not a hard upper bound. Mutually exclusive with target_executions.
array
Explicit non-empty Workflow targets. Use these instead of a Visibility query when the list length must be a hard cardinality bound. Mutually exclusive with visibility_query.
number
Positive processing-rate ceiling. Temporal may enforce a lower rate. This limits throughput, not the number of matching Workflows, and is not a cardinality safety bound.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TEMPORAL_BATCH_UPDATE_WORKFLOW_OPTIONSUpdate typed execution options on selected Temporal Workflows. Worker routing, task priority, and virtual-time changes can cause application and external side effects. Preview the exact Visibility query with COUNT_WORKFLOWS and obtain approval for the observed scope; its approximate count is not a hard upper bound because matches can change. Use explicit target_executions when a fixed cardinality bound is required. A stable job_id identifies this operation but does not make retries idempotently successful. After an ambiguous timeout, a retry may return 409 because Temporal rejects duplicate job IDs. Call DESCRIBE_BATCH_OPERATION with the same namespace_id and job_id to reconcile before creating any other batch operation. Requires Namespace Write access.

Input Parameters

string
required
Stable ID that identifies this batch operation. Temporal rejects duplicate job IDs instead of treating a retry as idempotent success. After an ambiguous timeout, a retry with this ID may return a conflict even if the operation started; call DESCRIBE_BATCH_OPERATION with the same namespace_id and job_id to reconcile before creating any other batch operation.
string
required
Human-readable audit reason recorded for this batch operation.
string
Optional caller name recorded by Temporal for audit attribution. Keep the default unless a specific service or operator identity should be recorded.
string
required
Full Temporal Cloud Namespace ID including its account suffix. This validated value deterministically selects its web.tmprl.cloud host.
string
SQL-like filter scoped to this Namespace. Attribute names are case-sensitive. Use =, !=, >, >=, <, <=, IN (…), BETWEEN … AND …, IS NULL, IS NOT NULL, STARTS_WITH, AND, OR, and parentheses. Quote strings and RFC3339 timestamps with single or double quotes; wrap custom attribute names containing non-alphanumeric characters in backticks. Common attributes include WorkflowId, WorkflowType, ExecutionStatus, StartTime, CloseTime, ExecutionTime, RunId, and TaskQueue. Temporal Cloud does not support ORDER BY. Example: ExecutionStatus = 'Running' AND WorkflowType = 'OrderWorkflow'. Before starting, call COUNT_WORKFLOWS with this exact query and obtain approval for the observed scope. Its count is approximate and matches can change, so the preview is not a hard upper bound. Mutually exclusive with target_executions.
object
required
Typed Workflow options and exact top-level update mask for every target.
array
Explicit non-empty Workflow targets. Use these instead of a Visibility query when the list length must be a hard cardinality bound. Mutually exclusive with visibility_query.
number
Positive processing-rate ceiling. Temporal may enforce a lower rate. This limits throughput, not the number of matching Workflows, and is not a cardinality safety bound.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TEMPORAL_CANCEL_WORKFLOWIrreversibly request cooperative cancellation of a running Temporal Workflow Execution. Temporal records a cancellation-requested event and schedules a Workflow Task, but the Workflow may delay or ignore cancellation depending on its code. A request for an already-closed Workflow succeeds. Requires Namespace Write access.

Input Parameters

string
Optional human-readable cancellation reason recorded in Event History.
string
Specific run ID to cancel; omit to target the current run.
string
Caller identity recorded in Event History.
string
Stable idempotency ID to reuse when retrying the same cancellation request.
string
required
Application-defined Workflow ID whose execution should be canceled.
string
required
Full Temporal Cloud Namespace ID, including the account suffix. This validated value deterministically selects its web.tmprl.cloud host.
string
Optional execution-chain guard. Temporal rejects the request unless the target run belongs to the chain that began with this run ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TEMPORAL_COUNT_SCHEDULESReturn an approximate count of Temporal Schedules matching a Schedule Visibility query, including grouped counts when requested. Requires Namespace Read access.

Input Parameters

string
Optional SQL-like Temporal Schedule Visibility query. Attribute names are case-sensitive; quote string values and combine predicates with AND or OR.
string
required
Full Temporal Cloud Namespace ID, including the account suffix. This validated value deterministically selects its web.tmprl.cloud host.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TEMPORAL_COUNT_WORKFLOWSReturn an approximate count of Workflow Executions matching a Temporal Visibility query, including supported grouped counts. Requires Namespace Read access.

Input Parameters

string
SQL-like filter scoped to this Namespace. Attribute names are case-sensitive. Use =, !=, >, >=, <, <=, IN (…), BETWEEN … AND …, IS NULL, IS NOT NULL, STARTS_WITH, AND, OR, and parentheses. Quote strings and RFC3339 timestamps with single or double quotes; wrap custom attribute names containing non-alphanumeric characters in backticks. Common attributes include WorkflowId, WorkflowType, ExecutionStatus, StartTime, CloseTime, ExecutionTime, RunId, and TaskQueue. Temporal Cloud does not support ORDER BY. Example: ExecutionStatus = 'Running' AND WorkflowType = 'OrderWorkflow'. This count endpoint additionally supports GROUP BY ExecutionStatus only; counts are approximate.
string
required
Full Temporal Cloud Namespace ID, including the account suffix; this deterministically selects its web.tmprl.cloud host.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TEMPORAL_CREATE_AND_APPLY_WORKFLOW_RULECreate a Namespace-wide Temporal Workflow Rule and immediately start a batch job applying it to matching currently running Workflows. This may pause Activities across many executions and cause irreversible operational effects. Use request_id for idempotent retries. Requires Namespace Write access.

Input Parameters

object
required
Rule ID, Activity trigger, Workflow filter, actions, and expiration.
string
Identity of the actor creating the rule; stored with the rule.
string
Caller-generated request ID used by Temporal to de-duplicate retries.
string
Human-readable description stored with the rule.
string
required
Full Temporal Cloud Namespace ID, including the account suffix. This validated value deterministically selects its web.tmprl.cloud host.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TEMPORAL_CREATE_EXPORT_SINKCreate a persistent Temporal Cloud Workflow History export sink asynchronously. Requires Namespace Admin access. Warning: an enabled sink writes closed Workflow Histories to external storage on an ongoing schedule and may incur storage costs. Validate the destination first, use a disposable sink for testing, and arrange teardown.

Input Parameters

object
required
Export sink name, enabled state, and exactly one of s3, gcs, or azure_blob.
string
required
Full Temporal Cloud Namespace ID, including its account suffix.
string
Optional caller-chosen idempotency ID. Reuse it only when retrying this same creation request.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TEMPORAL_CREATE_SCHEDULECreate a Temporal Schedule that starts a configured Workflow on cron, interval, calendar, or structured-calendar times. The Workflow may perform arbitrary application side effects. Use request_id for idempotent retries. Requires Namespace Write access.

Input Parameters

object
Unindexed Schedule Memo values encoded as Temporal json/plain Payloads.
object
Paused state, notes, and optional action limit for the Schedule.
string
Maximum random positive delay applied to each matching schedule time.
string
Inclusive RFC 3339 time after which no scheduled action may start.
string
Caller identity recorded in Schedule history.
object
Overlap, catchup, failure, and Workflow ID policies for the Schedule.
object
Advanced Temporal Priority protobuf JSON for each started Workflow.
array
Workflow arguments encoded as json/plain Payloads; mutually exclusive with raw_payloads.
array
Labeled calendar expressions; Temporal compiles these into structured calendars.
array
Fixed interval specifications combined with any other supplied timing sources.
string
Idempotency ID; reuse it only when retrying the same intended mutation.
string
Inclusive RFC 3339 time before which no scheduled action may start.
string
required
Task Queue polled by a Worker that supports workflow_type.
string
required
Application-defined Schedule ID unique within the Namespace.
string
Optional Workflow ID used by each scheduled start. Omit it to let Temporal generate a unique Workflow ID.
string
required
Full Temporal Cloud Namespace ID including its account suffix, for example ‘payments.a1b2c’.
array
Exact protobuf-JSON Payloads for custom codecs; mutually exclusive with arguments.
object
Server-side retry policy applied to each scheduled Workflow.
object
Optional Temporal SchedulePatch protobuf JSON applied atomically at creation, for example triggerImmediately, backfillRequest, pause, or unpause.
string
Optional base64 TZif timezone definition used instead of server timezone data.
string
IANA timezone used to interpret cron expressions, such as ‘America/Chicago’.
object
Advanced Temporal UserMetadata protobuf JSON for each started Workflow.
object
Unindexed Memo values attached to each Workflow started by the Schedule.
string
required
Registered Workflow type name implemented by a compatible Worker.
array
Temporal cron expressions combined with any other supplied timing sources.
object
Workflow header fields encoded as Temporal json/plain Payloads.
array
Deprecated labeled calendar expressions whose matching times are excluded.
object
Registered Schedule Search Attribute values encoded as indexed Payloads.
object
Advanced Temporal VersioningOverride protobuf JSON for each started Workflow.
array
Programmatic calendar ranges whose matches are included in the Schedule.
string
Maximum time for one Workflow run as a positive protobuf duration.
string
Maximum time for one Workflow Task as a positive protobuf duration.
string
Maximum total Workflow execution time as a positive protobuf duration.
object
Registered Search Attribute values attached to each started Workflow.
array
Programmatic calendar ranges whose matching times are excluded.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TEMPORAL_CREATE_WORKFLOW_RULECreate a Namespace-wide Temporal Workflow Rule that can pause matching Activities when its trigger occurs. This does not scan currently running Workflows; use Create and Apply Workflow Rule for that separate intent. Use request_id for idempotent retries. Requires Namespace Write access.

Input Parameters

object
required
Rule ID, Activity trigger, Workflow filter, actions, and expiration.
string
Identity of the actor creating the rule; stored with the rule.
string
Caller-generated request ID used by Temporal to de-duplicate retries.
string
Human-readable description stored with the rule.
string
required
Full Temporal Cloud Namespace ID, including the account suffix. This validated value deterministically selects its web.tmprl.cloud host.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TEMPORAL_DELETE_EXPORT_SINKDelete a Temporal Cloud Workflow History export sink asynchronously. Requires Namespace Admin access. WARNING: this irreversibly stops future exports from the sink. Files already exported to external storage remain there and must be managed separately. Confirm the Namespace, sink name, and current resource version before calling.

Input Parameters

string
required
Export sink name to delete. WARNING: deletion stops future Workflow History exports from this sink and cannot be undone; files already exported to external storage are not deleted.
string
required
Full Cloud Namespace ID containing the export sink. Verify this Namespace and sink identify the intended test or disposable export configuration.
string
required
Current resourceVersion from GET_EXPORT_SINK. Re-read the sink immediately before deletion to avoid deleting a configuration that changed.
string
Optional caller-chosen idempotency ID. Reuse it only when retrying this exact export-sink deletion request.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TEMPORAL_DELETE_NAMESPACEPermanently and irreversibly delete a Temporal Cloud Namespace and all of its Workflow data asynchronously. WARNING: there is no recovery or undo. Use only for a verified disposable Namespace after confirming its full ID, contents, latest resource version, and that deletion protection is disabled.

Input Parameters

string
required
Full Cloud Namespace ID from DESCRIBE_NAMESPACE, including its account suffix. WARNING: verify this identifies a disposable Namespace; deletion permanently destroys the Namespace and all of its data.
string
required
Current resourceVersion from DESCRIBE_NAMESPACE. Re-check it immediately before deletion to guard against deleting a Namespace that changed.
string
Optional caller-chosen idempotency ID. Reuse it only when retrying this exact deletion request.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TEMPORAL_DELETE_SCHEDULEPermanently delete one Temporal Schedule from a Namespace. WARNING: schedule deletion cannot be undone, but it does not terminate or otherwise affect Workflow Executions the Schedule already started. Confirm the Namespace and Schedule ID before calling. Requires Namespace Write access.

Input Parameters

string
Caller identity recorded by Temporal. Omit to use composio.
string
required
Application-defined ID of the Schedule to permanently delete.
string
required
Full Temporal Cloud Namespace ID, including the account suffix. This validated value deterministically selects its web.tmprl.cloud host.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TEMPORAL_DELETE_WORKFLOW_RULEPermanently delete one configured Temporal Workflow Rule from a Namespace. WARNING: deletion cannot be undone; after deletion the rule no longer applies to new triggering events. Confirm the Namespace and rule ID before calling. Requires Namespace Write access.

Input Parameters

string
required
User-specified ID of the Workflow Rule to permanently delete.
string
required
Full Temporal Cloud Namespace ID, including the account suffix. This validated value deterministically selects its web.tmprl.cloud host.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TEMPORAL_DESCRIBE_BATCH_OPERATIONReturn progress, state, selection query, type, and failure counts for one batch operation in an authorized Temporal Cloud Namespace. Requires Namespace Read access.

Input Parameters

string
required
Batch job ID returned by LIST_BATCH_OPERATIONS or supplied when the batch started.
string
required
Full Temporal Cloud Namespace ID including its account suffix. This validated value deterministically selects its web.tmprl.cloud host.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TEMPORAL_DESCRIBE_NAMESPACEReturn one Temporal Cloud Namespace’s configuration, resource version, routing endpoints, state, limits, and capacity. Requires Namespace Read access.

Input Parameters

string
required
Full Temporal Cloud Namespace ID, including the account suffix.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TEMPORAL_DESCRIBE_SCHEDULEReturn the complete current definition, state, execution information, Memo, Search Attributes, and conflict token for one Temporal Schedule. Use this before a full replacement update to preserve intended fields and guard against concurrent changes. Requires Namespace Read access.

Input Parameters

string
required
Application-defined ID of the Schedule to describe.
string
required
Full Temporal Cloud Namespace ID, including the account suffix. This validated value deterministically selects its web.tmprl.cloud host.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TEMPORAL_DESCRIBE_WORKFLOWReturn configuration, status, pending work, callbacks, and child state for one Workflow Execution in an authorized Temporal Cloud Namespace. Omit run_id to describe the current run. Requires Namespace Read access.

Input Parameters

string
Specific Workflow run ID. Omit it to describe the current run for the Workflow ID.
string
required
Application-defined Workflow ID, sent unchanged in the request path.
string
required
Full Temporal Cloud Namespace ID, including the account suffix; this validated value deterministically selects its web.tmprl.cloud host.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TEMPORAL_DESCRIBE_WORKFLOW_RULEReturn one configured Temporal Workflow Rule, including its trigger, Visibility query, actions, expiration, creation metadata, and description. Requires Namespace Read access.

Input Parameters

string
required
User-specified ID of the Workflow Rule to describe.
string
required
Full Temporal Cloud Namespace ID, including the account suffix. This validated value deterministically selects its web.tmprl.cloud host.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TEMPORAL_FAILOVER_NAMESPACE_REGIONSwitch a multi-region Temporal Cloud Namespace’s active region asynchronously. WARNING: This operation disrupts current Namespace routing while failover completes. Require explicit approval and a documented rollback or failback plan before calling it.

Input Parameters

string
required
Configured replica region ID to make active. This failover disrupts current Namespace routing while it completes.
string
required
Full multi-region Cloud Namespace ID, including its account suffix.
string
Optional caller-chosen idempotency ID. Reuse it only when retrying this exact failover.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TEMPORAL_GET_ASYNC_OPERATIONReturn the current state and failure details of a Temporal Cloud asynchronous operation.

Input Parameters

string
required
Operation ID returned by a Namespace, export-sink, access, failover, or Project mutation.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TEMPORAL_GET_EXPORT_SINKReturn one Temporal Cloud Workflow History export sink, including its resource version, destination configuration, state, and health. Requires Namespace Read access.

Input Parameters

string
required
Name of the Workflow History export sink to return.
string
required
Full Temporal Cloud Namespace ID, including the account suffix.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TEMPORAL_GET_NAMESPACE_CAPACITYReturn a Temporal Cloud Namespace’s capacity mode, available limits, and seven-day actions-per-second statistics. Requires Namespace Read access.

Input Parameters

string
required
Full Temporal Cloud Namespace ID, including the account suffix.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TEMPORAL_GET_REGIONReturn details for one Temporal Cloud region, including its cloud provider, provider-specific identifier, and human-readable location.

Input Parameters

string
required
Temporal Cloud region ID to return.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TEMPORAL_GET_WORKFLOW_HISTORYReturn one page of a Temporal Workflow Execution’s Event History in forward or reverse order. Requires Namespace Read access.

Input Parameters

string
Specific Workflow run ID; omit to inspect the current run.
string ("FORWARD" | "REVERSE")
Event order: FORWARD for chronological or REVERSE for newest first.
integer
Maximum history events to return in this page.
string
Opaque base64 history cursor returned by the previous call. Continue with the same Namespace, Workflow, run, direction, and filters.
string
required
Application-defined Workflow ID whose Event History to return.
string ("HISTORY_EVENT_FILTER_TYPE_ALL_EVENT" | "HISTORY_EVENT_FILTER_TYPE_CLOSE_EVENT")
Forward only: return all history events or only the close event.
string
required
Full Temporal Cloud Namespace ID including its account suffix. This validated value deterministically selects its web.tmprl.cloud host.
boolean
Forward only: do not retrieve archived Event History.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TEMPORAL_LIST_ARCHIVED_WORKFLOWSReturn one page of archived Workflow Executions matching an exact Temporal Visibility query. Requires Namespace Read access and a Namespace deployment with archival visibility configured and available; the probed Namespace returned HTTP 403 even with inherited Namespace Admin access.

Input Parameters

string
SQL-like filter scoped to this Namespace. Attribute names are case-sensitive. Use =, !=, >, >=, <, <=, IN (…), BETWEEN … AND …, IS NULL, IS NOT NULL, STARTS_WITH, AND, OR, and parentheses. Quote strings and RFC3339 timestamps with single or double quotes; wrap custom attribute names containing non-alphanumeric characters in backticks. Common attributes include WorkflowId, WorkflowType, ExecutionStatus, StartTime, CloseTime, ExecutionTime, RunId, and TaskQueue. Temporal Cloud does not support ORDER BY. Example: ExecutionStatus = 'Running' AND WorkflowType = 'OrderWorkflow'.
integer
Maximum archived Workflow Executions to return in this page.
string
Opaque base64 cursor returned by a previous call; omit for the first page.
string
required
Full Temporal Cloud Namespace ID, including the account suffix; this deterministically selects its web.tmprl.cloud host.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TEMPORAL_LIST_BATCH_OPERATIONSReturn one page of batch operations in an authorized Temporal Cloud Namespace. Requires Namespace Read access.

Input Parameters

integer
Maximum batch operations to return in this page.
string
Opaque base64 cursor returned by a previous call. Omit for the first page and pass it back unchanged to continue.
string
required
Full Temporal Cloud Namespace ID including its account suffix. This validated value deterministically selects its web.tmprl.cloud host.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TEMPORAL_LIST_EXPORT_SINKSReturn one page of Workflow History export sinks configured on a Temporal Cloud Namespace. Requires Namespace Read access.

Input Parameters

integer
Maximum export sinks to return in this page (1-1000).
string
Opaque cursor returned by a previous call; omit for the first page.
string
required
Full Temporal Cloud Namespace ID, including the account suffix.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TEMPORAL_LIST_NAMESPACE_ASSIGNMENTSReturn one page of users, User Groups, or Service Accounts assigned to a Temporal Cloud Namespace. Requires Namespace Read access.

Input Parameters

integer
Maximum assignments to return in this page (1-1000).
string
Exact cursor returned by a previous call for the same principal_type; omit for the first page.
string
required
Full Temporal Cloud Namespace ID, including the account suffix.
string ("USER" | "USER_GROUP" | "SERVICE_ACCOUNT")
required
Assignment collection to list: USER, USER_GROUP, or SERVICE_ACCOUNT.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TEMPORAL_LIST_NAMESPACESReturn one page of Temporal Cloud Namespaces visible to the API-key identity, optionally filtered by name or Project.

Input Parameters

string
Optional Namespace-name filter.
integer
Maximum Namespaces to return in this page (1-1000).
string
Optional Project ID filter.
string
Opaque cursor returned by a previous call; omit for the first page.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TEMPORAL_LIST_REGIONSList currently available Temporal Cloud regions for Namespace placement.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TEMPORAL_LIST_SCHEDULE_MATCHING_TIMESList times within a required start-to-end range that match one Temporal Schedule’s timing specification. Requires Namespace Read access.

Input Parameters

string
required
Required RFC 3339 end of the time range to evaluate.
string
required
Required RFC 3339 start of the time range to evaluate.
string
required
Application-defined ID of the Schedule to evaluate.
string
required
Full Temporal Cloud Namespace ID, including the account suffix. This validated value deterministically selects its web.tmprl.cloud host.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TEMPORAL_LIST_SCHEDULESReturn one filtered page of Temporal Schedules in an authorized Temporal Cloud Namespace. Requires Namespace Read access.

Input Parameters

string
Optional SQL-like Temporal Schedule Visibility query. Attribute names are case-sensitive; quote string values and combine predicates with AND or OR.
integer
Maximum Schedules to return in this page.
string
Opaque base64 cursor returned by a previous call. Omit for the first page and pass it back unchanged to continue.
string
required
Full Temporal Cloud Namespace ID, including the account suffix. This validated value deterministically selects its web.tmprl.cloud host.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TEMPORAL_LIST_WORKFLOW_RULESReturn one page of Workflow Rules configured for an authorized Temporal Cloud Namespace. Requires Namespace Read access.

Input Parameters

string
Opaque base64 cursor returned by a previous call. Omit for the first page and pass it back unchanged to continue.
string
required
Full Temporal Cloud Namespace ID, including the account suffix. This validated value deterministically selects its web.tmprl.cloud host.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TEMPORAL_LIST_WORKFLOWSSearch one page of Workflow Executions in an authorized Temporal Cloud Namespace using Temporal Visibility query syntax. Requires Namespace Read access.

Input Parameters

string
SQL-like filter scoped to this Namespace. Attribute names are case-sensitive. Use =, !=, >, >=, <, <=, IN (…), BETWEEN … AND …, IS NULL, IS NOT NULL, STARTS_WITH, AND, OR, and parentheses. Quote strings and RFC3339 timestamps with single or double quotes; wrap custom attribute names containing non-alphanumeric characters in backticks. Common attributes include WorkflowId, WorkflowType, ExecutionStatus, StartTime, CloseTime, ExecutionTime, RunId, and TaskQueue. Temporal Cloud does not support ORDER BY. Example: ExecutionStatus = 'Running' AND WorkflowType = 'OrderWorkflow'.
integer
Maximum Workflow Executions to return in this page.
string
Opaque base64 cursor returned by a previous call; omit for the first page.
string
required
Full Temporal Cloud Namespace ID, including the account suffix. This validated value deterministically selects its web.tmprl.cloud host.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TEMPORAL_MOVE_NAMESPACE_TO_PROJECTMove a Temporal Cloud Namespace to another Project asynchronously. WARNING: this disruptive operation can change inherited access and connectivity. Verify the source and destination Projects, preserve required connectivity rules, and obtain explicit approval before calling it.

Input Parameters

object
required
Destination connectivity policy. Set exactly one of rule_ids or unrestricted=true.
string
required
Full Temporal Cloud Namespace ID, including the account suffix.
string
required
Current Namespace resourceVersion from DESCRIBE_NAMESPACE; stale versions are rejected.
string
Optional caller-chosen idempotency ID. Reuse it only when retrying this same move.
string
required
Project ID that will own the Namespace after the move.
string
required
Current Project ID used as a concurrency guard; the move fails if it no longer matches.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TEMPORAL_PATCH_SCHEDULEApply targeted changes to a Temporal Schedule without replacing its definition: pause or unpause it, trigger one immediate action, or backfill historical times. Immediate and backfill operations start application Workflows and may cause arbitrary external side effects. Use request_id for idempotent retries. Requires Namespace Write access.

Input Parameters

string
Caller identity recorded by Temporal for this patch.
string
Pause automatic Schedule actions and store this explanatory note.
string
Idempotency ID; reuse it only when retrying this exact patch intent.
string
required
Application-defined ID of the Schedule to patch.
string
required
Full Temporal Cloud Namespace ID, including the account suffix. This validated value deterministically selects its web.tmprl.cloud host.
string
Resume automatic Schedule actions and store this explanatory note.
array
Historical ranges to evaluate immediately. Every matching time may start a Workflow and cause application side effects.
object
Trigger one Schedule action immediately. This starts application Workflow code and may cause arbitrary external side effects.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TEMPORAL_PAUSE_WORKFLOWPause one Temporal Workflow Execution. Temporal changes its status to PAUSED, records a WORKFLOW_EXECUTION_PAUSED event, stops dispatching new Workflow and Activity Tasks, pauses executing Activities, and rejects Queries and Updates; an executing Workflow Task may still complete and server-side events continue. This operational side effect can halt business processing. Always call UNPAUSE_WORKFLOW during teardown, even if a later step fails. Requires Namespace Write access. This Temporal API is experimental.

Input Parameters

string
Optional human-readable reason for pausing the Workflow Execution.
string
Specific run ID to pause; omit to target the current run.
string
Caller identity recorded in Event History.
string
Unique idempotency ID, typically a UUIDv4. Reuse it only when retrying the same pause request.
string
required
Application-defined Workflow ID whose execution should be paused.
string
required
Full Temporal Cloud Namespace ID, including the account suffix. This validated value deterministically selects its web.tmprl.cloud host.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TEMPORAL_QUERY_WORKFLOWRun a synchronous, read-only Query handler against one Temporal Workflow Execution. The handler runs in Workflow context but cannot mutate Workflow state. Requires Namespace Read access.

Input Parameters

string
Specific Workflow run ID. Omit it to query the current run.
array
Query arguments as ordinary JSON values. Each value is encoded as a Temporal json/plain Payload. Mutually exclusive with raw_payloads.
string
required
Workflow-author-defined Query handler name.
string
required
Application-defined Workflow ID whose Query handler will run.
string
required
Full Temporal Cloud Namespace ID including its account suffix, for example ‘payments.a1b2c’. It deterministically selects the Namespace’s web.tmprl.cloud host; a name without the suffix is rejected.
array
Exact protobuf-JSON Payloads for a custom codec or non-JSON data. metadata and data byte values must be base64. Mutually exclusive with arguments.
string ("QUERY_REJECT_CONDITION_UNSPECIFIED" | "QUERY_REJECT_CONDITION_NONE" | "QUERY_REJECT_CONDITION_NOT_OPEN" | "QUERY_REJECT_CONDITION_NOT_COMPLETED_CLEANLY")
Condition under which Temporal rejects the Query based on Workflow Execution status. Omit it for Temporal’s default behavior.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TEMPORAL_REGISTER_NAMESPACECreate a billable, persistent Temporal Cloud Namespace asynchronously, returning its full Namespace ID and operation information when provided. The name is immutable and custom Search Attributes cannot be deleted; use a unique disposable name for testing and arrange teardown only after creation completes.

Input Parameters

string
required
Immutable Namespace name without the account suffix.
object
Namespace tags. Supplying tags requires Global Admin or Account Owner.
array
required
One or two immutable replica placements using region IDs returned by LIST_REGIONS. Supplying two replicas creates a global Namespace regardless of high_availability settings.
object
Optional current Cloud API mTLS authentication configuration.
string
Project in which to create the Namespace; omit for the default Project.
object
Optional codec-server configuration used by the Temporal Cloud UI.
object
Optional current Cloud API on-demand or provisioned capacity configuration.
integer
History retention in days for new Workflow Executions; affects storage cost.
object
Optional failover and passive-poller behavior for a two-replica global Namespace. Replica count, not this object, determines whether the Namespace is global.
object
Custom Search Attribute names and types. Created attributes cannot be deleted later.
string
Stable caller-chosen idempotency ID; omit to let Temporal generate one.
boolean
Protect the Namespace from accidental deletion. Defaults to enabled.
boolean
Enable API-key authentication so this toolkit can access the Namespace.
array
Private Connectivity rule IDs to apply to the Namespace.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TEMPORAL_REMOVE_NAMESPACE_ACCESSRemove one user’s, user group’s, or service account’s direct permission on a Temporal Cloud Namespace by setting PERMISSION_UNSPECIFIED. Requires Namespace Admin. WARNING: this can immediately remove access or lock out the selected identity; verify inherited access and never remove the caller’s or sole administrator’s access.

Input Parameters

string
required
Full Temporal Cloud Namespace ID, including its account suffix.
string
required
Temporal Cloud user, user-group, or service-account ID matching principal_type.
string ("USER" | "USER_GROUP" | "SERVICE_ACCOUNT")
required
Principal selector: USER, USER_GROUP, or SERVICE_ACCOUNT. This selects the matching fixed Temporal endpoint.
string
required
Current resourceVersion of the selected user, group, or service account. Obtain it from that principal’s current get/list response; this is not the Namespace resource version.
string
Optional caller-chosen idempotency ID. Reuse it only when retrying this exact removal.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TEMPORAL_RENAME_CUSTOM_SEARCH_ATTRIBUTERename one custom Search Attribute in a Temporal Cloud Namespace asynchronously. This is a potentially breaking schema mutation: Temporal does not rewrite application Visibility queries or dashboards that reference the old name. Verify all consumers and use the latest Namespace resource version before starting the rename.

Input Parameters

string
required
New name for the custom Search Attribute. Update every dependent Visibility query and dashboard to use this name.
string
required
Full Cloud Namespace ID containing the custom Search Attribute.
string
required
Current name of the custom Search Attribute to rename.
string
required
Current Namespace resourceVersion from DESCRIBE_NAMESPACE; stale versions are rejected.
string
Optional caller-chosen idempotency ID. Reuse it only when retrying this exact rename.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TEMPORAL_REPLACE_WORKFLOWReplace a running Workflow Execution with a new execution using the same Workflow ID. WARNING: if that ID is running, Temporal irreversibly terminates the existing execution before starting the replacement. This may interrupt in-flight work, and the new Workflow may cause arbitrary external side effects. Use only when termination is explicitly intended, and use request_id for idempotent retries. Requires Namespace Write access.

Input Parameters

object
Unindexed Memo values encoded individually as Temporal json/plain Payloads.
string
Caller identity recorded in the Workflow Event History.
array
Workflow arguments as ordinary JSON values. Each value is encoded as a Temporal json/plain Payload. Mutually exclusive with raw_payloads.
string
Idempotency ID for this start request, typically a UUIDv4. Reuse the same value only when retrying the same intended start.
string
required
Task Queue polled by a Worker that supports workflow_type.
string
required
Application-defined Workflow ID.
string
required
Full Temporal Cloud Namespace ID including its account suffix, for example ‘payments.a1b2c’. It deterministically selects the Namespace’s web.tmprl.cloud host; a name without the suffix is rejected.
array
Exact protobuf-JSON Payloads for a custom codec. metadata and data byte values must be base64. Mutually exclusive with arguments.
object
Optional server-side Workflow retry policy.
string
Optional cron expression. Prefer Temporal Schedules for new designs.
string
required
Registered Workflow type name implemented by a compatible Worker.
object
Values for registered Search Attributes, encoded individually as indexed Temporal json/plain Payloads.
string
Maximum time for one Workflow run as a protobuf duration such as ‘3600s’.
string
Maximum time for one Workflow Task as a protobuf duration such as ’10s’.
string ("WORKFLOW_ID_REUSE_POLICY_UNSPECIFIED" | "WORKFLOW_ID_REUSE_POLICY_ALLOW_DUPLICATE" | "WORKFLOW_ID_REUSE_POLICY_ALLOW_DUPLICATE_FAILED_ONLY" | "WORKFLOW_ID_REUSE_POLICY_REJECT_DUPLICATE")
Policy for reusing this Workflow ID after a closed execution.
string
Maximum total execution time across retries and continue-as-new as a protobuf duration, for example ‘3600s’; units such as ‘1h’ are invalid.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TEMPORAL_RESET_WORKFLOWWARNING: Irreversibly reset a Temporal Workflow to a selected Workflow Task event. Temporal terminates the current run and creates a new run; replay and reapplied events can repeat application code and external side effects. Verify the source run, event ID, and reapply policy before calling.

Input Parameters

string
required
Human-readable reason recorded for this irreversible Workflow reset.
string
required
Exact source run ID containing the reset event. Temporal terminates the current run even when this identifies an earlier run in the chain.
string
Stable request ID used by Temporal to deduplicate resets. Reuse it only when retrying this exact reset intent.
string
required
Application-defined Workflow ID whose execution chain will be reset.
string
required
Full Temporal Cloud Namespace ID including its account suffix. This validated value deterministically selects its web.tmprl.cloud host.
string ("RESET_REAPPLY_TYPE_UNSPECIFIED" | "RESET_REAPPLY_TYPE_SIGNAL" | "RESET_REAPPLY_TYPE_NONE" | "RESET_REAPPLY_TYPE_ALL_ELIGIBLE")
Deprecated legacy policy for events after the reset point. Temporal defaults this field to RESET_REAPPLY_TYPE_SIGNAL; prefer reset_reapply_exclude_types.
array
Event categories to exclude when reapplying eligible events after the reset point. CANCEL_REQUEST is deprecated and unimplemented by Temporal.
string
required
Positive int64 event ID in the source run at which to reset. It must identify a WORKFLOW_TASK_COMPLETED, WORKFLOW_TASK_TIMED_OUT, WORKFLOW_TASK_FAILED, or WORKFLOW_TASK_STARTED event. Decimal strings are recommended to preserve all int64 values exactly in JSON.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TEMPORAL_SET_NAMESPACE_ACCESSSet one user’s, user group’s, or service account’s direct ADMIN, WRITE, or READ permission on a Temporal Cloud Namespace. The new permission replaces that principal’s current direct access; setting a lower permission may lock out the caller or the Namespace’s sole admin. Requires Namespace Admin.

Input Parameters

string ("PERMISSION_ADMIN" | "PERMISSION_WRITE" | "PERMISSION_READ")
required
Exact direct Namespace permission to set: ADMIN, WRITE, or READ. This replaces the principal’s current direct permission; choosing a lower permission may lock out the caller or the Namespace’s sole admin.
string
required
Full Temporal Cloud Namespace ID, including its account suffix.
string
required
Temporal Cloud user, user-group, or service-account ID matching principal_type.
string ("USER" | "USER_GROUP" | "SERVICE_ACCOUNT")
required
Principal kind: USER, USER_GROUP, or SERVICE_ACCOUNT. This selects the matching Temporal endpoint.
string
required
Current resourceVersion of the selected user, group, or service account. Obtain it from that principal’s current get/list response; this is not the Namespace resource version.
string
Optional caller-chosen idempotency ID. Reuse it only when retrying this exact access change.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TEMPORAL_SIGNAL_WITH_START_WORKFLOWAtomically signal a running Temporal Workflow or start and signal it when absent. This may run application code and trigger external side effects; use a stable request_id when retrying the same intent. The TERMINATE_EXISTING conflict policy and deprecated TERMINATE_IF_RUNNING reuse policy can terminate a running execution before starting and signaling its replacement.

Input Parameters

string
Caller identity recorded in Workflow Event History.
string
Stable idempotency ID. Reuse it only when retrying the same signal-with-start intent.
string
required
Task Queue polled by a compatible Worker if a new execution is started.
string
required
Workflow-author-defined Signal handler name.
string
required
Application-defined Workflow ID to signal or atomically start.
string
required
Full lowercase Cloud Namespace ID including its account suffix, for example payments.a1b2c; it deterministically selects the Namespace web host.
object
Optional settings applied only when Temporal starts a new Workflow Execution.
string
required
Registered Workflow type used only if a new execution must be started.
array
Signal arguments as ordinary JSON values. Each list element becomes one Temporal json/plain Payload; use signal_raw_payloads only for custom codecs.
array
Workflow start arguments as ordinary JSON values. Each list element becomes one Temporal json/plain Payload.
array
Exact signal Payloads for custom codecs; mutually exclusive with signal_arguments.
array
Exact Workflow start Payloads for custom codecs; mutually exclusive with workflow_arguments.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TEMPORAL_SIGNAL_WORKFLOWSend an asynchronous Signal to one running Temporal Workflow Execution. This records a history event, schedules Workflow code, and may trigger arbitrary external business side effects. Temporal’s successful response only confirms acceptance, not handler completion. Use request_id to make retries idempotent. Requires Namespace Write access.

Input Parameters

string
Specific Workflow run ID to signal. Omit it to target the current run for workflow_id.
string
Caller identity recorded in the Workflow Event History.
array
Signal arguments as ordinary JSON values. Each list element is encoded as one Temporal json/plain Payload. Mutually exclusive with raw_payloads.
string
Stable idempotency ID used by Temporal to deduplicate this Signal. Reuse it only when retrying the same intended Signal.
string
required
Workflow-author-defined name of the registered Signal handler.
string
required
Application-defined Workflow ID of the running execution to signal.
string
required
Full Temporal Cloud Namespace ID including its account suffix, for example ‘payments.a1b2c’. It deterministically selects the Namespace’s web.tmprl.cloud host; a name without the suffix is rejected.
array
Exact Temporal Payloads for a custom codec. metadata and data byte values must be base64. Mutually exclusive with arguments.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TEMPORAL_START_OR_GET_WORKFLOWStart a Workflow Execution, or return the already-running execution when the Workflow ID conflicts. This action never replaces the running execution. The response has started=false when it returns the existing execution. Starting a Workflow dispatches application code and may cause arbitrary external side effects. Use request_id for idempotent retries. Requires Namespace Write access.

Input Parameters

object
Unindexed Memo values encoded individually as Temporal json/plain Payloads.
string
Caller identity recorded in the Workflow Event History.
array
Workflow arguments as ordinary JSON values. Each value is encoded as a Temporal json/plain Payload. Mutually exclusive with raw_payloads.
string
Idempotency ID for this start request, typically a UUIDv4. Reuse the same value only when retrying the same intended start.
string
required
Task Queue polled by a Worker that supports workflow_type.
string
required
Application-defined Workflow ID.
string
required
Full Temporal Cloud Namespace ID including its account suffix, for example ‘payments.a1b2c’. It deterministically selects the Namespace’s web.tmprl.cloud host; a name without the suffix is rejected.
array
Exact protobuf-JSON Payloads for a custom codec. metadata and data byte values must be base64. Mutually exclusive with arguments.
object
Optional server-side Workflow retry policy.
string
Optional cron expression. Prefer Temporal Schedules for new designs.
string
required
Registered Workflow type name implemented by a compatible Worker.
object
Values for registered Search Attributes, encoded individually as indexed Temporal json/plain Payloads.
string
Maximum time for one Workflow run as a protobuf duration such as ‘3600s’.
string
Maximum time for one Workflow Task as a protobuf duration such as ’10s’.
string ("WORKFLOW_ID_REUSE_POLICY_UNSPECIFIED" | "WORKFLOW_ID_REUSE_POLICY_ALLOW_DUPLICATE" | "WORKFLOW_ID_REUSE_POLICY_ALLOW_DUPLICATE_FAILED_ONLY" | "WORKFLOW_ID_REUSE_POLICY_REJECT_DUPLICATE")
Policy for reusing this Workflow ID after a closed execution.
string
Maximum total execution time across retries and continue-as-new as a protobuf duration, for example ‘3600s’; units such as ‘1h’ are invalid.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TEMPORAL_START_WORKFLOWStart a new Workflow Execution in an authorized Temporal Cloud Namespace. The request fails if the Workflow ID is already running; use Start or Get Workflow or Replace Workflow only when those different conflict semantics are intended. This dispatches application code and may cause arbitrary external side effects. Use request_id for idempotent retries. Requires Namespace Write access.

Input Parameters

object
Unindexed Memo values encoded individually as Temporal json/plain Payloads.
string
Caller identity recorded in the Workflow Event History.
array
Workflow arguments as ordinary JSON values. Each value is encoded as a Temporal json/plain Payload. Mutually exclusive with raw_payloads.
string
Idempotency ID for this start request, typically a UUIDv4. Reuse the same value only when retrying the same intended start.
string
required
Task Queue polled by a Worker that supports workflow_type.
string
required
Application-defined Workflow ID.
string
required
Full Temporal Cloud Namespace ID including its account suffix, for example ‘payments.a1b2c’. It deterministically selects the Namespace’s web.tmprl.cloud host; a name without the suffix is rejected.
array
Exact protobuf-JSON Payloads for a custom codec. metadata and data byte values must be base64. Mutually exclusive with arguments.
object
Optional server-side Workflow retry policy.
string
Optional cron expression. Prefer Temporal Schedules for new designs.
string
required
Registered Workflow type name implemented by a compatible Worker.
object
Values for registered Search Attributes, encoded individually as indexed Temporal json/plain Payloads.
string
Maximum time for one Workflow run as a protobuf duration such as ‘3600s’.
string
Maximum time for one Workflow Task as a protobuf duration such as ’10s’.
string ("WORKFLOW_ID_REUSE_POLICY_UNSPECIFIED" | "WORKFLOW_ID_REUSE_POLICY_ALLOW_DUPLICATE" | "WORKFLOW_ID_REUSE_POLICY_ALLOW_DUPLICATE_FAILED_ONLY" | "WORKFLOW_ID_REUSE_POLICY_REJECT_DUPLICATE")
Policy for reusing this Workflow ID after a closed execution.
string
Maximum total execution time across retries and continue-as-new as a protobuf duration, for example ‘3600s’; units such as ‘1h’ are invalid.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TEMPORAL_STOP_BATCH_OPERATIONRequest that Temporal stop an in-progress batch operation. This does not roll back Workflows already processed by the batch: their cancellations, terminations, signals, deletions, resets, or option changes remain in effect. Requires Namespace Write access.

Input Parameters

string
required
Running Temporal batch operation job ID to stop.
string
required
Human-readable reason recorded for stopping the batch operation.
string
Caller identity recorded by Temporal. Omit to use composio.
string
required
Full Temporal Cloud Namespace ID, including the account suffix. This validated value deterministically selects its web.tmprl.cloud host.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TEMPORAL_TERMINATE_WORKFLOWImmediately and irreversibly terminate one Temporal Workflow Execution. WARNING: termination bypasses cooperative cancellation and Workflow cleanup logic, so finally blocks, compensation, and pending work may not run. Use cancellation instead when the Workflow can clean up safely. Requires Namespace Write access.

Input Parameters

string
Optional termination reason recorded in Workflow Event History.
string
Specific run ID to terminate; omit to target the current run.
array
Termination detail values recorded in Event History. Each value is encoded as one Temporal json/plain Payload. Mutually exclusive with raw_details.
string
Caller identity recorded in Workflow Event History.
array
Exact protobuf-JSON termination Payloads for custom codecs or non-JSON data. metadata and data byte values must be base64. Mutually exclusive with details.
string
required
Application-defined Workflow ID whose execution will be terminated.
string
required
Full Temporal Cloud Namespace ID including its account suffix. This validated value deterministically selects its web.tmprl.cloud host; a Namespace name without the suffix is rejected.
string
Optional execution-chain guard. Temporal rejects the request unless the target run belongs to the chain that began with this run ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TEMPORAL_TRIGGER_WORKFLOW_RULETrigger an existing configured Temporal Workflow Rule against one Workflow Execution. This irreversible request evaluates the rule and, when its conditions match, may run configured actions with destructive or arbitrary external side effects. Verify the Workflow and rule before calling; do not test against production or an unknown rule. A successful request can return applied=false when the rule conditions do not match. Requires Namespace Write access.

Input Parameters

string
Specific run ID to target; omit to target the current run.
string
required
ID of an existing configured Workflow Rule to evaluate and trigger.
string
Caller identity recorded by Temporal for this rule trigger request.
string
required
Application-defined Workflow ID whose execution the rule should target.
string
required
Full Temporal Cloud Namespace ID, including the account suffix. This validated value deterministically selects its web.tmprl.cloud host.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TEMPORAL_UNPAUSE_WORKFLOWResume a paused Temporal Workflow Execution. Unpausing changes its status to running, records an unpaused history event, and resumes application code in Workflow and Activity Tasks, which may produce external side effects. Use request_id for idempotent retries. This Temporal API is experimental and requires Namespace Write access.

Input Parameters

string
Optional human-readable reason for resuming the Workflow Execution.
string
Specific run ID to unpause; omit to target the current run.
string
Caller identity recorded in Workflow Event History.
string
Unique idempotency ID, typically a UUIDv4. Reuse it only when retrying the same unpause request.
string
required
Application-defined Workflow ID of the paused execution to resume.
string
required
Full Temporal Cloud Namespace ID, including the account suffix. This validated value deterministically selects its web.tmprl.cloud host.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TEMPORAL_UPDATE_EXPORT_SINKUpdate an existing Temporal Cloud Workflow History export sink asynchronously using optimistic concurrency. WARNING: this replaces the sink’s destination configuration or enabled state for future exports and may redirect or stop Workflow History delivery; already exported files are not moved or undone. Confirm the complete current specification, destination, and resourceVersion before calling.

Input Parameters

object
required
Complete intended export-sink specification; set exactly one of s3, gcs, or azure_blob.
string
required
Immutable name of the existing export sink; this is also sent as spec.name.
string
required
Full Temporal Cloud Namespace ID containing the export sink.
string
required
Current sink resourceVersion from GET_EXPORT_SINK; stale versions are rejected.
string
Optional caller-chosen idempotency ID. Reuse it only when retrying this exact update.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TEMPORAL_UPDATE_NAMESPACEUpdate a Temporal Cloud Namespace specification asynchronously using the latest resource version for optimistic concurrency. WARNING: this full-spec replacement can change retention, regions, capacity, authentication, deletion protection, and high-availability behavior; newly added custom Search Attributes cannot be deleted. Preserve every unchanged field and verify API-key access and deletion protection before calling. Requires Namespace Admin access.

Input Parameters

object
required
Complete current Namespace spec with intended changes. Retain unchanged fields from DESCRIBE_NAMESPACE.
string
required
Full Cloud Namespace ID from DESCRIBE_NAMESPACE, including its account suffix.
string
required
Current resourceVersion from DESCRIBE_NAMESPACE; stale versions are rejected.
string
Optional caller-chosen idempotency ID. Reuse it only when retrying the same intended update.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TEMPORAL_UPDATE_NAMESPACE_TAGSUpsert or permanently remove tags on a Temporal Cloud Namespace asynchronously; removed tags no longer exist on the Namespace. At least one of tags_to_upsert or tags_to_remove must be non-empty, and the same key cannot appear in both. The API-key owner must be a Global Admin or Account Owner; Namespace Admin access alone is insufficient.

Input Parameters

string
required
Full Temporal Cloud Namespace ID, including its account suffix.
array
Persistent tag keys to remove; removed tags no longer exist on the Namespace, and nonexistent keys are silently ignored. At least one of tags_to_upsert or tags_to_remove must be non-empty, and a key cannot appear in both. Requires Global Admin or Account Owner.
object
Tag keys and values to add or replace. At least one of tags_to_upsert or tags_to_remove must be non-empty, and a key cannot appear in both. Requires Global Admin or Account Owner.
string
Optional caller-chosen idempotency ID. Reuse it only when retrying the same tag update.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TEMPORAL_UPDATE_SCHEDULEFully replace an existing Temporal Schedule’s spec, Workflow-start action, policies, and state. Omitted values in those structures are not preserved; supply the complete desired replacement configuration. The replacement can change when application Workflows run and may cause irreversible external side effects. Supply conflict_token to reject a stale update. Requires Namespace Write access.

Input Parameters

object
Unindexed Schedule Memo values encoded as Temporal json/plain Payloads.
object
Paused state, notes, and optional action limit for the Schedule.
string
Maximum random positive delay applied to each matching schedule time.
string
Inclusive RFC 3339 time after which no scheduled action may start.
string
Caller identity recorded in Schedule history.
object
Overlap, catchup, failure, and Workflow ID policies for the Schedule.
object
Advanced Temporal Priority protobuf JSON for each started Workflow.
array
Workflow arguments encoded as json/plain Payloads; mutually exclusive with raw_payloads.
array
Labeled calendar expressions; Temporal compiles these into structured calendars.
array
Fixed interval specifications combined with any other supplied timing sources.
string
Idempotency ID; reuse it only when retrying the same intended mutation.
string
Inclusive RFC 3339 time before which no scheduled action may start.
string
required
Task Queue polled by a Worker that supports workflow_type.
string
required
Application-defined Schedule ID unique within the Namespace.
string
Optional Workflow ID used by each scheduled start. Omit it to let Temporal generate a unique Workflow ID.
string
required
Full Temporal Cloud Namespace ID including its account suffix, for example ‘payments.a1b2c’.
array
Exact protobuf-JSON Payloads for custom codecs; mutually exclusive with arguments.
object
Server-side retry policy applied to each scheduled Workflow.
string
Optional base64 TZif timezone definition used instead of server timezone data.
string
IANA timezone used to interpret cron expressions, such as ‘America/Chicago’.
object
Advanced Temporal UserMetadata protobuf JSON for each started Workflow.
object
Unindexed Memo values attached to each Workflow started by the Schedule.
string
required
Registered Workflow type name implemented by a compatible Worker.
string
Optional base64 conflict token from Temporal’s schedule description or create response. When supplied, Temporal rejects the update if the schedule changed after that token was issued.
array
Temporal cron expressions combined with any other supplied timing sources.
object
Workflow header fields encoded as Temporal json/plain Payloads.
array
Deprecated labeled calendar expressions whose matching times are excluded.
object
Registered Schedule Search Attribute values encoded as indexed Payloads.
object
Advanced Temporal VersioningOverride protobuf JSON for each started Workflow.
array
Programmatic calendar ranges whose matches are included in the Schedule.
string
Maximum time for one Workflow run as a positive protobuf duration.
string
Maximum time for one Workflow Task as a positive protobuf duration.
string
Maximum total Workflow execution time as a positive protobuf duration.
object
Registered Search Attribute values attached to each started Workflow.
array
Programmatic calendar ranges whose matching times are excluded.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TEMPORAL_UPDATE_WORKFLOWSend a durable Update to one Temporal Workflow Execution and wait for the requested lifecycle stage. The Workflow handler may mutate state and cause arbitrary external business side effects. Reuse update_id only when retrying the same intended Update. An admitted or accepted response can omit outcome; the returned update_ref identifies the still-running Update. Requires Namespace Write access.

Input Parameters

string
Specific Workflow run ID. Omit it to update the current run.
string
Caller identity recorded with the Workflow Update request.
array
Update arguments as ordinary JSON values. Each value is encoded as a Temporal json/plain Payload. Mutually exclusive with raw_payloads.
string
required
Workflow-scoped stable ID used to deduplicate this Update and refer to it later. Reuse it only for retries of the same intended Update.
string ("UPDATE_WORKFLOW_EXECUTION_LIFECYCLE_STAGE_UNSPECIFIED" | "UPDATE_WORKFLOW_EXECUTION_LIFECYCLE_STAGE_ADMITTED" | "UPDATE_WORKFLOW_EXECUTION_LIFECYCLE_STAGE_ACCEPTED" | "UPDATE_WORKFLOW_EXECUTION_LIFECYCLE_STAGE_COMPLETED")
Lifecycle stage the Update should reach before this call returns. A server timeout may return an earlier actual stage.
string
required
Workflow-author-defined name of the registered Update handler.
string
required
Application-defined Workflow ID whose Update handler will run.
string
required
Full Temporal Cloud Namespace ID including its account suffix. This validated value deterministically selects its web.tmprl.cloud host.
array
Exact protobuf-JSON Payloads for a custom codec or non-JSON data. metadata and data byte values must be base64. Mutually exclusive with arguments.
string
Chain guard requiring the current Workflow Execution to belong to the chain that began with this first run ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TEMPORAL_UPDATE_WORKFLOW_OPTIONSUpdate selected options on one Temporal Workflow Execution using an exact protobuf FieldMask. This mutation can reroute Workflow Tasks to different Workers, change task priority, or alter virtual-time behavior and thereby cause application side effects. Use only on an intended execution, capture the prior options, and restore them when testing. Requires Namespace Write access.

Input Parameters

string
Specific run ID; omit to target the current run.
object
required
Exact WorkflowExecutionOptions values to set. Snake_case keys are canonical; protobuf lowerCamelCase aliases are also accepted. Use an explicit null to clear an option.
string
required
Application-defined Workflow ID whose execution options will change.
string
required
Full Temporal Cloud Namespace ID including its account suffix. This validated value deterministically selects its web.tmprl.cloud host.
array
Top-level protobuf FieldMask paths. Use versioning_override, priority, or time_skipping_config. If omitted, the mask is deterministically derived only from explicitly supplied options. If supplied, it must exactly match those options.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TEMPORAL_VALIDATE_EXPORT_SINKValidate a Temporal Cloud Workflow History export sink configuration. WARNING: this is not read-only; Temporal writes an empty test object to the configured external bucket or container. Use only an owner-approved disposable bucket or container.

Input Parameters

object
required
Export sink configuration to validate. Temporal writes an empty test object to the selected external bucket or container.
string
required
Full Temporal Cloud Namespace ID, including the account suffix.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not