--- title: "Create a notebook entry" method: POST path: "/entries" tags: ["entries"] --- # Create a notebook entry `POST /entries` ## Request - Base URL: `https://{tenant_name}.benchling.com/api/v2` - URL: `https://{tenant_name}.benchling.com/api/v2/entries` - Auth: HTTP bearer Create a notebook entry ## Request body - EntryCreate - `authorIds` union - string - string[] - `customFields` CustomFields - `entryTemplateId` string: ID of the template to clone the entry from - `fields` Fields - `folderId` string, required: ID of the folder that will contain the entry - `initialTables` InitialTable[]: An array of table API IDs and blob id pairs to seed tables from the template while creating the entry. The entryTemplateId parameter must be set to use this parameter. The table API IDs should be the API Identifiers of the tables in the given template. - If a template table has one row, the values in that row act as default values for cloned entries. - If a template table has multiple rows, there is no default value and those rows are added to the cloned entry along with the provided csv data. - If a table has default values, they will be populated in any respective undefined columns in the csv data. - If a table has no default values, undefined columns from csv data will be empty. - If no csv data is provided for a table, the table in the entry will be populated with whatever values are in the respective template table. - `csvData` string: blobId of an uploaded csv blob. The CSV should be formatted with column headers of `columnId` which can be found in the `EntryTemplate`. For more information on uploading a blob, [click here](https://docs.benchling.com/docs/uploading-a-blob-to-benchling). - `templateTableID` string: Template table API ID - `name` string, required: Name of the entry - `schemaId` string: ID of the entry's schema ## Response `201` Created - Entry: Entries are notes that users can take. They're organized by "days" (which are user-configurable) and modeled within each day as a list of "notes." Each note has a type - the simplest is a "text" type, but lists, tables, and external files are also supported. *Note:* the current Entry resource has a few limitations: - Formatting information is not yet supported. Header formatting, bolding, and other stylistic information is not presented. - Data in tables is presented as text always - numeric values will need to be parsed into floats or integers, as appropriate. Note: Data in Results tables are not accessible through this API call. Results table data can be called through the Results API calls. - `apiURL` string, uri: The canonical url of the Entry in the API. - `archiveRecord` ArchiveRecord - `reason` string - `assignedReviewers` UserSummary[]: Array of users assigned to review the entry, if any. - `handle` string - `id` string - `name` string - `authors` UserSummary[]: Array of UserSummary Resources of the authors of the entry. This defaults to the creator but can be manually changed. - `handle` string - `id` string - `name` string - `createdAt` string, date-time: DateTime the entry was created at - `creator` UserSummary - `handle` string - `id` string - `name` string - `customFields` CustomFields - `days` EntryDay[]: Array of day objects. Each day object has a date field (string) and notes field (array of notes, expand further for details on note types). - `date` string: A Date string - `notes` EntryNotePart[] - union: Notes are the main building blocks of entries. Each note corresponds roughly to a paragraph. - object: app_canvas variant - `type` 'app_canvas', required: The type of the note. Type determines what other fields are present. - `indentation` integer: All notes have an indentation level - the default is 0 for no indent. For lists, indentation gives notes hierarchy - a bulleted list with children is modeled as one note part with indentation 1 followed by note parts with indentation 2, for example. - `appId` string: The API identifier for the Benchling App. - `canvasId` string: The API identifier for this Analysis Chart. - `featureId` string: The developer ID assigned to the feature of this App Canvas. - object: assay_run variant - `type` 'assay_run', required: The type of the note. Type determines what other fields are present. - `indentation` integer: All notes have an indentation level - the default is 0 for no indent. For lists, indentation gives notes hierarchy - a bulleted list with children is modeled as one note part with indentation 1 followed by note parts with indentation 2, for example. - `assayRunId` string, nullable - `assayRunSchemaId` string - object: box_creation_table variant - `type` 'box_creation_table', required: The type of the note. Type determines what other fields are present. - `indentation` integer: All notes have an indentation level - the default is 0 for no indent. For lists, indentation gives notes hierarchy - a bulleted list with children is modeled as one note part with indentation 1 followed by note parts with indentation 2, for example. - `apiId` string - `columns` StructuredTableColumnInfo[] - `columnId` string - `isReadOnly` boolean - `name` string - `name` string - `boxSchemaId` string - object: Simple note parts include the following types: - 'text': plain text - 'code': preformatted code block - 'list_bullet': one "line" of a bulleted list - 'list_number': one "line" of a numbered list - `type` 'text' | 'code' | 'list_bullet' | 'list_number', required: The type of the note. Type determines what other fields are present. - `indentation` integer: All notes have an indentation level - the default is 0 for no indent. For lists, indentation gives notes hierarchy - a bulleted list with children is modeled as one note part with indentation 1 followed by note parts with indentation 2, for example. - `links` EntryLink[]: Array of links referenced in text via an @-mention, hyperlink, or the drag-n-dropped preview attached to the note. - `id` string: For linked Benchling resources, this will be the ID of that resource (e.g., 'seq_RhYGVnHF'). Omitted for "link" types. - `type` 'link' | 'user' | 'request' | 'entry' | 'stage_entry' | 'protocol' | 'workflow' | 'custom_entity' | 'aa_sequence' | 'dna_sequence' | 'batch' | 'box' | 'container' | 'location' | 'plate' | 'insights_dashboard' | 'folder' | 'sql_dashboard': The type of resource being linked. For hyperlinks: 'link'. For linked Benchling resources, one of: 'user', 'request', 'entry', 'stage_entry', 'protocol', 'workflow', 'custom_entity', 'aa_sequence', 'dna_sequence', 'batch', 'box', 'container', 'location', 'plate', 'sql_dashboard'; and (for legacy support) 'insights_dashboard', 'folder'. - `webURL` string, nullable: Canonical URL of the linked Benchling resource (if you have at least READ authorization for that resource), or the explicit URL provided as hyperlink for "link" types. Note: locations do not currently have a URL. - `text` string: The textual contents of the note. - object: An attached user-uploaded file - `type` 'external_file', required: The type of the note. Type determines what other fields are present. - `indentation` integer: All notes have an indentation level - the default is 0 for no indent. For lists, indentation gives notes hierarchy - a bulleted list with children is modeled as one note part with indentation 1 followed by note parts with indentation 2, for example. - `externalFileId` string: The ID of the external file. Use the 'Get an external file' endpoint to retrieve metadata about it. - `links` EntryLink[]: Array of links referenced in the caption via an @-mention, hyperlink, or the drag-n-dropped preview attached to the note. - `id` string: For linked Benchling resources, this will be the ID of that resource (e.g., 'seq_RhYGVnHF'). Omitted for "link" types. - `type` 'link' | 'user' | 'request' | 'entry' | 'stage_entry' | 'protocol' | 'workflow' | 'custom_entity' | 'aa_sequence' | 'dna_sequence' | 'batch' | 'box' | 'container' | 'location' | 'plate' | 'insights_dashboard' | 'folder' | 'sql_dashboard': The type of resource being linked. For hyperlinks: 'link'. For linked Benchling resources, one of: 'user', 'request', 'entry', 'stage_entry', 'protocol', 'workflow', 'custom_entity', 'aa_sequence', 'dna_sequence', 'batch', 'box', 'container', 'location', 'plate', 'sql_dashboard'; and (for legacy support) 'insights_dashboard', 'folder'. - `webURL` string, nullable: Canonical URL of the linked Benchling resource (if you have at least READ authorization for that resource), or the explicit URL provided as hyperlink for "link" types. Note: locations do not currently have a URL. - `text` string: The caption of the file attachment. - object: inventory_container_table variant - `type` 'inventory_container_table', required: The type of the note. Type determines what other fields are present. - `indentation` integer: All notes have an indentation level - the default is 0 for no indent. For lists, indentation gives notes hierarchy - a bulleted list with children is modeled as one note part with indentation 1 followed by note parts with indentation 2, for example. - `apiId` string - `columns` StructuredTableColumnInfo[] - `columnId` string - `isReadOnly` boolean - `name` string - `name` string - `destinationContainerSchemaId` string - `mode` 'create_and_fill' | 'fill' | 'update' - object: inventory_plate_table variant - `type` 'inventory_plate_table', required: The type of the note. Type determines what other fields are present. - `indentation` integer: All notes have an indentation level - the default is 0 for no indent. For lists, indentation gives notes hierarchy - a bulleted list with children is modeled as one note part with indentation 1 followed by note parts with indentation 2, for example. - `apiId` string - `columns` StructuredTableColumnInfo[] - `columnId` string - `isReadOnly` boolean - `name` string - `name` string - `destinationPlateSchemaId` string, nullable - `destinationWellSchemaId` string - `mode` 'create_and_fill' | 'fill' | 'update' - object: Simple note parts include the following types: - 'text': plain text - 'code': preformatted code block - 'list_bullet': one "line" of a bulleted list - 'list_number': one "line" of a numbered list - `type` 'text' | 'code' | 'list_bullet' | 'list_number', required: The type of the note. Type determines what other fields are present. - `indentation` integer: All notes have an indentation level - the default is 0 for no indent. For lists, indentation gives notes hierarchy - a bulleted list with children is modeled as one note part with indentation 1 followed by note parts with indentation 2, for example. - `links` EntryLink[]: Array of links referenced in text via an @-mention, hyperlink, or the drag-n-dropped preview attached to the note. - `id` string: For linked Benchling resources, this will be the ID of that resource (e.g., 'seq_RhYGVnHF'). Omitted for "link" types. - `type` 'link' | 'user' | 'request' | 'entry' | 'stage_entry' | 'protocol' | 'workflow' | 'custom_entity' | 'aa_sequence' | 'dna_sequence' | 'batch' | 'box' | 'container' | 'location' | 'plate' | 'insights_dashboard' | 'folder' | 'sql_dashboard': The type of resource being linked. For hyperlinks: 'link'. For linked Benchling resources, one of: 'user', 'request', 'entry', 'stage_entry', 'protocol', 'workflow', 'custom_entity', 'aa_sequence', 'dna_sequence', 'batch', 'box', 'container', 'location', 'plate', 'sql_dashboard'; and (for legacy support) 'insights_dashboard', 'folder'. - `webURL` string, nullable: Canonical URL of the linked Benchling resource (if you have at least READ authorization for that resource), or the explicit URL provided as hyperlink for "link" types. Note: locations do not currently have a URL. - `text` string: The textual contents of the note. - object: One "line" of a checklist - `type` 'list_checkbox', required: The type of the note. Type determines what other fields are present. - `indentation` integer: All notes have an indentation level - the default is 0 for no indent. For lists, indentation gives notes hierarchy - a bulleted list with children is modeled as one note part with indentation 1 followed by note parts with indentation 2, for example. - `checked` boolean: Indicates whether the checkbox is checked or not. - `links` EntryLink[]: Array of links referenced in text via an @-mention, hyperlink, or the drag-n-dropped preview attached to the note. - `id` string: For linked Benchling resources, this will be the ID of that resource (e.g., 'seq_RhYGVnHF'). Omitted for "link" types. - `type` 'link' | 'user' | 'request' | 'entry' | 'stage_entry' | 'protocol' | 'workflow' | 'custom_entity' | 'aa_sequence' | 'dna_sequence' | 'batch' | 'box' | 'container' | 'location' | 'plate' | 'insights_dashboard' | 'folder' | 'sql_dashboard': The type of resource being linked. For hyperlinks: 'link'. For linked Benchling resources, one of: 'user', 'request', 'entry', 'stage_entry', 'protocol', 'workflow', 'custom_entity', 'aa_sequence', 'dna_sequence', 'batch', 'box', 'container', 'location', 'plate', 'sql_dashboard'; and (for legacy support) 'insights_dashboard', 'folder'. - `webURL` string, nullable: Canonical URL of the linked Benchling resource (if you have at least READ authorization for that resource), or the explicit URL provided as hyperlink for "link" types. Note: locations do not currently have a URL. - `text` string: The textual contents of the note. - object: Simple note parts include the following types: - 'text': plain text - 'code': preformatted code block - 'list_bullet': one "line" of a bulleted list - 'list_number': one "line" of a numbered list - `type` 'text' | 'code' | 'list_bullet' | 'list_number', required: The type of the note. Type determines what other fields are present. - `indentation` integer: All notes have an indentation level - the default is 0 for no indent. For lists, indentation gives notes hierarchy - a bulleted list with children is modeled as one note part with indentation 1 followed by note parts with indentation 2, for example. - `links` EntryLink[]: Array of links referenced in text via an @-mention, hyperlink, or the drag-n-dropped preview attached to the note. - `id` string: For linked Benchling resources, this will be the ID of that resource (e.g., 'seq_RhYGVnHF'). Omitted for "link" types. - `type` 'link' | 'user' | 'request' | 'entry' | 'stage_entry' | 'protocol' | 'workflow' | 'custom_entity' | 'aa_sequence' | 'dna_sequence' | 'batch' | 'box' | 'container' | 'location' | 'plate' | 'insights_dashboard' | 'folder' | 'sql_dashboard': The type of resource being linked. For hyperlinks: 'link'. For linked Benchling resources, one of: 'user', 'request', 'entry', 'stage_entry', 'protocol', 'workflow', 'custom_entity', 'aa_sequence', 'dna_sequence', 'batch', 'box', 'container', 'location', 'plate', 'sql_dashboard'; and (for legacy support) 'insights_dashboard', 'folder'. - `webURL` string, nullable: Canonical URL of the linked Benchling resource (if you have at least READ authorization for that resource), or the explicit URL provided as hyperlink for "link" types. Note: locations do not currently have a URL. - `text` string: The textual contents of the note. - object: lookup_table variant - `type` 'lookup_table', required - `apiId` string - `columns` StructuredTableColumnInfo[] - `columnId` string - `isReadOnly` boolean - `name` string - `name` string - object: mixture_prep_table variant - `type` 'mixture_prep_table', required: The type of the note. Type determines what other fields are present. - `indentation` integer: All notes have an indentation level - the default is 0 for no indent. For lists, indentation gives notes hierarchy - a bulleted list with children is modeled as one note part with indentation 1 followed by note parts with indentation 2, for example. - `apiId` string - `columns` StructuredTableColumnInfo[] - `columnId` string - `isReadOnly` boolean - `name` string - `name` string - `mixtureSchemaId` string - object: note_linked_chart variant - `type` 'note_linked_chart', required: The type of the note. Type determines what other fields are present. - `indentation` integer: All notes have an indentation level - the default is 0 for no indent. For lists, indentation gives notes hierarchy - a bulleted list with children is modeled as one note part with indentation 1 followed by note parts with indentation 2, for example. - `chart` ChartNotePartChart: The full configuration for the chart to be displayed in-line in this note part. - `id` string: The API identifier for this Analysis Chart. - object: plate_creation_table variant - `type` 'plate_creation_table', required: The type of the note. Type determines what other fields are present. - `indentation` integer: All notes have an indentation level - the default is 0 for no indent. For lists, indentation gives notes hierarchy - a bulleted list with children is modeled as one note part with indentation 1 followed by note parts with indentation 2, for example. - `apiId` string - `columns` StructuredTableColumnInfo[] - `columnId` string - `isReadOnly` boolean - `name` string - `name` string - `plateSchemaId` string - object: registration_table variant - `type` 'registration_table', required: The type of the note. Type determines what other fields are present. - `indentation` integer: All notes have an indentation level - the default is 0 for no indent. For lists, indentation gives notes hierarchy - a bulleted list with children is modeled as one note part with indentation 1 followed by note parts with indentation 2, for example. - `apiId` string - `columns` StructuredTableColumnInfo[] - `columnId` string - `isReadOnly` boolean - `name` string - `name` string - `entitySchemaId` string - object: results_table variant - `type` 'results_table', required: The type of the note. Type determines what other fields are present. - `indentation` integer: All notes have an indentation level - the default is 0 for no indent. For lists, indentation gives notes hierarchy - a bulleted list with children is modeled as one note part with indentation 1 followed by note parts with indentation 2, for example. - `apiId` string - `columns` StructuredTableColumnInfo[] - `columnId` string - `isReadOnly` boolean - `name` string - `name` string - `assayResultSchemaId` string - object: A table with rows and columns of text - `type` 'table', required: The type of the note. Type determines what other fields are present. - `indentation` integer: All notes have an indentation level - the default is 0 for no indent. For lists, indentation gives notes hierarchy - a bulleted list with children is modeled as one note part with indentation 1 followed by note parts with indentation 2, for example. - `links` EntryLink[]: Array of links referenced in the caption via an @-mention, hyperlink, or the drag-n-dropped preview attached to the note. - `id` string: For linked Benchling resources, this will be the ID of that resource (e.g., 'seq_RhYGVnHF'). Omitted for "link" types. - `type` 'link' | 'user' | 'request' | 'entry' | 'stage_entry' | 'protocol' | 'workflow' | 'custom_entity' | 'aa_sequence' | 'dna_sequence' | 'batch' | 'box' | 'container' | 'location' | 'plate' | 'insights_dashboard' | 'folder' | 'sql_dashboard': The type of resource being linked. For hyperlinks: 'link'. For linked Benchling resources, one of: 'user', 'request', 'entry', 'stage_entry', 'protocol', 'workflow', 'custom_entity', 'aa_sequence', 'dna_sequence', 'batch', 'box', 'container', 'location', 'plate', 'sql_dashboard'; and (for legacy support) 'insights_dashboard', 'folder'. - `webURL` string, nullable: Canonical URL of the linked Benchling resource (if you have at least READ authorization for that resource), or the explicit URL provided as hyperlink for "link" types. Note: locations do not currently have a URL. - `table` EntryTable: Actual tabular data with rows and columns of text on the note. - `columnLabels` string[]: Array of strings, with one item per column. Defaults to null, if the user is using the default, but is set if the user has given a custom name to the column. - `name` string: Name of the table - defaults to e.g. Table1 but can be renamed. - `rows` EntryTableRow[]: Array of row objects. - … - `text` string: The caption of the table. - object: Simple note parts include the following types: - 'text': plain text - 'code': preformatted code block - 'list_bullet': one "line" of a bulleted list - 'list_number': one "line" of a numbered list - `type` 'text' | 'code' | 'list_bullet' | 'list_number', required: The type of the note. Type determines what other fields are present. - `indentation` integer: All notes have an indentation level - the default is 0 for no indent. For lists, indentation gives notes hierarchy - a bulleted list with children is modeled as one note part with indentation 1 followed by note parts with indentation 2, for example. - `links` EntryLink[]: Array of links referenced in text via an @-mention, hyperlink, or the drag-n-dropped preview attached to the note. - `id` string: For linked Benchling resources, this will be the ID of that resource (e.g., 'seq_RhYGVnHF'). Omitted for "link" types. - `type` 'link' | 'user' | 'request' | 'entry' | 'stage_entry' | 'protocol' | 'workflow' | 'custom_entity' | 'aa_sequence' | 'dna_sequence' | 'batch' | 'box' | 'container' | 'location' | 'plate' | 'insights_dashboard' | 'folder' | 'sql_dashboard': The type of resource being linked. For hyperlinks: 'link'. For linked Benchling resources, one of: 'user', 'request', 'entry', 'stage_entry', 'protocol', 'workflow', 'custom_entity', 'aa_sequence', 'dna_sequence', 'batch', 'box', 'container', 'location', 'plate', 'sql_dashboard'; and (for legacy support) 'insights_dashboard', 'folder'. - `webURL` string, nullable: Canonical URL of the linked Benchling resource (if you have at least READ authorization for that resource), or the explicit URL provided as hyperlink for "link" types. Note: locations do not currently have a URL. - `text` string: The textual contents of the note. - object: text_box variant - `type` 'text_box', required: The type of the note. Type determines what other fields are present. - `indentation` integer: All notes have an indentation level - the default is 0 for no indent. For lists, indentation gives notes hierarchy - a bulleted list with children is modeled as one note part with indentation 1 followed by note parts with indentation 2, for example. - `links` EntryLink[]: Array of links referenced via an @-mention, hyperlink, or the drag-n-dropped preview attached to the note. - `id` string: For linked Benchling resources, this will be the ID of that resource (e.g., 'seq_RhYGVnHF'). Omitted for "link" types. - `type` 'link' | 'user' | 'request' | 'entry' | 'stage_entry' | 'protocol' | 'workflow' | 'custom_entity' | 'aa_sequence' | 'dna_sequence' | 'batch' | 'box' | 'container' | 'location' | 'plate' | 'insights_dashboard' | 'folder' | 'sql_dashboard': The type of resource being linked. For hyperlinks: 'link'. For linked Benchling resources, one of: 'user', 'request', 'entry', 'stage_entry', 'protocol', 'workflow', 'custom_entity', 'aa_sequence', 'dna_sequence', 'batch', 'box', 'container', 'location', 'plate', 'sql_dashboard'; and (for legacy support) 'insights_dashboard', 'folder'. - `webURL` string, nullable: Canonical URL of the linked Benchling resource (if you have at least READ authorization for that resource), or the explicit URL provided as hyperlink for "link" types. Note: locations do not currently have a URL. - `name` string - `text` string - `title` string, nullable: Optional title of a section if sections are enabled. - `displayId` string: User-friendly ID of the entry - `entryTemplateId` string, nullable: ID of the Entry Template this Entry was created from - `fields` Fields - `folderId` string: ID of the folder that contains the entry - `id` string: ID of the entry - `modifiedAt` string: DateTime the entry was last modified - `name` string: Title of the entry - `reviewRecord` EntryReviewRecord: Review record if set - `comment` string: Reviewer's Comments - `reviewChanges` ReviewChange[]: A list of the Review Changes that have been made to this entry - `action` 'SEND_FOR_REVIEW' | 'ACCEPT' | 'REJECT' | 'COMMENT' | 'RETRACT': The action which was performed with this change - `comment` string, nullable: The comment which was left when the Review Change was submitted - `createdAt` string, date-time: DateTime the Review Change was created at - `esigned` boolean: Was the action verified through an e-signature compliant step - `id` string - `reviewSnapshot` ReviewSnapshot - `createdAt` string, date-time: DateTime the Review Snapshot was created at - `downloadURL` string: A short-lived URL that can be used to download the original file. - `expiresAt` string, date-time: DateTime the downloadURL expires. - `size` integer: Size, in bytes, of the snapshot file - `status` 'PENDING' | 'RUNNING' | 'SUCCEEDED' | 'FAILED': the current status of the Snapshot process - `reviewProcesses` EntryReviewProcess[], nullable: Review Processes associated with the Entry - `completionStatus` 'APPROVED' | 'COMPLETED' | 'ACCEPTED' | 'REVIEWED' | 'WITNESSED' | 'SELF_REVIEWED': State of the Entry at the end of the Review Process - `id` string: ID of the Review Process - `name` string: Name of the Review Process - `stages` EntryReviewProcessStagesItems[]: Array of Stages for the Review Process - `actionLabel` 'APPROVE' | 'COMPLETE' | 'ACCEPT' | 'REVIEW' | 'WITNESS' | 'SELF_REVIEW': Action reviewer is doing during the review - `id` string: ID of the Review Stage - `name` string: Name of the Review Stage - `reviewers` EntryReviewProcessStagesItemsReviewersItems[]: Reviewers for the Review Stage - `handle` string - `id` string - `name` string - `status` 'BLOCKED' | 'PENDING' | 'FINISHED' | 'REJECTED': Status of the Reviewer - `type` 'SELF_REVIEW' | 'SEQUENTIAL' | 'PARALLEL': Type of the Review Process - `status` 'ACCEPTED' | 'NEEDS_REVIEW' | 'REJECTED' | 'RETRACTED' | 'ACCEPTANCE_SNAPSHOT_IN_PROGRESS' | 'REVIEW_SNAPSHOT_IN_PROGRESS' | 'IN_PROGRESS' | 'ACTION_REQUIRED': Review Status of the entry - `schema` EntrySchema: Entry schema - `id` string: ID of the entry schema - `modifiedAt` string, date-time: DateTime the Entry Schema was last modified - `name` string: Name of the entry schema - `webURL` string: URL of the entry ## Other responses - `400`: Bad Request --- [API](https://skmtc.dev/benchling/apis/benchling-api-2.md) - [All operations](https://skmtc.dev/benchling/apis/benchling-api-2/llms.txt) - [OpenAPI document](https://skmtc.dev/benchling/apis/benchling-api-2/revisions/01d2fa8523cd?raw)