API referenceFiles

Read file

Read contents from a file. <Note>Ensure the path is accessible within the context defined by the `IB-Context` header.</Note>

Authentication

AuthorizationBearer
Bearer HTTP authentication.

Path parameters

pathstringRequired
Full path to the file.

Headers

IB-ContextstringOptional
Specify whether to use your community account or organization account to complete the request. To use your community account, define as your user ID. To use your organization account, define as your organization ID. If unspecified, defaults to community account context. See [Authorization and context identification](/api-sdk/authorization#ib-context-header) for details.
RangestringOptional

The portion of the file to read. A single HTTP byte range, with inclusive bounds and a non-negative start value. If not provided, return the entire file. Example: bytes=0-4

IB-Retry-ConfigstringOptional

Configures retry logic if no file is found at the target path. Uses a constant backoff algorithm. Don’t retry if this header isn’t provided. Example: {retries:3,backoff-seconds:5}

Query parameters

expect-node-typeenumRequired
Type of node at the target path.
Allowed values:

Response

Indicates that the response contains the entire file contents.