Get File

View as Markdown

Get one PUBLIC file: metadata, a temporary download URL, and a content excerpt when the file was parsed.

Authentication

AuthorizationBearer
Create a personal key in Alpha settings, or use an access token issued to an approved OAuth client.

Request

This endpoint expects an object.
fileIdstringRequired

File id from list_files

vaultstringOptional

Exact vault id or name from list_vaults. Required whenever the key can reach more than one vault; never guess or use one client’s vault for another.

Response headers

X-Request-IdstringOptional
Stable identifier for tracing this request in Alpha logs.

Response

Get File completed.
datamap from strings to any or list of maps from strings to any
The result returned by the selected Alpha tool.

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
404
Not Found Error
429
Too Many Requests Error