Skip to navigation
Documents

fileLink

Create a temporary download link for a file, page, crop, X-Ray or extraction output you own. The link stops working at expiresAt without changing the file’s policy or other URLs. The recipient may also need an API key, depending on requireAuthentication. Storage-signed links remain valid until expiry even if a policy or API key changes.

Authentication

X-API-Keystring
API Key authentication via header

Path parameters

documentIdstringRequired

Request

This endpoint expects an object.
assetobjectRequired
requireAuthenticationbooleanOptional

True requires the owning account’s API key in X-API-Key. False lets anyone with the link read the file. Both links expire at expiresAt. Omit to create a storage-signed link that needs no GroundX key.

expiresInSecondsintegerOptional1-604800
Link lifetime in seconds. Cannot exceed the effective policy's urlTtlSeconds. Omit to use that maximum.

Response

Private, no-store response

urlstringformat: "uri"
expiresAtstringformat: "date-time"

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
404
Not Found Error
409
Conflict Error
503
Service Unavailable Error