Skip to main content
POST
/
v1
/
downloads
Get a pre-signed URL to download an exported document without proxying through the agent.
curl --request POST \
  --url https://api.example.com/v1/downloads \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "session_id": "<string>",
  "format": "docx",
  "filename": "<string>"
}
'
{
  "download_url": "<string>",
  "expires_at": "<string>",
  "expires_in_seconds": 123,
  "curl_example": "<string>",
  "filename": "<string>",
  "format": "<string>"
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

​
authorization
string | null

Body

application/json
​
session_id
string
required

Session ID whose current document should be exported and packaged for download.

Maximum string length: 200
​
format
enum<string>
default:docx

Export format. 'doc' = Word-compatible HTML (highest fidelity), 'docx' = native OOXML, 'pdf' = portable, 'html' = raw markup.

Available options:
doc,
docx,
pdf,
html
​
filename
string | null

Optional Content-Disposition filename for the download (without extension). Auto-detected from the document's first heading if not provided.

Maximum string length: 200

Response

Successful Response

​
download_url
string
required
​
expires_at
string
required
​
expires_in_seconds
integer
required
​
curl_example
string
required
​
filename
string
required
​
format
string
required