sdkDeterministic

List plays

pipeline.listPlays

List every system play available across the platform. A "play" is a reusable, system-shipped step (source, enrichment, qualification, copy, routing, destination) that workflows compose into pipelines. Each entry returns id, name, description, category, sideEffectLevel, agent role, required tools, and the approval policy. Read-only and global (no workspace scoping). Use this BEFORE compile-workflow-from-prompt to see what building blocks the compiler can choose from.

Parameters

workspaceId

string

Optional workspace ID or slug. Required when this credential can access multiple workspaces and no workspace was configured on the client.

Example

TypeScripttypescript

await pipeline.listPlays({})

Response

The operation is available, but its typed response schema has not been published yet.

Exceptions

PipelineError: Thrown for validation, authentication, JSON-RPC, HTTP, and network failures. Inspect code and data when present.