Skip to main content
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 documents array.

Authentication and scope

Requires workflow-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 with files.persistWorkspace and expose its documents array as the final public output.
Use 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

Authorization
string
header
required

Personal Access Token created from the Raydocs dashboard. Include in the Authorization header: Bearer <your_token> See API Keys for token creation and management.

Path Parameters

workspaceId
integer
required
workflowId
string<uuid>
required
runId
string<uuid>
required

Response

object | null | any[] | string | number | boolean

Public workflow output

The response is of type object.