sdkDeterministic

Get play

pipeline.getPlay

Fetch the full definition of a single system play by id. Returns the complete PlayDefinition including inputs/outputs schema, capability metadata, required credentials, retry policy, idempotency key fields, and timeout. Returns 404 when the playId is unknown. Use after list-plays to inspect a candidate step in detail before referencing it from a workflow.

Parameters

workspaceId

string

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

playIdrequired

string

The play id, e.g. "find-lookalike-companies".

Example

TypeScripttypescript

await pipeline.getPlay({
  "playId": "00000000-0000-4000-8000-000000000000"
})

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.