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 and workflows-read for discovery. Add documents-read when the workflow exposes persisted documentRef outputs.

Synchronizable output

Expose a final documents array. Each entry can be a persisted documentRef or a temporary workflow fileRef augmented with a SHA-256 checksum.
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. For a temporary fileRef, expose its normal file-ref fields plus sha256:
Use id with GET /workspaces/{workspaceId}/workflows/{workflowId}/runs/{runId}/file?file_id={id}. A fileRef is temporary, so it is suitable only for prompt synchronization. The consumer must verify size and sha256 before publishing the file. Treat a missing documents array, a non-array value, an unsupported entry type, or an entry missing its type-specific identifier, filename, size, or sha256 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.