Documents (permanent storage)

Generates pre-signed URLs for downloading documents.

post

https://api.rialtobridge.xyz/api/client/v1https://staging.api.rialtobridge.xyz/api/client/v1http://localhost:3002/api/client/v1

/documents/request-batch-download

Generates pre-signed URLs for downloading documents. Only documents in permanent storage can be downloaded. Each pre-signed URL is valid for 5 minutes. See the S3 documentation for more information on S3 pre-signed URLs.

Authorizations

api_key

RIALTO_API_KEYstringRequired

Body

application/json

keysstring[]Optional

The list of keys for which to generate pre-signed URLs.

Responses

201

Pre-signed URLs for downloading documents.

application/json

400

Invalid request payload

401

Invalid API key

404

Document not found

500

An unexpected error occurred.

post

/documents/request-batch-download

HTTPcURLJavaScriptPython

POST /api/client/v1/documents/request-batch-download HTTP/1.1
Host: api.rialtobridge.xyz
RIALTO_API_KEY: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 120

{
  "keys": [
    "rialto-clients/entities/d61b6b30-0bf6-4fe7-9110-905b78f938df/26f7380a-dbf7-46a4-9568-7881cc8bfce7_file1.pdf"
  ]
}

[
  {
    "key": "rialto-clients/entities/d61b6b30-0bf6-4fe7-9110-905b78f938df/26f7380a-dbf7-46a4-9568-7881cc8bfce7_file1.pdf",
    "filename": "file1.pdf",
    "preSignedUrl": "https://rialto-bridge.s3.amazonaws.com/91e5bd3c-0e13-4e6e-a673-3c0842b7f370_abc/26f7380a-dbf7-46a4-9568-7881cc8bfce7_file1.pdf?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIAJZ6Z6Z6Z6Z6Z6Z6Z%2F20220301%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Date=20220301T000000Z&X-Amz-Expires=300&X-Amz-SignedHeaders=host&X-Amz-Signature=1234567890abcdef1234567890abcdef1234567890abcdef1234567890abcdef"
  }
]