/api/v1/files/signed-urlGet a short-lived URL for one stored file.
Get a short-lived URL for one stored file.
Pass the file's storage key in key: the filePath value of a file or
photo field on a record. The URL serves the file under the name and type
it was uploaded with, so it can be used directly in a browser or an image
tag. expiresIn is the number of seconds the URL stays valid, or null
when it does not expire.
The key must belong to a record the credential can see. A key that does
not exist and a key you may not read both answer 404.
Query parameters:
key(required) — the storage key of the file.
Errors:
400—keyis missing, or it is not a valid storage key.404—File not found.
Response 200:
{
"status": 200,
"message": "Signed URL generated",
"data": {
"url": "https://storage.example.com/contacts/1042/contract-k3v9x2mq/1726300000000-3f1c9a2e-7b4d-4e0a-9c61-2d8f5b0e41a7.pdf?X-Amz-Expires=3600&X-Amz-Signature=5d0e9f",
"expiresIn": 3600
}
}
Send request
Use the documented inputs to call this endpoint directly.
Parameters
Values are applied to the request and the example on the right.
Responses
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