/api/v1/files/signed-urlsGet short-lived URLs for up to 100 stored files in one call.
Get short-lived URLs for up to 100 stored files in one call.
Send the storage keys in keys: the filePath values of file or photo
fields on records. Each key gets its own result, in request order, so one
bad key does not fail the batch. A result has a url, or url: null and
an error. not_found covers both a missing file and a file on a record
the credential cannot see. expiresIn is the number of seconds the URLs
stay valid, or null when they do not expire.
Errors:
422—keysis not an array of non-empty strings, or holds more than 100 keys.
Request:
{
"keys": [
"contacts/1042/contract-k3v9x2mq/1726300000000-3f1c9a2e-7b4d-4e0a-9c61-2d8f5b0e41a7.pdf",
"contacts/1042/contract-k3v9x2mq/1726300000000-0b9e6d2a-51c4-4f7e-8a3d-6e2f1c7b9d40.pdf"
]
}
Response 201:
{
"status": 201,
"message": "Signed URLs generated",
"data": {
"results": [
{
"key": "contacts/1042/contract-k3v9x2mq/1726300000000-3f1c9a2e-7b4d-4e0a-9c61-2d8f5b0e41a7.pdf",
"url": "https://storage.example.com/contacts/1042/contract-k3v9x2mq/1726300000000-3f1c9a2e-7b4d-4e0a-9c61-2d8f5b0e41a7.pdf?X-Amz-Expires=3600&X-Amz-Signature=5d0e9f"
},
{
"key": "contacts/1042/contract-k3v9x2mq/1726300000000-0b9e6d2a-51c4-4f7e-8a3d-6e2f1c7b9d40.pdf",
"url": null,
"error": "not_found"
}
],
"expiresIn": 3600
}
}
Send request
Use the documented inputs to call this endpoint directly.
Request body
application/jsonrequiredResponses
Successful response
{
"message": "string",
"data": "string"
}Bad request
{
"status": 1,
"message": "string",
"code": "string",
"data": {}
}The HTTP status code of the response.
What went wrong. Several validation messages are joined with ", ".
A stable, machine-readable reason. Only some errors set it.
Extra detail about the error. Only some errors set it.
Unauthorized
{
"status": 1,
"message": "string",
"code": "string",
"data": {}
}The HTTP status code of the response.
What went wrong. Several validation messages are joined with ", ".
A stable, machine-readable reason. Only some errors set it.
Extra detail about the error. Only some errors set it.
Internal server error
{
"status": 1,
"message": "string",
"code": "string",
"data": {}
}The HTTP status code of the response.
What went wrong. Several validation messages are joined with ", ".
A stable, machine-readable reason. Only some errors set it.
Extra detail about the error. Only some errors set it.
Powered by heyo-docs