Temporal

使用方法

Connect to a Temporal cluster over the server's HTTP API to start workflow executions, send signals, run queries against workflow state, describe and list executions, fetch event histories, and cancel or terminate running workflows. API key only required for servers with authentication enabled.

ツール

`temporal_start_workflow`

Start a new workflow execution on a Temporal cluster.

入力

パラメータ	型	必須	説明
`serverUrl`	string	はい	Base URL of the Temporal server's HTTP API (e.g., http://localhost:7243\)
`namespace`	string	はい	Temporal namespace (e.g., default)
`apiKey`	string	いいえ	API key sent as a Bearer token (leave blank for servers without auth)
`workflowId`	string	はい	Unique workflow ID for the new execution (e.g., order-1234)
`workflowType`	string	はい	Registered workflow type name to run (e.g., OrderWorkflow)
`taskQueue`	string	はい	Task queue the workflow worker polls (e.g., orders)
`input`	string	いいえ	Workflow input as JSON. A top-level array is passed as the argument list (one argument per element); any other value is passed as a single argument
`workflowIdReusePolicy`	string	いいえ	Policy for reusing a closed workflow ID: WORKFLOW_ID_REUSE_POLICY_ALLOW_DUPLICATE, WORKFLOW_ID_REUSE_POLICY_ALLOW_DUPLICATE_FAILED_ONLY, WORKFLOW_ID_REUSE_POLICY_REJECT_DUPLICATE, or WORKFLOW_ID_REUSE_POLICY_TERMINATE_IF_RUNNING
`workflowIdConflictPolicy`	string	いいえ	Policy when a workflow with the same ID is already running: WORKFLOW_ID_CONFLICT_POLICY_FAIL, WORKFLOW_ID_CONFLICT_POLICY_USE_EXISTING, or WORKFLOW_ID_CONFLICT_POLICY_TERMINATE_EXISTING
`cronSchedule`	string	いいえ	Cron schedule for recurring executions (e.g., "0 12 * * *")
`executionTimeoutSeconds`	number	いいえ	Total workflow execution timeout in seconds, including retries and continue-as-new
`runTimeoutSeconds`	number	いいえ	Timeout for a single workflow run in seconds
`memo`	string	いいえ	JSON object of memo fields to attach to the execution
`searchAttributes`	string	いいえ	JSON object of search attribute values to index the execution with

出力

パラメータ	型	説明
`workflowId`	string	Workflow ID of the execution
`runId`	string	Run ID of the started workflow execution
`started`	boolean	Whether a new execution was started (false when an existing execution was reused)

`temporal_signal_workflow`

Send a signal to a running Temporal workflow execution.

入力

パラメータ	型	必須	説明
`serverUrl`	string	はい	Base URL of the Temporal server's HTTP API (e.g., http://localhost:7243\)
`namespace`	string	はい	Temporal namespace (e.g., default)
`apiKey`	string	いいえ	API key sent as a Bearer token (leave blank for servers without auth)
`workflowId`	string	はい	Workflow ID of the execution to signal
`runId`	string	いいえ	Run ID of a specific run to signal (defaults to the latest run)
`signalName`	string	はい	Name of the signal handler to invoke (e.g., approve-order)
`signalInput`	string	いいえ	Signal input as JSON. A top-level array is passed as the argument list (one argument per element); any other value is passed as a single argument

出力

パラメータ	型	説明
`workflowId`	string	Workflow ID of the signaled execution
`signalName`	string	Name of the signal that was sent

`temporal_signal_with_start`

Atomically signal a Temporal workflow, starting it first if it is not already running, so the signal is never lost.

入力

パラメータ	型	必須	説明
`serverUrl`	string	はい	Base URL of the Temporal server's HTTP API (e.g., http://localhost:7243\)
`namespace`	string	はい	Temporal namespace (e.g., default)
`apiKey`	string	いいえ	API key sent as a Bearer token (leave blank for servers without auth)
`workflowId`	string	はい	Workflow ID to signal, or to start and signal (e.g., order-1234)
`workflowType`	string	はい	Registered workflow type name to start if the workflow is not running
`taskQueue`	string	はい	Task queue the workflow worker polls (e.g., orders)
`signalName`	string	はい	Name of the signal handler to invoke (e.g., approve-order)
`input`	string	いいえ	Workflow start input as JSON, used only when a new execution is started. A top-level array is passed as the argument list; any other value is passed as a single argument
`signalInput`	string	いいえ	Signal input as JSON. A top-level array is passed as the argument list (one argument per element); any other value is passed as a single argument
`workflowIdReusePolicy`	string	いいえ	Policy for reusing a closed workflow ID: WORKFLOW_ID_REUSE_POLICY_ALLOW_DUPLICATE, WORKFLOW_ID_REUSE_POLICY_ALLOW_DUPLICATE_FAILED_ONLY, WORKFLOW_ID_REUSE_POLICY_REJECT_DUPLICATE, or WORKFLOW_ID_REUSE_POLICY_TERMINATE_IF_RUNNING
`workflowIdConflictPolicy`	string	いいえ	Policy when a workflow with the same ID is already running (defaults to using the existing run): WORKFLOW_ID_CONFLICT_POLICY_FAIL, WORKFLOW_ID_CONFLICT_POLICY_USE_EXISTING, or WORKFLOW_ID_CONFLICT_POLICY_TERMINATE_EXISTING
`cronSchedule`	string	いいえ	Cron schedule for recurring executions (e.g., "0 12 * * *")
`executionTimeoutSeconds`	number	いいえ	Total workflow execution timeout in seconds, including retries and continue-as-new
`runTimeoutSeconds`	number	いいえ	Timeout for a single workflow run in seconds
`memo`	string	いいえ	JSON object of memo fields to attach to the execution
`searchAttributes`	string	いいえ	JSON object of search attribute values to index the execution with

出力

パラメータ	型	説明
`workflowId`	string	Workflow ID of the signaled execution
`runId`	string	Run ID of the signaled (or newly started) execution
`started`	boolean	Whether this call started a new execution (false when only signaled)

`temporal_query_workflow`

Run a synchronous query against the state of a Temporal workflow execution and return the result.

入力

パラメータ	型	必須	説明
`serverUrl`	string	はい	Base URL of the Temporal server's HTTP API (e.g., http://localhost:7243\)
`namespace`	string	はい	Temporal namespace (e.g., default)
`apiKey`	string	いいえ	API key sent as a Bearer token (leave blank for servers without auth)
`workflowId`	string	はい	Workflow ID of the execution to query
`runId`	string	いいえ	Run ID of a specific run to query (defaults to the latest run)
`queryType`	string	はい	Name of the query handler to invoke (e.g., getStatus)
`queryArgs`	string	いいえ	Query arguments as JSON. A top-level array is passed as the argument list (one argument per element); any other value is passed as a single argument

出力

パラメータ	型	説明
`workflowId`	string	Workflow ID of the queried execution
`queryType`	string	Name of the query that was run
`result`	json	Decoded query result. A single payload is returned as its JSON value; multiple payloads are returned as an array

`temporal_update_workflow`

Invoke an update handler on a running Temporal workflow and wait for its result. Unlike a signal, an update is validated by the workflow and returns a response.

入力

パラメータ	型	必須	説明
`serverUrl`	string	はい	Base URL of the Temporal server's HTTP API (e.g., http://localhost:7243\)
`namespace`	string	はい	Temporal namespace (e.g., default)
`apiKey`	string	いいえ	API key sent as a Bearer token (leave blank for servers without auth)
`workflowId`	string	はい	Workflow ID of the execution to update
`runId`	string	いいえ	Run ID of a specific run to update (defaults to the latest run)
`updateName`	string	はい	Name of the update handler to invoke (e.g., addItem)
`updateArgs`	string	いいえ	Update arguments as JSON. A top-level array is passed as the argument list (one argument per element); any other value is passed as a single argument

出力

パラメータ	型	説明
`workflowId`	string	Workflow ID of the updated execution
`updateName`	string	Name of the update that was invoked
`result`	json	Decoded update result. A single payload is returned as its JSON value; multiple payloads are returned as an array

`temporal_describe_workflow`

Get the current state of a Temporal workflow execution, including status, timing, memo, search attributes, and pending activities.

入力

パラメータ	型	必須	説明
`serverUrl`	string	はい	Base URL of the Temporal server's HTTP API (e.g., http://localhost:7243\)
`namespace`	string	はい	Temporal namespace (e.g., default)
`apiKey`	string	いいえ	API key sent as a Bearer token (leave blank for servers without auth)
`workflowId`	string	はい	Workflow ID of the execution to describe
`runId`	string	いいえ	Run ID of a specific run to describe (defaults to the latest run)

出力

パラメータ	型	説明
`workflowId`	string	Workflow ID of the execution
`runId`	string	Run ID of the execution
`workflowType`	string	Workflow type name
`status`	string	Execution status (RUNNING, COMPLETED, FAILED, CANCELED, TERMINATED, CONTINUED_AS_NEW, or TIMED_OUT)
`startTime`	string	Start time of the execution (RFC 3339)
`closeTime`	string	Close time of the execution (RFC 3339), null while running
`executionTime`	string	Effective execution start time (RFC 3339), e.g. the first cron run time
`historyLength`	number	Number of events in the workflow history
`taskQueue`	string	Task queue of the execution
`memo`	json	Decoded memo fields attached to the execution
`searchAttributes`	json	Decoded search attribute values
`pendingActivities`	array	Activities currently pending on the execution
↳ `activityId`	string	Activity ID
↳ `activityType`	string	Activity type name
↳ `state`	string	Pending state (SCHEDULED, STARTED, CANCEL_REQUESTED, PAUSED, or PAUSE_REQUESTED)
↳ `attempt`	number	Current attempt number
↳ `lastFailureMessage`	string	Message of the most recent failure, if the activity is retrying

`temporal_list_workflows`

List workflow executions in a Temporal namespace, optionally filtered with a visibility query.

入力

パラメータ	型	必須	説明
`serverUrl`	string	はい	Base URL of the Temporal server's HTTP API (e.g., http://localhost:7243\)
`namespace`	string	はい	Temporal namespace (e.g., default)
`apiKey`	string	いいえ	API key sent as a Bearer token (leave blank for servers without auth)
`query`	string	いいえ	Visibility list filter, e.g. WorkflowType = "OrderWorkflow" AND ExecutionStatus = "Running" (empty lists all executions)
`pageSize`	number	いいえ	Maximum number of executions to return per page
`nextPageToken`	string	いいえ	Page token from a previous response, for pagination

出力

パラメータ	型	説明
`executions`	array	Workflow executions matching the query
↳ `workflowId`	string	Workflow ID of the execution
↳ `runId`	string	Run ID of the execution
↳ `workflowType`	string	Workflow type name
↳ `status`	string	Execution status (RUNNING, COMPLETED, FAILED, CANCELED, TERMINATED, CONTINUED_AS_NEW, or TIMED_OUT)
↳ `startTime`	string	Start time of the execution (RFC 3339)
↳ `closeTime`	string	Close time of the execution (RFC 3339), null while running
↳ `executionTime`	string	Effective execution start time (RFC 3339)
↳ `historyLength`	number	Number of events in the workflow history
↳ `taskQueue`	string	Task queue of the execution
`nextPageToken`	string	Token for the next page of results, null when no more pages exist

`temporal_count_workflows`

Count workflow executions in a Temporal namespace matching a visibility query, with optional GROUP BY aggregation.

入力

パラメータ	型	必須	説明
`serverUrl`	string	はい	Base URL of the Temporal server's HTTP API (e.g., http://localhost:7243\)
`namespace`	string	はい	Temporal namespace (e.g., default)
`apiKey`	string	いいえ	API key sent as a Bearer token (leave blank for servers without auth)
`query`	string	いいえ	Visibility count filter, e.g. ExecutionStatus = "Running" or ... GROUP BY ExecutionStatus (empty counts all executions)

出力

パラメータ	型	説明
`count`	number	Number of workflow executions matching the query
`groups`	array	Per-group counts when the query uses GROUP BY (empty otherwise)
↳ `values`	json	Decoded values of the GROUP BY fields
↳ `count`	number	Number of executions in the group

`temporal_get_workflow_history`

Fetch the event history of a Temporal workflow execution, optionally filtered to just the close event.

入力

パラメータ	型	必須	説明
`serverUrl`	string	はい	Base URL of the Temporal server's HTTP API (e.g., http://localhost:7243\)
`namespace`	string	はい	Temporal namespace (e.g., default)
`apiKey`	string	いいえ	API key sent as a Bearer token (leave blank for servers without auth)
`workflowId`	string	はい	Workflow ID of the execution
`runId`	string	いいえ	Run ID of a specific run (defaults to the latest run)
`maximumPageSize`	number	いいえ	Maximum number of history events to return per page
`nextPageToken`	string	いいえ	Page token from a previous response, for pagination
`historyEventFilterType`	string	いいえ	Event filter: HISTORY_EVENT_FILTER_TYPE_ALL_EVENT (default) or HISTORY_EVENT_FILTER_TYPE_CLOSE_EVENT to return only the final close event

出力

パラメータ	型	説明
`events`	array	History events of the workflow execution, in order
↳ `eventId`	number	Sequential ID of the event
↳ `eventTime`	string	Time the event was recorded (RFC 3339)
↳ `eventType`	string	Event type (e.g., WORKFLOW_EXECUTION_STARTED, ACTIVITY_TASK_COMPLETED)
↳ `attributes`	json	The event's type-specific attributes (payload data is base64-encoded)
`nextPageToken`	string	Token for the next page of events, null when no more pages exist

`temporal_cancel_workflow`

Request cooperative cancellation of a running Temporal workflow execution. The workflow decides how to respond to the request.

入力

パラメータ	型	必須	説明
`serverUrl`	string	はい	Base URL of the Temporal server's HTTP API (e.g., http://localhost:7243\)
`namespace`	string	はい	Temporal namespace (e.g., default)
`apiKey`	string	いいえ	API key sent as a Bearer token (leave blank for servers without auth)
`workflowId`	string	はい	Workflow ID of the execution to cancel
`runId`	string	いいえ	Run ID of a specific run to cancel (defaults to the latest run)
`reason`	string	いいえ	Reason for the cancellation, recorded in the workflow history

出力

パラメータ	型	説明
`workflowId`	string	Workflow ID of the execution whose cancellation was requested

`temporal_terminate_workflow`

Forcefully terminate a Temporal workflow execution immediately, without giving the workflow a chance to react.

入力

パラメータ	型	必須	説明
`serverUrl`	string	はい	Base URL of the Temporal server's HTTP API (e.g., http://localhost:7243\)
`namespace`	string	はい	Temporal namespace (e.g., default)
`apiKey`	string	いいえ	API key sent as a Bearer token (leave blank for servers without auth)
`workflowId`	string	はい	Workflow ID of the execution to terminate
`runId`	string	いいえ	Run ID of a specific run to terminate (defaults to the latest run)
`reason`	string	いいえ	Reason for the termination, recorded in the workflow history

出力

パラメータ	型	説明
`workflowId`	string	Workflow ID of the terminated execution

`temporal_reset_workflow`

Reset a Temporal workflow execution to a past workflow task, terminating the current run and replaying from the reset point in a new run.

入力

パラメータ	型	必須	説明
`serverUrl`	string	はい	Base URL of the Temporal server's HTTP API (e.g., http://localhost:7243\)
`namespace`	string	はい	Temporal namespace (e.g., default)
`apiKey`	string	いいえ	API key sent as a Bearer token (leave blank for servers without auth)
`workflowId`	string	はい	Workflow ID of the execution to reset
`runId`	string	いいえ	Run ID of a specific run to reset (defaults to the latest run)
`workflowTaskFinishEventId`	number	はい	Event ID of the workflow task finish event to reset to — a WORKFLOW_TASK_COMPLETED, WORKFLOW_TASK_TIMED_OUT, WORKFLOW_TASK_FAILED, or WORKFLOW_TASK_STARTED event (find it with Get Workflow History)
`reason`	string	いいえ	Reason for the reset, recorded in the workflow history

出力

パラメータ	型	説明
`workflowId`	string	Workflow ID of the reset execution
`runId`	string	Run ID of the new run created by the reset

`temporal_describe_task_queue`

List the workers currently polling a Temporal task queue, to check whether a workflow or activity has live workers.

入力

パラメータ	型	必須	説明
`serverUrl`	string	はい	Base URL of the Temporal server's HTTP API (e.g., http://localhost:7243\)
`namespace`	string	はい	Temporal namespace (e.g., default)
`apiKey`	string	いいえ	API key sent as a Bearer token (leave blank for servers without auth)
`taskQueue`	string	はい	Name of the task queue to describe (e.g., orders)
`taskQueueType`	string	いいえ	Type of pollers to list: TASK_QUEUE_TYPE_WORKFLOW (default) or TASK_QUEUE_TYPE_ACTIVITY

出力

パラメータ	型	説明
`taskQueue`	string	Name of the described task queue
`pollers`	array	Workers currently polling the task queue (empty when no workers are running)
↳ `identity`	string	Identity of the polling worker
↳ `lastAccessTime`	string	Last time the worker polled the queue (RFC 3339)
↳ `ratePerSecond`	number	Poller rate per second

`temporal_create_schedule`

Create a Temporal schedule that starts a workflow on a cron or interval cadence.

入力

パラメータ	型	必須	説明
`serverUrl`	string	はい	Base URL of the Temporal server's HTTP API (e.g., http://localhost:7243\)
`namespace`	string	はい	Temporal namespace (e.g., default)
`apiKey`	string	いいえ	API key sent as a Bearer token (leave blank for servers without auth)
`scheduleId`	string	はい	Unique ID for the new schedule (e.g., nightly-report)
`workflowId`	string	はい	Workflow ID for started workflows (the schedule appends the run time to keep IDs unique)
`workflowType`	string	はい	Registered workflow type name the schedule starts (e.g., ReportWorkflow)
`taskQueue`	string	はい	Task queue the workflow worker polls (e.g., reports)
`input`	string	いいえ	Workflow input as JSON. A top-level array is passed as the argument list (one argument per element); any other value is passed as a single argument
`cronExpressions`	string	いいえ	Cron expressions defining when the schedule fires, comma- or newline-separated for multiple (e.g., "0 12 * * *"). At least one of cronExpressions or intervalSeconds is required
`intervalSeconds`	number	いいえ	Fixed interval between actions in seconds. At least one of cronExpressions or intervalSeconds is required
`timezone`	string	いいえ	IANA time zone for cron evaluation (e.g., America/New_York; defaults to UTC)
`overlapPolicy`	string	いいえ	Policy when an action would overlap a still-running one (defaults to skip): SCHEDULE_OVERLAP_POLICY_SKIP, SCHEDULE_OVERLAP_POLICY_BUFFER_ONE, SCHEDULE_OVERLAP_POLICY_BUFFER_ALL, SCHEDULE_OVERLAP_POLICY_CANCEL_OTHER, SCHEDULE_OVERLAP_POLICY_TERMINATE_OTHER, or SCHEDULE_OVERLAP_POLICY_ALLOW_ALL
`notes`	string	いいえ	Human-readable notes stored on the schedule
`paused`	boolean	いいえ	Create the schedule in a paused state (defaults to active)

出力

パラメータ	型	説明
`scheduleId`	string	ID of the created schedule

`temporal_list_schedules`

List schedules in a Temporal namespace.

入力

パラメータ	型	必須	説明
`serverUrl`	string	はい	Base URL of the Temporal server's HTTP API (e.g., http://localhost:7243\)
`namespace`	string	はい	Temporal namespace (e.g., default)
`apiKey`	string	いいえ	API key sent as a Bearer token (leave blank for servers without auth)
`query`	string	いいえ	Visibility filter over schedules, e.g. TemporalSchedulePaused = false (empty lists all schedules)
`maximumPageSize`	number	いいえ	Maximum number of schedules to return per page
`nextPageToken`	string	いいえ	Page token from a previous response, for pagination

出力

パラメータ	型	説明
`schedules`	array	Schedules in the namespace
↳ `scheduleId`	string	Schedule ID
↳ `workflowType`	string	Workflow type the schedule starts
↳ `paused`	boolean	Whether the schedule is paused
↳ `notes`	string	Human-readable notes on the schedule
↳ `futureActionTimes`	json	Upcoming action times (RFC 3339)
`nextPageToken`	string	Token for the next page of results, null when no more pages exist

`temporal_describe_schedule`

Get the configuration and current state of a Temporal schedule, including its spec, recent actions, and upcoming run times.

入力

パラメータ	型	必須	説明
`serverUrl`	string	はい	Base URL of the Temporal server's HTTP API (e.g., http://localhost:7243\)
`namespace`	string	はい	Temporal namespace (e.g., default)
`apiKey`	string	いいえ	API key sent as a Bearer token (leave blank for servers without auth)
`scheduleId`	string	はい	ID of the schedule to describe

出力

パラメータ	型	説明
`scheduleId`	string	Schedule ID
`paused`	boolean	Whether the schedule is paused
`notes`	string	Human-readable notes on the schedule
`workflowType`	string	Workflow type the schedule starts
`taskQueue`	string	Task queue used for started workflows
`workflowId`	string	Workflow ID template for started workflows
`spec`	json	Schedule spec (calendars, intervals, cron strings, jitter, time zone)
`recentActions`	array	Most recent actions taken by the schedule
↳ `scheduleTime`	string	Nominal scheduled time (RFC 3339)
↳ `actualTime`	string	Actual time the action ran (RFC 3339)
↳ `workflowId`	string	Workflow ID of the started execution
↳ `runId`	string	Run ID of the started execution
`futureActionTimes`	json	Upcoming action times (RFC 3339)

`temporal_pause_schedule`

Pause a Temporal schedule so it stops taking actions until unpaused.

入力

パラメータ	型	必須	説明
`serverUrl`	string	はい	Base URL of the Temporal server's HTTP API (e.g., http://localhost:7243\)
`namespace`	string	はい	Temporal namespace (e.g., default)
`apiKey`	string	いいえ	API key sent as a Bearer token (leave blank for servers without auth)
`scheduleId`	string	はい	ID of the schedule to pause
`reason`	string	いいえ	Reason recorded in the schedule's notes

出力

パラメータ	型	説明
`scheduleId`	string	ID of the paused schedule

`temporal_unpause_schedule`

Unpause a Temporal schedule so it resumes taking actions.

入力

パラメータ	型	必須	説明
`serverUrl`	string	はい	Base URL of the Temporal server's HTTP API (e.g., http://localhost:7243\)
`namespace`	string	はい	Temporal namespace (e.g., default)
`apiKey`	string	いいえ	API key sent as a Bearer token (leave blank for servers without auth)
`scheduleId`	string	はい	ID of the schedule to unpause
`reason`	string	いいえ	Reason recorded in the schedule's notes

出力

パラメータ	型	説明
`scheduleId`	string	ID of the unpaused schedule

`temporal_trigger_schedule`

Trigger an immediate action of a Temporal schedule, outside its normal spec.

入力

パラメータ	型	必須	説明
`serverUrl`	string	はい	Base URL of the Temporal server's HTTP API (e.g., http://localhost:7243\)
`namespace`	string	はい	Temporal namespace (e.g., default)
`apiKey`	string	いいえ	API key sent as a Bearer token (leave blank for servers without auth)
`scheduleId`	string	はい	ID of the schedule to trigger
`overlapPolicy`	string	いいえ	Overlap policy for the triggered action (defaults to the schedule's policy): SCHEDULE_OVERLAP_POLICY_SKIP, SCHEDULE_OVERLAP_POLICY_BUFFER_ONE, SCHEDULE_OVERLAP_POLICY_BUFFER_ALL, SCHEDULE_OVERLAP_POLICY_CANCEL_OTHER, SCHEDULE_OVERLAP_POLICY_TERMINATE_OTHER, or SCHEDULE_OVERLAP_POLICY_ALLOW_ALL

出力

パラメータ	型	説明
`scheduleId`	string	ID of the triggered schedule

`temporal_delete_schedule`

Delete a Temporal schedule. Workflows already started by the schedule keep running.

入力

パラメータ	型	必須	説明
`serverUrl`	string	はい	Base URL of the Temporal server's HTTP API (e.g., http://localhost:7243\)
`namespace`	string	はい	Temporal namespace (e.g., default)
`apiKey`	string	いいえ	API key sent as a Bearer token (leave blank for servers without auth)
`scheduleId`	string	はい	ID of the schedule to delete

出力

パラメータ	型	説明
`scheduleId`	string	ID of the deleted schedule

Temporal

On this page