Skip to main content

Options

string
required
Path to the file within the repository
string
Branch name, tag, or commit SHA. Defaults to the default branch.
boolean
When true, resolves the ref under the ephemeral namespace.
boolean
When true, resolves the base branch under the ephemeral namespace. TypeScript: ephemeralBase; Python: ephemeral_base; Go: EphemeralBase.
string
HTTP Range header, such as bytes=0-1023. TypeScript/Python: range; Go: Range.
string
HTTP If-Match header. TypeScript: ifMatch; Python: if_match; Go: IfMatch.
string
HTTP If-None-Match header. TypeScript: ifNoneMatch; Python: if_none_match; Go: IfNoneMatch.
string
HTTP If-Modified-Since header. TypeScript: ifModifiedSince; Python: if_modified_since; Go: IfModifiedSince.
string
HTTP If-Unmodified-Since header. TypeScript: ifUnmodifiedSince; Python: if_unmodified_since; Go: IfUnmodifiedSince.
string
HTTP If-Range header. TypeScript: ifRange; Python: if_range; Go: IfRange.
number
Token TTL in seconds.

Returns

Returns a standard Fetch Response object (TypeScript), an async response object (Python), or an *http.Response (Go) that can be used to stream or read the file content. When range or conditional headers are provided, statuses 206, 304, 412, and 416 are returned to the caller with their response headers.