workflow/api

API reference for runtime functions from the workflow/api package.

Functions

The API package is for access and introspection of workflow data to inspect runs, start new runs, or access anything else directly accessible by the world.

start()

Start/enqueue a new workflow run.

resumeHook()

Resume a workflow by sending a payload to a hook.

resumeWebhook()

Resume a workflow by sending a Request to a webhook.

getHookByToken()

Get hook details and metadata by its token.

getRun()

Get workflow run status and metadata without waiting for completion.

getWorld()

Get direct access to workflow storage, queuing, and streaming backends.