Skip to Content
HelvetlyDocs
API referenceDocuments

Download a document

Needs a token with the read:documents scope (or write:documents). Authentication

Try in Playground sends a real request to app.helvetly.com with a token you paste. It stays in this browser tab only (session storage) and goes to no one else.

GET
/api/v1/documents/{id}/download

Answers 302 with a Location header, a presigned URL valid for 5 minutes that saves the file under its current name; when the server proxies downloads (S3_PROXY_DOWNLOADS) it answers 200 with the bytes. Also works for a document in the Trash.

Authorization

bearerAuth
headerAuthorizationBearer <token>

A personal API token, hvt_…, with scopes such as read:* or write:invoices

Path Parameters

id*string

The document's id.

Response Body

The file's bytes (proxied downloads).

response?fileapplication/octet-stream
Formatbinary
Example Request
curl -X GET 'https://app.helvetly.com/api/v1/documents/string/download'
Example Response
"string"