Skip to main content
GET
Create a file download URL
Use the exact key returned with the resource rather than constructing one. expires_in defaults to 900 seconds and ranges from 60 to 900. Set inline=true for browser display when appropriate. A key outside your permitted resources returns 403; malformed keys return 400. The response contains url and expires_in. Treat the URL as sensitive until it expires. Download directly without forwarding your Agent Builder credential to the file host. Omit storage_backend unless you are using the value returned by the resource.

Authorizations

Authorization
string
header
required

Bandwidth Labs OAuth access token. Uses the user's selected workspace; the workspace header is not required. Do not also send an API key. Bearer-only operations may additionally require the Labs super_user role.

Headers

X-VOAI-ORGANIZATION-ID
string | null

Required with X-BW-LABS-AGENTS-API-KEY: the positive local workspace ID to access. The key owner must be a current member. Missing or invalid IDs return 400; non-member workspaces return 403. Not required for bearer authentication, which uses the user's selected workspace.

Query Parameters

key
string
required

S3 object key

expires_in
integer
default:900
Required range: 60 <= x <= 900
inline
boolean
default:false
storage_backend
string | null

Storage backend to use (e.g. 'minio', 's3'). When omitted the backend is inferred from the resource.

Response

Successful Response

expires_in
integer
required
url
string
required