• Docs
  • Cookbook
  • Worlds
  • Examples
DocsCookbookWorldsExamples

Getting Started
Next.jsAstroExpressFastifyHonoNitroNuxtSvelteKitTanStack StartVitePythonBeta
Foundations
Workflows and StepsStarting WorkflowsErrors & RetryingHooks & WebhooksStreamingSerializationIdempotencyVersioning
Observability
Building Durable AI AgentsStreaming Updates from ToolsResumable StreamsSleep, Suspense, and SchedulingHuman-in-the-LoopPatterns for Defining ToolsChat Session Modeling
Deploying
Errors
Migration Guides
API Reference

workflow/api

Runtime functions to inspect runs, start workflows, and manage hooks.

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, and manage hooks.

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.

Looking for getWorld() and the World SDK? They are exported from workflow/runtime — see the workflow/runtime reference.

On this page

Functions
Edit this page on GitHub

Copyright Vercel 2026. All rights reserved.