---
title: workflow/api
description: Runtime functions to inspect runs, start workflows, and manage hooks.
docs_index: /llms.txt
lastUpdated: 2026-10-13
type: overview
summary: Explore runtime functions for starting workflows, inspecting runs, and managing hooks.
---

> For an index of all documentation, see [/llms.txt](/llms.txt).

The `workflow/api` package provides runtime functions to inspect runs, start new runs, and manage hooks.

## Functions

#### [start()](/docs/api-reference/workflow-api/start)

Start/enqueue a new workflow run.

#### [resumeHook()](/docs/api-reference/workflow-api/resume-hook)

Resume a workflow by sending a payload to a hook.

#### [resumeWebhook()](/docs/api-reference/workflow-api/resume-webhook)

Resume a workflow by sending a `Request` to a webhook.

#### [getHookByToken()](/docs/api-reference/workflow-api/get-hook-by-token)

Get hook details and metadata by its token.

#### [getRun()](/docs/api-reference/workflow-api/get-run)

Get workflow run status and metadata without waiting for completion.

#### [registerLifecycleHooks()](/docs/api-reference/workflow-api/register-lifecycle-hooks)

Observe run completions and failures with global handlers.

> Looking for `getWorld()` and the World SDK? They are exported from `workflow/runtime`. See the [`workflow/runtime` reference](/docs/api-reference/workflow-runtime).

---

For a semantic overview of all documentation, see [/sitemap.md](/sitemap.md)

For an index of all available documentation, see [/llms.txt](/llms.txt)

For agent-facing discovery, including API and MCP surfaces, see [/agents.md](/agents.md)