GET

Download a file from an inbox document

Scope: inbox:inbox.read https://api.alladdin.com/api/v2/inbox/{incomingDocumentId}/files/{filename}/download

Returns the raw content of a file attached to an incoming document. Use ?variant=inline to display the file in-browser with 24-hour caching instead of triggering a download.

Parameters

Path parameters

incomingDocumentId string required

Incoming document identifier

filename string required

Name of the file to retrieve

Query parameters

variant string optional = download

Delivery mode: download (attachment) or inline (display with cache)

"download" "inline"

Request

python

import requests

url = "https://api.alladdin.com/api/v2/inbox/507f1f77bcf86cd799439011/files/document.pdf/download?variant=download"
headers = {
    "Authorization": "Bearer YOUR_API_KEY",
    "Accept": "application/json",
}

response = requests.get(url, headers=headers)
print(response.json())

Responses

Response

json

"string"

Success responses

200 File content application/octet-stream string<binary>

Error responses

401 Invalid or missing API key application/json 403 Insufficient permissions application/json 404 Document or file not found application/json 429 Rate limit exceeded application/json

← PreviousGet an incoming document by ID →

Next →Get a processed thumbnail of a file from an inbox document →

Alladdin