Browse the api reference

Download Document File

get/v1/graphs/{graph_id}/documents/{document_id}/file

Part of Documents.

A short-lived link to a document's stored file, such as the statement PDF behind a recorded balance.

Authentication

Authenticate in any one of these ways — not all of them:

  • API key in the X-API-Key header.
  • Bearer token in the Authorization header.

Path parameters

NameTypeDescription
graph_idrequiredstringGraph Id
document_idrequiredstringDocument Id

Example request

curl
curl -X GET "https://api.robosystems.ai/v1/graphs/{graph_id}/documents/{document_id}/file" \
  -H "X-API-Key: $ROBOSYSTEMS_API_KEY"

Responses

200 Successful Response

FieldTypeDescription
document_idrequiredstring
download_urlrequiredstring

Presigned URL to GET the file.

expires_inrequiredinteger

Seconds until the URL expires.

filerequiredDocumentFileInfo

The stored file behind a document, when it is one.

DocumentFileInfo fields
FieldTypeDescription
file_namerequiredstring

The file's name as uploaded.

content_typerequiredstring

The file's media type.

size_bytesrequiredinteger

The stored file's size.

sha256requiredstring

Hex SHA-256 of the stored bytes, taken when the upload completed. A stored file never changes, so this identifies it.

StatusMeaning
400Invalid request
401Authentication required
403Access denied
404Resource not found
422Validation Error
429Rate limit exceeded
500Internal server error