Get Workflow Run Output
Workflows
Get Workflow Run Output
Read the public output of a workflow run after it completes.
GET
Get Workflow Run Output
Retrieve the final public output for one workflow run.
The endpoint can return any JSON value defined by the workflow. The synchronization contract below requires an object containing a
Use
documents array.
Authentication and scope
Requiresworkflow-runs-output-read. The token owner must be an administrator of the workflow workspace. A synchronization token also needs workspaces-read, workflows-read, and documents-read for discovery and document downloads.
Synchronizable output
End the workflow withfiles.persistWorkspace and expose its documents array as the final public output.
documentId with the workspace document URL endpoint. Do not use the workflow run file endpoint for these persisted documents; that route serves temporary runtime fileRef values.
Treat a missing documents array, a non-array value, or an entry without documentId or filename as an invalid page. Do not advance the page cursor until the output has been validated and recorded for retry.Authorizations
Response
object | null | any[] | string | number | boolean
Public workflow output
The response is of type object.
