Preview Url

get/v1/flows/{flow_id}/documents/{document_id}/preview

Short-lived presigned GET URL for the dashboard's image / video tags. Tenant-scoped — ``TenantActorDep`` accepts either a Bearer key (SDK) or an operator session cookie. The S3 URL itself is signed against the *public* endpoint so the operator's browser can fetch it directly.

Authentication

Send your tenant secret key as a Bearer token. Keep secret keys on your server; never ship them in browser or mobile code.

Parameters

flow_id

path · required

No additional parameter description.

document_id

path · required

No additional parameter description.

Example request

cURL

curl --request GET \
  --url 'https://api.fideralabs.com/v1/flows/{flow_id}/documents/{document_id}/preview' \
  --header 'Authorization: Bearer $FIDERA_API_KEY'

Responses

200Successful Response

expires_in

integerrequired

No additional field description.

mime_type

string | nullrequired

No additional field description.

url

stringrequired

No additional field description.

application/json

{
  "expires_in": 0,
  "mime_type": "string",
  "url": "string"
}

422Validation Error

detail

ValidationError[]

No additional field description.

Operation ID

preview_url_v1_flows__flow_id__documents__document_id__preview_get