Building a webhook integration? Read the webhook guide for signatures, retries, event schemas, and troubleshooting.

apiDeterministic

Get play

GET /api/agent-workflows/plays/{playId}

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

REST requestbash

curl -X GET "https://app.pipeline.help/api/agent-workflows/plays/00000000-0000-4000-8000-000000000000" \
  -H "Authorization: Bearer $PIPELINE_API_KEY"

Response

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

HTTP errors

401: Missing or invalid API key.
403: Authenticated but not permitted for the workspace or resource.
404: The requested resource was not found.