This page documents the canonical HTTP contract for this endpoint.
This preview sends a real outbound request, but does not write table cells. It resolves templates from the chosen row (or first row by table position) and workspace secrets, then uses the public-request transport. Response fields include ok, status_code, body, headers, sanitized resolved_url, resolved_row, truncation/byte/redirect counts, and elapsed time; validation and transport failures return ok:false and an error code (with error_type for request errors). This request model is compatibility-configured and ignores extra fields.
Path parameters
table_idrequiredstring
Research Table ID.
| Name | Type | Description |
|---|---|---|
| table_idrequired | string | Research Table ID. |
Body parameters
method· optionalstring
HTTP method; default GET.
urlrequiredstring
URL template. The request is sent to the resolved public destination.
query· optionalobject
Query parameter templates; default {}.
headers· optionalobject<string,string>
Header templates; default {}.
body· optionalany|null
Optional request body.
bodyMode· optionalstring|null
none, text, or json; optional.
timeoutSeconds· optionalinteger
Default 30 seconds; the request preparation layer validates effective bounds.
rowId· optionalstring|null
Optional row ID; otherwise the first row by table position is used.
| Name | Type | Description |
|---|---|---|
| method | string | HTTP method; default GET. |
| urlrequired | string | URL template. The request is sent to the resolved public destination. |
| query | object | Query parameter templates; default {}. |
| headers | object<string,string> | Header templates; default {}. |
| body | any|null | Optional request body. |
| bodyMode | string|null | none, text, or json; optional. |
| timeoutSeconds | integer | Default 30 seconds; the request preparation layer validates effective bounds. |
| rowId | string|null | Optional row ID; otherwise the first row by table position is used. |
Errors
| Status | Meaning |
|---|---|
| 401 | Authentication is required. |
| 403 | The caller lacks access to the resource or the columns:write scope. |
| 422 | The request does not satisfy the route or typed request contract. |
