> ## Documentation Index > Fetch the complete documentation index at: https://docs.stackone.com/llms.txt > Use this file to discover all available pages before exploring further. # download_file > Step function: download_file ## Input
Field Description Type Required
[`args`](#args) Additional request parameters sent as query params, headers, or the request body, per each entry's `in`. object\[] No
[`authorization`](#authorization) Overrides the connector's default authentication for this request. union No
`baseUrl` Overrides the connector's base URL for the download. string No
[`customErrors`](#customerrors) Remaps matching provider error responses to different statuses or messages. object\[] No
`encoding` Encoding applied to the returned data when responseMode is buffer. Use none to return a raw Buffer.
Allowed: `base64`, `utf8`, `binary`, `raw`, `none`
Default: `base64`		 enum Yes
`followRedirects` Whether to follow HTTP redirects.
Default: `true`		 boolean Yes
`maxRedirects` Maximum number of redirects to follow.
Default: `5`		 number Yes
`method` HTTP method to use for the download.
Allowed: `get`, `post`, `put`, `delete`, `patch`
Default: `get`		 enum Yes
[`response`](#response) Options for extracting file content from a JSON-wrapped response. object No
`responseMode` How the file is returned: buffer downloads it fully into memory, stream returns a readable stream for piping to the client.
Allowed: `buffer`, `stream`
Default: `buffer`		 enum Yes
`responseType` Underlying HTTP response type requested. Used only when responseMode is buffer.
Allowed: `arraybuffer`, `blob`, `text`, `json`
Default: `arraybuffer`		 enum Yes
`url` Download endpoint path appended to the base URL. string Yes
Additional request parameters sent as query params, headers, or the request body, per each entry's `in`.
Field Description Type Required
`arrayFormat` How array values are serialized in the query string: repeat, brackets, comma, or stringify.
Allowed: `repeat`, `brackets`, `comma`, `stringify`		 enum No
`condition` A JEXL expression that includes the parameter only when it evaluates true. string No
`in` Where to send the parameter: query, body, or headers.
Allowed: `query`, `body`, `headers`		 enum Yes
`name` Name of the request parameter. string Yes
`spread` Merges the value's object entries into the target location instead of setting a single named field. boolean No
`value` Value of the parameter. Supports expressions. any Yes
Overrides the connector's default authentication for this request.
Field Description Type Required
`redirectUri` OAuth callback URL carried as connect-time metadata. Not used when authorizing requests. string No
[`signing`](#authorization-none-signing) Optional request signing applied to outgoing requests. Selects AWS SigV4 or HMAC signing. union No
`type` Sends requests without an authorization header. string Yes
Optional request signing applied to outgoing requests. Selects AWS SigV4 or HMAC signing.
Field Description Type Required
`region` AWS region used in the signing credential scope. Falls back to the credential region or `us-east-1` when omitted. string No
`service` AWS service name used in the signing credential scope. For example `s3` or `execute-api`. string Yes
`strategy` Signs requests with AWS Signature Version 4. string Yes
Field Description Type Required
`algorithm` Hash algorithm for the HMAC signature. Defaults to `sha256`.
Allowed: `sha1`, `sha256`, `sha512`		 enum No
`dateFormat` Timestamp format used in the signed string. Either `iso8601` (default) or `rfc2822`.
Allowed: `iso8601`, `rfc2822`		 enum No
`headerName` Header the signature is written into. Defaults to `X-Signature`. string No
`includeBodyHash` Hash the request body into the signed string, defaulting to `true`. When `false`, form-urlencoded body params are folded into the canonical string instead. boolean No
`includeHost` Include the request hostname in the signed canonical string. Defaults to `false`. boolean No
`outputFormat` Where the signature is emitted. `header` writes a signature header and `basic` writes an HTTP Basic `Authorization` header.
Allowed: `header`, `basic`		 enum No
`prefix` Prefix prepended to the signature value in the header. Defaults to `hmac-<algorithm>`. string No
`strategy` Signs requests with an HMAC signature over a canonical request string. string Yes
`username` Username paired with the signature when `outputFormat` is `basic`. string No
Field Description Type Required
`encoding` Encoding applied to the `username:password` pair. Defaults to `base64`. string No
`password` Password for HTTP Basic authentication. string No
`redirectUri` OAuth callback URL carried as connect-time metadata. Not used when authorizing requests. string No
`type` Configures HTTP Basic authentication. string Yes
`username` Username for HTTP Basic authentication. string No
Field Description Type Required
`includeBearer` Prefix the token with `Bearer ` in the `Authorization` header. Defaults to `true`.
Default: `true`		 boolean Yes
`redirectUri` OAuth callback URL carried as connect-time metadata. Not used when authorizing requests. string No
`token` Token sent on each request. Supports expressions. string Yes
`type` Configures bearer token authentication. string Yes
Field Description Type Required
`additionalTokenFields` Extra credential fields to read from the token endpoint response. Each key is a credential name and each value an expression. object No
`authorizationParams` Extra query parameters appended to the authorization URL. Values support expressions. object No
`authorizationUrl` Provider authorization endpoint where the user grants access. string No
`callbackParams` Maps OAuth callback query parameter names to the credential keys their values are stored under. Cannot target reserved credential keys. object No
`customHeaders` Additional HTTP headers sent with token endpoint requests. object No
`includeBearer` Prefix the token with `Bearer ` in the `Authorization` header. Defaults to `true`.
Default: `true`		 boolean Yes
`issuer` OpenID Connect issuer identifier for the provider. string No
`pkce` Enable PKCE for the authorization code flow. boolean No
`redirectUri` Overrides the OAuth callback URL. The computed callback URL can be seen on the connector profile. string No
`scopeDelimiter` Delimiter used to separate scopes when requesting authorization. string No
`scopes` OAuth scopes requested during authorization. string No
`token` Expression that resolves the access token sent on each request. string Yes
`tokenExpiresIn` Access token lifetime in seconds. number No
`tokenParams` Extra parameters sent to the token endpoint. Values support expressions. object No
`tokenRefreshExpiresIn` Refresh token lifetime in seconds. number No
[`tokenResponse`](#authorization-oauth2-tokenresponse) Adjusts how a non-standard token endpoint response is parsed. object No
`tokenUrl` Provider token endpoint used to exchange the authorization code and to refresh tokens. string No
`type` Configures OAuth 2.0 authentication. string Yes
Adjusts how a non-standard token endpoint response is parsed.
Field Description Type Required
`acceptTokenTypes` Allowlist of `token_type` values to accept from the token endpoint beyond `Bearer` and `DPoP`. Matched case-insensitively. string\[] No
`accessToken` Expression locating the access token in the token endpoint response. Takes precedence over the standard `access_token` field when it resolves to a non-empty string. string No
`refreshToken` Expression locating the refresh token in the token endpoint response. Takes precedence over the standard `refresh_token` field when it resolves to a non-empty string. string No
Remaps provider error responses to different statuses or messages. Useful for GraphQL APIs that return errors with a 200 status, normalizing provider-specific error formats, and giving AI agents clearer error messages.
Field Description Type Required
`condition` A JEXL expression that applies the remap only when it evaluates true. string No
`message` Error message to return in place of the provider's. string No
`receivedStatus` Provider HTTP status code to match. number Yes
`targetStatus` HTTP status code to return in place of the matched one. number Yes
Options for extracting file content from a JSON-wrapped response.
Field Description Type Required
`contentIsBase64` Whether the content in the JSON response is already base64 encoded.
Default: `false`		 boolean Yes
`contentType` Fallback content type used when the JSON response exposes none to extract. `contentTypeKey` wins if it resolves. string No
`contentTypeKey` JSONPath to the content type within a JSON-wrapped response. string No
`dataKey` JSONPath to the file content within a JSON-wrapped response. string No
`fileNameKey` JSONPath to the filename within a JSON-wrapped response. string No
`forwardAuth` Whether to forward authentication headers to the secondary download request when following urlKey.
Default: `false`		 boolean Yes
`urlKey` JSONPath to a download URL in the response to follow for the file. string No
## Output
Field Description Type Required
`contentDisposition` Content-Disposition header value for the client to use. string No
`data` Downloaded file content. A string in the format set by the `encoding` input (base64 by default), or a raw binary Buffer when `encoding: "none"`. Absent when `responseMode: "stream"` (content is piped via the stream output instead). union No
[`fileMetadata`](#filemetadata) File metadata extracted from response headers or a JSON-wrapped response. object No
`finalUrl` Final URL the file was downloaded from after redirects or a followed link. string No
`headers` All response headers returned with the download. object No
`message` Status or error message from the response. string No
`raw` The raw provider response before parsing. any No
`statusCode` HTTP status code of the provider response. number Yes
File metadata extracted from response headers or a JSON-wrapped response.
Field Description Type Required
`contentLength` Size of the file in bytes. number No
`contentType` MIME type of the downloaded file. string No
`etag` Entity tag identifying the file version. string No
`fileName` Name of the downloaded file. string No
`lastModified` Last-modified timestamp reported for the file. string No