Brapi Raw Get
brapi_raw_getPassthrough to any BrAPI GET /{path} endpoint. Returns the raw upstream envelope without enrichment or foreign-key resolution. Emits a suggestion field when a curated tool exists for the same data. Spills to a canvas dataframe when the upstream advertises more rows than loadLimit AND the result is a list shape (result array or result.data envelope); inline result is unchanged. Skips spillover when the caller drives paging via params.page / params.pageSize.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| path | Yes | Endpoint path — e.g. "/samples", "/methods". Leading "/" is optional. | |
| alias | No | Connection alias registered via brapi_connect. Omit to read the connection registered under alias `default` — i.e. a prior brapi_connect call that did not specify an alias. Calls that used a non-default alias must pass that same alias here. | |
| params | No | Query parameters to append. Arrays are repeated per BrAPI convention. | |
| loadLimit | No | Cap on rows returned inline. Omit for the deployment default. Rows beyond the cap land in a dataframe; query with brapi_dataframe_query (SQL) instead of paging row-by-row. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| url | No | Fully resolved URL that was fetched (baseUrl + path + query string). | |
| path | No | Normalized path (leading `/` preserved) that was appended to the baseUrl. | |
| alias | No | Alias of the registered BrAPI connection the call used. | |
| error | No | Present when the call failed. Absent on success. | |
| result | No | Raw BrAPI `result` value — whatever shape the endpoint returns. | |
| metadata | No | BrAPI envelope metadata (pagination and any additional upstream fields). | |
| dataframe | No | Present when the upstream advertised more rows than `loadLimit` AND the result is a list shape. The inline `result` is unchanged; the dataframe carries the full union of pages — query with brapi_dataframe_query. | |
| suggestion | No | Emitted when a curated goal-shaped tool covers this endpoint. |