Brapi Raw Search
brapi_raw_searchPassthrough to any BrAPI POST /search/{noun} endpoint, returning the resolved envelope (async polling resolved upstream). Spills to a canvas dataframe when the upstream advertises more rows than loadLimit AND the result is a list shape; inline result is unchanged. Skips spillover when the caller drives paging via body.page / body.pageSize. No distributions or foreign-key resolution applied.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | Filter body passed verbatim to POST /search/{noun}. | |
| noun | Yes | Search noun — e.g. "observations", "calls", "germplasm". | |
| 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. | |
| 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 |
|---|---|---|---|
| kind | No | Whether the server returned inline results or we polled an async search. | |
| noun | No | The `/search/{noun}` segment the body was posted to. | |
| 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 search. | |
| searchResultsDbId | No | Populated when the server returned an async searchResultsDbId. |