[V3 REST API] Results Table APIs Beta
The Beta Notebook Document APIs now support Results Tables as a first-class DocumentPart, along with new partsMutation operations for inserting rows and updating cells in Results Tables and Unstructured Tables.
For full details and tutorials on how to use the new Results Table APIs, read the Working with Tables API Guide →
🆕 Added
DocumentPartResultsTable
- Added Results Tables as a new
DocumentParttype (DocumentPartResultsTable). Results Tables capture experimental data against a result schema. - Added
results_tableas a newcontentTypefor inserting a Results Table with theinsertoperation. Specify theresultSchemaIdthat defines the table’s columns and anamefor the table.
GET /document-part-results-table/{document_part_results_table_id}
- Added a new endpoint for reading a Results Table by id.
GET /document-part-results-table/{document_part_results_table_id}/rows/items
- Added a new endpoint for listing the rows of a Results Table.
PATCH /entry/{entry_id}
- Added the
insert_table_rowsoperation topartsMutationfor appending rows to a table. Each row’s cells are addressed bycolumnIndex, and columns without a provided cell receive the column’s default value. SetreplaceEmptyTrailingRowstotrueto fill any empty rows at the end of the table instead of adding after them. - Added the
update_table_cellsoperation topartsMutationfor editing table cells. Each entry incellUpdatestargets a single cell byrowIndexandcolumnIndex.
⚠️ Updated
PATCH /entry/{entry_id}
- Replaced the
coordinatesobject on theinsertoperation with a flatpositionproperty. For example,"coordinates": { "position": "end_of_document" }is now"position": "end_of_document". - Replaced the
destinationCoordinatesobject on themoveoperation with a flatdestinationPositionproperty. - Replaced
coordinateson thedeleteoperation andsourceCoordinateson themoveoperation with asourceRangeobject.fromDocumentPartIdandtoDocumentPartIdhave been renamed tostartandend.
POST /result and POST /result:batch-create
- Replaced the
tableHandleIdproperty withdocumentPartResultsTableId, which usesdocpart_id. Only one of the two properties may be specified on a request.
PATCH /document-part-unstructured-table/{doc_part_id}
- Deprecated this endpoint. To edit cell content, use the
update_table_cellsoperation. To append rows, use theinsert_table_rowsoperation. To change columns or merged cells, delete the table with thedeleteoperation and re-create it with theinsertoperation.
🚧 Beta
Reminder: Beta endpoints (accessed via EARLY-ACCESS: true) may change at any time without notice. Read the full stability guidelines for more information→