Workers API

The WorkersApi enables executing worker agents from your server. Workers are task-based agents that run steps sequentially and return an output value.

Basic Usage

WorkersApi Reference

execute()

Execute a worker and stream the response.

Parameters:

Options:

continue()

Continue execution after client-side tool handling.

Use this when the worker has tools without server-side handlers. The execution pauses with a client-tool-request event, you execute the tools, then call continue() to resume.

Tool Handlers

Provide tool handlers to execute tools server-side:

Tools defined in the worker protocol but not provided as handlers become client tools — the execution pauses and emits a client-tool-request event.

Stream Events

Workers emit standard stream events plus worker-specific events.

Worker Events

Common Events

Extracting Output

To get just the worker's output value:

Client Tool Continuation

When workers have tools without handlers, execution pauses:

The client-tool-request event includes:

Streaming to HTTP Response

Convert worker events to an SSE stream:

Cancellation

Use an abort signal to cancel execution:

Error Handling

Errors can occur at different levels:

Error types include:

Full Example

Next Steps

• Workers Protocol — Worker protocol reference
• Streaming — Understanding stream events
• Tools — Tool handler patterns