> For the complete documentation index, see [llms.txt](https://docs.pyck.cloud/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.pyck.cloud/graphql-api/services/workflow.md).

# workflow

Audience: Programmer

## Queries

* [assignableWorkflowExecutions](https://docs.pyck.cloud/graphql-api/queries/assignableworkflowexecutions.md) — List assignable workflow executions with pagination support.
* [currentUserDataInput](https://docs.pyck.cloud/graphql-api/queries/currentuserdatainput.md)
* [nodeWorkflow](https://docs.pyck.cloud/graphql-api/queries/nodeworkflow.md) — Fetches an object given its ID.
* [nodesWorkflow](https://docs.pyck.cloud/graphql-api/queries/nodesworkflow.md) — Lookup nodes by a list of IDs.
* [remoteUI](https://docs.pyck.cloud/graphql-api/queries/remoteui.md) — Resolves the fully rendered web + mobile UI bundle URLs for a specific workflow execution, keyed by workflow ID + run ID.
* [transactionRouting](https://docs.pyck.cloud/graphql-api/queries/transactionrouting.md) — The routing status of the events a mutation published, by the `transactionID` the mutation returned.
* [workerDeploymentUIBundles](https://docs.pyck.cloud/graphql-api/queries/workerdeploymentuibundles.md) — Lists every Worker Deployment Version in the tenant's namespace with its drainage status and the UI bundle it ships.
* [workflowActions](https://docs.pyck.cloud/graphql-api/queries/workflowactions.md)
* [workflowAssignee](https://docs.pyck.cloud/graphql-api/queries/workflowassignee.md)
* [workflowExecutions](https://docs.pyck.cloud/graphql-api/queries/workflowexecutions.md) — List workflow executions with pagination support.
* [workflowHistory](https://docs.pyck.cloud/graphql-api/queries/workflowhistory.md) — Fetch workflow history for executions matching filter criteria.
* [workflowIsAssignable](https://docs.pyck.cloud/graphql-api/queries/workflowisassignable.md) — Returns whether the given workflow execution is currently assignable.
* [workflowServiceInfo](https://docs.pyck.cloud/graphql-api/queries/workflowserviceinfo.md)
* [workflowSignals](https://docs.pyck.cloud/graphql-api/queries/workflowsignals.md)
* [workflowTargets](https://docs.pyck.cloud/graphql-api/queries/workflowtargets.md) — Read the current target surfaces of a single workflow execution.
* [workflows](https://docs.pyck.cloud/graphql-api/queries/workflows.md)

## Mutations

* [cancelWorkflow](https://docs.pyck.cloud/graphql-api/mutations/cancelworkflow.md)
* [deleteWorkflow](https://docs.pyck.cloud/graphql-api/mutations/deleteworkflow.md)
* [ensureTemporalNamespace](https://docs.pyck.cloud/graphql-api/mutations/ensuretemporalnamespace.md)
* [registerWorkflow](https://docs.pyck.cloud/graphql-api/mutations/registerworkflow.md)
* [setWorkflowAssignee](https://docs.pyck.cloud/graphql-api/mutations/setworkflowassignee.md)
* [setWorkflowIsAssignable](https://docs.pyck.cloud/graphql-api/mutations/setworkflowisassignable.md) — Toggle the `pyck_workflow_is_assignable` search attribute on a running workflow execution.
* [setWorkflowTargets](https://docs.pyck.cloud/graphql-api/mutations/setworkflowtargets.md) — Replace the target surfaces of a running workflow execution.
* [submitUserDataInput](https://docs.pyck.cloud/graphql-api/mutations/submituserdatainput.md)
* [unregisterWorker](https://docs.pyck.cloud/graphql-api/mutations/unregisterworker.md) — Marks the calling worker's live signal subscriptions as stopped, e.g.

## Types

* [ActionDefinition](https://docs.pyck.cloud/graphql-api/types/actiondefinition.md)
* [CancelWorkflowPayload](https://docs.pyck.cloud/graphql-api/types/cancelworkflowpayload.md)
* [CurrentUserDataInput](https://docs.pyck.cloud/graphql-api/types/currentuserdatainput.md)
* [DeploymentVersionUI](https://docs.pyck.cloud/graphql-api/types/deploymentversionui.md) — A Worker Deployment Version and the UI bundles it ships.
* [DeploymentVersionUIBundle](https://docs.pyck.cloud/graphql-api/types/deploymentversionuibundle.md) — A UI bundle stamped on a deployment version for a given workflow type.
* [DeploymentVersionUIConnection](https://docs.pyck.cloud/graphql-api/types/deploymentversionuiconnection.md) — A connection to a list of DeploymentVersionUI items.
* [DeploymentVersionUIEdge](https://docs.pyck.cloud/graphql-api/types/deploymentversionuiedge.md) — An edge in a DeploymentVersionUI connection.
* [DeploymentVersionUIPageInfo](https://docs.pyck.cloud/graphql-api/types/deploymentversionuipageinfo.md) — Pagination information for a DeploymentVersionUI connection.
* [EntityEventsOutbox](https://docs.pyck.cloud/graphql-api/types/entityeventsoutbox.md)
* [GetWorkflowActionsResponse](https://docs.pyck.cloud/graphql-api/types/getworkflowactionsresponse.md)
* [GetWorkflowAssigneeResponse](https://docs.pyck.cloud/graphql-api/types/getworkflowassigneeresponse.md)
* [GetWorkflowIsAssignableResponse](https://docs.pyck.cloud/graphql-api/types/getworkflowisassignableresponse.md)
* [GetWorkflowTargetsResponse](https://docs.pyck.cloud/graphql-api/types/getworkflowtargetsresponse.md)
* [PageInfo](https://docs.pyck.cloud/graphql-api/types/pageinfo.md) — Information about pagination in a connection.
* [RemoteUIBundleURLs](https://docs.pyck.cloud/graphql-api/types/remoteuibundleurls.md) — Fully rendered UI bundle asset URLs.
* [RoutingEntry](https://docs.pyck.cloud/graphql-api/types/routingentry.md) — The routing status of one event of a transaction.
* [RoutingTarget](https://docs.pyck.cloud/graphql-api/types/routingtarget.md) — One workflow start or signal the router attempted for an event.
* [ServiceInfo](https://docs.pyck.cloud/graphql-api/types/serviceinfo.md)
* [SetWorkflowAssigneeResponse](https://docs.pyck.cloud/graphql-api/types/setworkflowassigneeresponse.md)
* [SetWorkflowIsAssignableResponse](https://docs.pyck.cloud/graphql-api/types/setworkflowisassignableresponse.md)
* [SetWorkflowTargetsResponse](https://docs.pyck.cloud/graphql-api/types/setworkflowtargetsresponse.md)
* [SubmitUserDataInputResponse](https://docs.pyck.cloud/graphql-api/types/submituserdatainputresponse.md)
* [TemporalMetadata](https://docs.pyck.cloud/graphql-api/types/temporalmetadata.md)
* [TemporalWorkflow](https://docs.pyck.cloud/graphql-api/types/temporalworkflow.md)
* [TransactionRouting](https://docs.pyck.cloud/graphql-api/types/transactionrouting.md) — What the router has done so far for the events of one transaction.
* [UIBundle](https://docs.pyck.cloud/graphql-api/types/uibundle.md) — The UI bundle (slug + version) a deployment version ships.
* [UnregisterWorkerPayload](https://docs.pyck.cloud/graphql-api/types/unregisterworkerpayload.md)
* [Workflow](https://docs.pyck.cloud/graphql-api/types/workflow.md)
* [WorkflowConnection](https://docs.pyck.cloud/graphql-api/types/workflowconnection.md) — A connection to a list of items.
* [WorkflowDeletePayload](https://docs.pyck.cloud/graphql-api/types/workflowdeletepayload.md)
* [WorkflowEdge](https://docs.pyck.cloud/graphql-api/types/workflowedge.md) — An edge in a connection.
* [WorkflowEvent](https://docs.pyck.cloud/graphql-api/types/workflowevent.md)
* [WorkflowExecution](https://docs.pyck.cloud/graphql-api/types/workflowexecution.md)
* [WorkflowExecutionHistory](https://docs.pyck.cloud/graphql-api/types/workflowexecutionhistory.md) — Workflow execution with its history.
* [WorkflowExecutionHistoryConnection](https://docs.pyck.cloud/graphql-api/types/workflowexecutionhistoryconnection.md) — A connection to a list of WorkflowExecutionHistory items.
* [WorkflowExecutionHistoryEdge](https://docs.pyck.cloud/graphql-api/types/workflowexecutionhistoryedge.md) — An edge in a WorkflowExecutionHistory connection.
* [WorkflowExecutionInfo](https://docs.pyck.cloud/graphql-api/types/workflowexecutioninfo.md) — Information about a workflow execution.
* [WorkflowExecutionInfoConnection](https://docs.pyck.cloud/graphql-api/types/workflowexecutioninfoconnection.md) — A connection to a list of WorkflowExecutionInfo items.
* [WorkflowExecutionInfoEdge](https://docs.pyck.cloud/graphql-api/types/workflowexecutioninfoedge.md) — An edge in a WorkflowExecutionInfo connection.
* [WorkflowExecutionPageInfo](https://docs.pyck.cloud/graphql-api/types/workflowexecutionpageinfo.md) — Information about pagination in a connection.
* [WorkflowPageInfo](https://docs.pyck.cloud/graphql-api/types/workflowpageinfo.md) — Page info for workflow connections.
* [WorkflowSignal](https://docs.pyck.cloud/graphql-api/types/workflowsignal.md)
* [WorkflowSignalConnection](https://docs.pyck.cloud/graphql-api/types/workflowsignalconnection.md) — A connection to a list of items.
* [WorkflowSignalEdge](https://docs.pyck.cloud/graphql-api/types/workflowsignaledge.md) — An edge in a connection.
* [WorkflowType](https://docs.pyck.cloud/graphql-api/types/workflowtype.md)
* [WorkflowUpdateType](https://docs.pyck.cloud/graphql-api/types/workflowupdatetype.md)

## Interfaces

* [NodeWorkflow](https://docs.pyck.cloud/graphql-api/interfaces/nodeworkflow.md) — An object with an ID.

## Inputs

* [CancelWorkflowInput](https://docs.pyck.cloud/graphql-api/inputs/cancelworkflowinput.md)
* [CreateWorkflowInput](https://docs.pyck.cloud/graphql-api/inputs/createworkflowinput.md) — CreateWorkflowInput is used for create Workflow object.
* [CreateWorkflowSignalInput](https://docs.pyck.cloud/graphql-api/inputs/createworkflowsignalinput.md) — CreateWorkflowSignalInput is used for create WorkflowSignal object.
* [EntityEventsOutboxWhereInput](https://docs.pyck.cloud/graphql-api/inputs/entityeventsoutboxwhereinput.md) — EntityEventsOutboxWhereInput is used for filtering EntityEventsOutbox objects.
* [GetWorkflowActionsInput](https://docs.pyck.cloud/graphql-api/inputs/getworkflowactionsinput.md)
* [GetWorkflowAssigneeInput](https://docs.pyck.cloud/graphql-api/inputs/getworkflowassigneeinput.md)
* [GetWorkflowIsAssignableInput](https://docs.pyck.cloud/graphql-api/inputs/getworkflowisassignableinput.md)
* [GetWorkflowTargetsInput](https://docs.pyck.cloud/graphql-api/inputs/getworkflowtargetsinput.md)
* [RegisterWorkflowSignalInput](https://docs.pyck.cloud/graphql-api/inputs/registerworkflowsignalinput.md)
* [RegisterWorkflowWithSignalsInput](https://docs.pyck.cloud/graphql-api/inputs/registerworkflowwithsignalsinput.md)
* [RemoteUIQueryInput](https://docs.pyck.cloud/graphql-api/inputs/remoteuiqueryinput.md)
* [SetWorkflowAssigneeInput](https://docs.pyck.cloud/graphql-api/inputs/setworkflowassigneeinput.md)
* [SetWorkflowIsAssignableInput](https://docs.pyck.cloud/graphql-api/inputs/setworkflowisassignableinput.md)
* [SetWorkflowTargetsInput](https://docs.pyck.cloud/graphql-api/inputs/setworkflowtargetsinput.md)
* [SubmitUserDataInputInput](https://docs.pyck.cloud/graphql-api/inputs/submituserdatainputinput.md)
* [UpdateWorkflowInput](https://docs.pyck.cloud/graphql-api/inputs/updateworkflowinput.md) — UpdateWorkflowInput is used for update Workflow object.
* [UpdateWorkflowSignalInput](https://docs.pyck.cloud/graphql-api/inputs/updateworkflowsignalinput.md) — UpdateWorkflowSignalInput is used for update WorkflowSignal object.
* [UserDataInputQueryInput](https://docs.pyck.cloud/graphql-api/inputs/userdatainputqueryinput.md)
* [WorkflowActionsWhereInput](https://docs.pyck.cloud/graphql-api/inputs/workflowactionswhereinput.md)
* [WorkflowExecutionOrder](https://docs.pyck.cloud/graphql-api/inputs/workflowexecutionorder.md) — Ordering options for WorkflowExecution connections.
* [WorkflowExecutionsWhereInput](https://docs.pyck.cloud/graphql-api/inputs/workflowexecutionswhereinput.md)
* [WorkflowOrder](https://docs.pyck.cloud/graphql-api/inputs/workfloworder.md) — Ordering options for Workflow connections
* [WorkflowSignalOrder](https://docs.pyck.cloud/graphql-api/inputs/workflowsignalorder.md) — Ordering options for WorkflowSignal connections
* [WorkflowSignalWhereInput](https://docs.pyck.cloud/graphql-api/inputs/workflowsignalwhereinput.md) — WorkflowSignalWhereInput is used for filtering WorkflowSignal objects.
* [WorkflowWhereInput](https://docs.pyck.cloud/graphql-api/inputs/workflowwhereinput.md) — WorkflowWhereInput is used for filtering Workflow objects.

## Enums

* [JSONType](https://docs.pyck.cloud/graphql-api/enums/jsontype.md) — JSON type for casting extracted JSONB values during ordering.
* [OrderDirection](https://docs.pyck.cloud/graphql-api/enums/orderdirection.md) — Possible directions in which to order a list of items when provided an `orderBy` argument.
* [RoutingOutcome](https://docs.pyck.cloud/graphql-api/enums/routingoutcome.md) — How the router settled one event: finished, or given up on.
* [RoutingTargetKind](https://docs.pyck.cloud/graphql-api/enums/routingtargetkind.md) — What happened to one target of an event.
* [WorkflowExecutionOrderDirection](https://docs.pyck.cloud/graphql-api/enums/workflowexecutionorderdirection.md) — Possible directions in which to order a list of items.
* [WorkflowExecutionOrderField](https://docs.pyck.cloud/graphql-api/enums/workflowexecutionorderfield.md) — Properties by which WorkflowExecution connections can be ordered.
* [WorkflowOrderField](https://docs.pyck.cloud/graphql-api/enums/workfloworderfield.md) — Properties by which Workflow connections can be ordered.
* [WorkflowSignalOrderField](https://docs.pyck.cloud/graphql-api/enums/workflowsignalorderfield.md) — Properties by which WorkflowSignal connections can be ordered.
* [WorkflowSignalType](https://docs.pyck.cloud/graphql-api/enums/workflowsignaltype.md) — WorkflowSignalType is enum for the field temporal\_signal\_type
* [WorkflowTarget](https://docs.pyck.cloud/graphql-api/enums/workflowtarget.md) — Client surfaces a workflow can target.

## Scalars

* [Any](https://docs.pyck.cloud/graphql-api/scalars/any.md)
* [Cursor](https://docs.pyck.cloud/graphql-api/scalars/cursor.md) — Define a Relay Cursor type: <https://relay.dev/graphql/connections.htm#sec-Cursor>
* [Int64](https://docs.pyck.cloud/graphql-api/scalars/int64.md) — The builtin Int64 type
* [Map](https://docs.pyck.cloud/graphql-api/scalars/map.md) — The builtin Map type
* [Time](https://docs.pyck.cloud/graphql-api/scalars/time.md) — The builtin Time type
* [UInt64](https://docs.pyck.cloud/graphql-api/scalars/uint64.md)
* [UUID](https://docs.pyck.cloud/graphql-api/scalars/uuid.md)


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs.pyck.cloud/graphql-api/services/workflow.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
