# Scispot API

> Official documentation for the Scispot API — Labsheets, ELN, manifests, sequences, and webhooks.

## Docs

- [Introduction](https://docs.scispot.com/index.md): Welcome to Scispot API Documentation
- [Quickstart](https://docs.scispot.com/quickstart.md): Begin with a guide on the fastest path to a successful outcome
- [Authentication](https://docs.scispot.com/authentication.md): Use personal tokens with the Authorization Bearer header on every request.
- [Scispot MCP Server](https://docs.scispot.com/mcp-server.md): Connect an AI assistant to your Scispot workspace with the Scispot MCP Server.
- [API overview](https://docs.scispot.com/api-reference/overview.md): How the Scispot REST API is organized and where to find each product area.
- [Create Folder](https://docs.scispot.com/api-reference/scispot-api--labsheets-lims-api/create-folder.md): Create a Labsheet Folder
- [List Labsheet Folders](https://docs.scispot.com/api-reference/scispot-api--labsheets-lims-api/list-labsheet-folders.md): Retrieve list of labsheet folders
- [List Labsheets In Folder](https://docs.scispot.com/api-reference/scispot-api--labsheets-lims-api/list-labsheets-in-folder.md): Retrieve list of labsheet folders
- [Move Labsheet To Folder](https://docs.scispot.com/api-reference/scispot-api--labsheets-lims-api/move-labsheet-to-folder.md): Move Labsheet to designated folder.
- [Create Labsheet](https://docs.scispot.com/api-reference/scispot-api--labsheets-lims-api/create-labsheet.md): NOTE:
- [Fetch List of Labsheets](https://docs.scispot.com/api-reference/scispot-api--labsheets-lims-api/fetch-list-of-labsheets.md): Retrieve list of labsheets
- [Get Labsheet Schema](https://docs.scispot.com/api-reference/scispot-api--labsheets-lims-api/get-labsheet-schema.md): Get a labsheet's structure, including all of its column names, types, and positions
- [Get Labsheet Template Schema](https://docs.scispot.com/api-reference/scispot-api--labsheets-lims-api/get-labsheet-template-schema.md): Retrieve Schema of Labsheet Template
- [Convert Labsheet to Template](https://docs.scispot.com/api-reference/scispot-api--labsheets-lims-api/convert-labsheet-to-template.md): Convert a Labsheet into a Labsheet Template
- [Create Column](https://docs.scispot.com/api-reference/scispot-api--labsheets-lims-api/create-column.md): Add a column to a labsheet.
- [Rename Column](https://docs.scispot.com/api-reference/scispot-api--labsheets-lims-api/rename-column.md): Rename a column in a labsheet.
- [Delete Column](https://docs.scispot.com/api-reference/scispot-api--labsheets-lims-api/delete-column.md): Delete a column from a labsheet.
- [Add Rows](https://docs.scispot.com/api-reference/scispot-api--labsheets-lims-api/add-rows.md): Add rows to a Labsheet. Ensure row values correspond to the column labels in the labsheet and are defined for each column. leave an empty string for a column if you do not want to add a value for that column.
- [Fetch List of Labsheet Rows](https://docs.scispot.com/api-reference/scispot-api--labsheets-lims-api/fetch-list-of-labsheet-rows.md): Pagination constraints: pageSize must be at most 1000, and page multiplied by pageSize must be less than 50000. Violations return HTTP 400 with a plain string message.
- [Fetch List of Labsheet Rows(with Filter)](https://docs.scispot.com/api-reference/scispot-api--labsheets-lims-api/fetch-list-of-labsheet-rowswith-filter.md): Retrieve Labsheet rows with optional and mandatory filters. The request body accepts a query object with optionalFilters and mandatoryFilters arrays. Optional filters are combined with OR logic. Mandatory filters are combined with AND logic. Each filter can include column, value, and operator fields…
- [Get Row Data](https://docs.scispot.com/api-reference/scispot-api--labsheets-lims-api/get-row-data.md): This endpoint returns data stored in a single row given the row's uuid and the name of its labsheet. Row uuids can be found using the Get Labsheet Rows endpoint.
- [Get Row Data By ID Column](https://docs.scispot.com/api-reference/scispot-api--labsheets-lims-api/get-row-data-by-id-column.md): Uses a value of cell in an **ID** or **ID_BARCODE** type column to retrieve the row. By default value in **"id"** key maps to the value for **ID** type column. To find rows by **ID_BARCODE** type (automated IDs) column instead, **"idType"** key has to be set to **"ID_BARCODE"** in the payload.
- [Update Rows](https://docs.scispot.com/api-reference/scispot-api--labsheets-lims-api/update-rows.md)
- [Update Row Data By ID Column](https://docs.scispot.com/api-reference/scispot-api--labsheets-lims-api/update-row-data-by-id-column.md): Update individual row values by matching indexes with an "ID" or "ID_BARCODE" column in a labsheet. A column with type "ID" or "ID_BARCODE" must be included in the labsheet to use this endpoint.
- [Delete Single Row](https://docs.scispot.com/api-reference/scispot-api--labsheets-lims-api/delete-single-row.md): Remove rows from a labsheet given the row uuids and labsheet name. Row uuids are unique identifiers for each row in your labsheet and can be found using the Get Labsheet Rows endpoint.
- [Delete Rows](https://docs.scispot.com/api-reference/scispot-api--labsheets-lims-api/delete-rows.md): Remove rows from a labsheet given the row uuids and labsheet name. Row uuids are unique identifiers for each row in your labsheet and can be found using the Get Labsheet Rows endpoint.
- [Create Children Samples](https://docs.scispot.com/api-reference/scispot-api--labsheets-lims-api/create-children-samples.md): Create children samples from existing samples in labsheets.
- [Assign Location](https://docs.scispot.com/api-reference/scispot-api--labsheets-lims-api/assign-location.md): Assigns a physical location to one or more labsheet entries (rows). This API endpoint supports assigning to locations as well as manifests. When assigning samples to manifest locations, it is possible to use the optional position field to assign the well position the samples are to be assigned.
- [Link External Barcode](https://docs.scispot.com/api-reference/scispot-api--labsheets-lims-api/link-external-barcode.md): This endpoint allows the user to link external barcodes to labsheets that have the external barcode column type. This endpoint also allows the user to link barcodes to labsheet entries that already has an external barcode. This usage will allow multiple external barcodes to refer to the same entry,…
- [Add Sequence to Labsheet Row (DEPRECEATED)](https://docs.scispot.com/api-reference/scispot-api--labsheets-lims-api/add-sequence-to-labsheet-row-depreceated.md): ### Add Sequence to Row
- [Create Protocol](https://docs.scispot.com/api-reference/scispot-api--eln-api--create/create-protocol.md): Create protocol inside a labspace, folder or a subfolder
- [Create Experiment](https://docs.scispot.com/api-reference/scispot-api--eln-api--create/create-experiment.md): Create an experiment page inside a labspace, folder or subfolder
- [Create Documentation](https://docs.scispot.com/api-reference/scispot-api--eln-api--create/create-documentation.md): Create a documentation page inside a labspace, folder or subfolder
- [Create Labspace](https://docs.scispot.com/api-reference/scispot-api--eln-api--create/create-labspace.md): Create a labspace
- [Create Folder](https://docs.scispot.com/api-reference/scispot-api--eln-api--create/create-folder.md): Create a folder/subfolder inside a labspace, folder or a subfolder
- [Write To A Protocol](https://docs.scispot.com/api-reference/scispot-api--eln-api--update/write-to-a-protocol.md): This endpoint allows users to append the `contentType`, using `contentToAppend`, replace using `contentToReplace`, and add to the head using `contentToHead`to the protocol.
- [Write To An Experiment](https://docs.scispot.com/api-reference/scispot-api--eln-api--update/write-to-an-experiment.md): This endpoint allows users to append the `contentType`, using `contentToAppend`, replace using `contentToReplace`, and add to the head using `contentToHead`to the protocol.
- [Write To A Documentation](https://docs.scispot.com/api-reference/scispot-api--eln-api--update/write-to-a-documentation.md): This endpoint allows users to append the `contentType`, using `contentToAppend`, replace using `contentToReplace`, and add to the head using `contentToHead`to the protocol.
- [Add A Labsheet To A Protocol](https://docs.scispot.com/api-reference/scispot-api--eln-api--update/add-a-labsheet-to-a-protocol.md)
- [Add A Labsheet To An Experiment](https://docs.scispot.com/api-reference/scispot-api--eln-api--update/add-a-labsheet-to-an-experiment.md)
- [Add A Labsheet To A Documentation](https://docs.scispot.com/api-reference/scispot-api--eln-api--update/add-a-labsheet-to-a-documentation.md)
- [Update Protocol Steps](https://docs.scispot.com/api-reference/scispot-api--eln-api--update/update-protocol-steps.md)
- [Attach Image to Protocol](https://docs.scispot.com/api-reference/scispot-api--eln-api--update/attach-image-to-protocol.md): Embeds an image — already uploaded to the labspace S3 bucket — into a Protocol, Experiment, or Documentation page by generating an XML tag and applying it at the chosen position.
- [Attach Image to Experiment](https://docs.scispot.com/api-reference/scispot-api--eln-api--update/attach-image-to-experiment.md): Embeds an image — already uploaded to the labspace S3 bucket — into a Protocol, Experiment, or Documentation page by generating an XML tag and applying it at the chosen position.
- [Attach Image to Documentation](https://docs.scispot.com/api-reference/scispot-api--eln-api--update/attach-image-to-documentation.md): Embeds an image — already uploaded to the labspace S3 bucket — into a Protocol, Experiment, or Documentation page by generating an XML tag and applying it at the chosen position.
- [Find A Labspace](https://docs.scispot.com/api-reference/scispot-api--eln-api--find/find-a-labspace.md): Get metadata about a labspace
- [Find A Folder](https://docs.scispot.com/api-reference/scispot-api--eln-api--find/find-a-folder.md): Retrieve information about a specific folder
- [Find A Protocol](https://docs.scispot.com/api-reference/scispot-api--eln-api--find/find-a-protocol.md): Retrieve information about a specific protocol
- [Find An Experiment](https://docs.scispot.com/api-reference/scispot-api--eln-api--find/find-an-experiment.md): Retrieve information about a specific experiment
- [Find A Documentation](https://docs.scispot.com/api-reference/scispot-api--eln-api--find/find-a-documentation.md): Retrieve information about a specific documentation page
- [List Labspaces](https://docs.scispot.com/api-reference/scispot-api--eln-api--list/list-labspaces.md): This endpoint retrieves a list of labspaces
- [List Folders](https://docs.scispot.com/api-reference/scispot-api--eln-api--list/list-folders.md): Get a list of folders inside a labspace.
- [List Protocols](https://docs.scispot.com/api-reference/scispot-api--eln-api--list/list-protocols.md): Get a list of protocols inside a location(path of your labspace,folder or subfolder) based on the provided query parameters.
- [List Experiments](https://docs.scispot.com/api-reference/scispot-api--eln-api--list/list-experiments.md): Get a list of experiments pages inside a location path(labspace,folder or subfolder separated by colon(:)) based on the provided query parameters.
- [List Documentations](https://docs.scispot.com/api-reference/scispot-api--eln-api--list/list-documentations.md): Get a list of documentation pages inside a location path(labspace,folder or subfolder separated by colon(:)) based on the provided query parameters.
- [List Protocol Templates](https://docs.scispot.com/api-reference/scispot-api--eln-api--list/list-protocol-templates.md): This request is to fetch a list of protocol templates.
- [List Experiments Templates](https://docs.scispot.com/api-reference/scispot-api--eln-api--list/list-experiments-templates.md): This request is to fetch a list of experiment templates.
- [Delete Protocol](https://docs.scispot.com/api-reference/scispot-api--eln-api--delete/delete-protocol.md)
- [Delete Experiment](https://docs.scispot.com/api-reference/scispot-api--eln-api--delete/delete-experiment.md)
- [Delete Documentation](https://docs.scispot.com/api-reference/scispot-api--eln-api--delete/delete-documentation.md)
- [List Permissions](https://docs.scispot.com/api-reference/scispot-api--eln-api--permissions-super-admin-only/list-permissions.md): This endpoint allows you to list permissions to a private folder in the labspace.
- [Add Permissions](https://docs.scispot.com/api-reference/scispot-api--eln-api--permissions-super-admin-only/add-permissions.md): This endpoint allows you to add permissions to a private folder in the labspace.
- [Lock Folder](https://docs.scispot.com/api-reference/scispot-api--eln-api--permissions-super-admin-only/lock-folder.md): This endpoint allows you to add permissions to a private folder in the labspace.
- [Unlock Folder](https://docs.scispot.com/api-reference/scispot-api--eln-api--permissions-super-admin-only/unlock-folder.md): This endpoint allows you to add permissions to a private folder in the labspace.
- [Remove Permissions](https://docs.scispot.com/api-reference/scispot-api--eln-api--permissions-super-admin-only/remove-permissions.md): This endpoint allows you to add permissions to a private folder in the labspace.
- [Create A Manifest](https://docs.scispot.com/api-reference/scispot-api--manifests-plates-boxes-racks-api/create-a-manifest.md)
- [Find Manifest By Human Readable ID](https://docs.scispot.com/api-reference/scispot-api--manifests-plates-boxes-racks-api/find-manifest-by-human-readable-id.md): Retrieve information about a specific manifest
- [Get Manifest Metadata](https://docs.scispot.com/api-reference/scispot-api--manifests-plates-boxes-racks-api/get-manifest-metadata.md): Fetch metadata about a manifest through either the UUID, HRID, or the Barcode.
- [Update A Manifest](https://docs.scispot.com/api-reference/scispot-api--manifests-plates-boxes-racks-api/update-a-manifest.md): This endpoint allows users to update an existing manifest, these can include sample assignments, labeling modifications, and tag management across multiple well positions within a single manifest.
- [Assign A Manifest To A Location](https://docs.scispot.com/api-reference/scispot-api--manifests-plates-boxes-racks-api/assign-a-manifest-to-a-location.md): Moves an **assay plate (manifest)** into a storage location given a **location id.** If the storage location is a rack, you may also specify the desired position of assignment within that rack.
- [Create a Sequence](https://docs.scispot.com/api-reference/scispot-api--sequence-api/create-a-sequence.md): This API endpoint can be used to create a sequence of any type the scispot supports:
- [Fetch List of Sequences by Pagination](https://docs.scispot.com/api-reference/scispot-api--sequence-api/fetch-list-of-sequences-by-pagination.md): This endpoint allows the user to fetch a list of sequences through pagination
- [Create Sequences in Bulk](https://docs.scispot.com/api-reference/scispot-api--sequence-api/create-sequences-in-bulk.md): Create sequences of any type in bulk. This endpoint supports all the sequence types as the /sequences endpoint with similar syntax inside the sequence array.
- [Add annotations to a Sequence](https://docs.scispot.com/api-reference/scispot-api--sequence-api/add-annotations-to-a-sequence.md): This endpoint allows the user to add annotations to an existing sequence
- [Delete Annotations](https://docs.scispot.com/api-reference/scispot-api--sequence-api/delete-annotations.md): This endpoint allows the user to delete specific annotations from existing sequences
- [Fetch Sequence By UUID](https://docs.scispot.com/api-reference/scispot-api--sequence-api/fetch-sequence-by-uuid.md): This endpoint allows the user to fetch a sequence by its UUID
- [Update Sequence](https://docs.scispot.com/api-reference/scispot-api--sequence-api/update-sequence.md): This endpoint updates the sequences that denoted by the uuid from the url. The payload must contain a name, type and sequence even if it is the same as before the update.
- [Delete Sequence](https://docs.scispot.com/api-reference/scispot-api--sequence-api/delete-sequence.md): Deletes the sequences related to the uuid from the url.
- [Add Sequence to Labsheet Row](https://docs.scispot.com/api-reference/scispot-api--sequence-api/add-sequence-to-labsheet-row.md): This endpoint will link a sequence to a labsheet row in the sequence column based on the sequence uuid in the url.
- [Add sequence to Labspace Page](https://docs.scispot.com/api-reference/scispot-api--sequence-api/add-sequence-to-labspace-page.md): Add the sequence from the url to the labspace page from the payload
- [Create a DNA Sequence (Deprecated)](https://docs.scispot.com/api-reference/scispot-api--sequence-api/create-a-dna-sequence-deprecated.md)
- [Update Existing DNA Sequence (Deprecated)](https://docs.scispot.com/api-reference/scispot-api--sequence-api/update-existing-dna-sequence-deprecated.md)
- [Find a DNA Sequence (Deprecated)](https://docs.scispot.com/api-reference/scispot-api--sequence-api/find-a-dna-sequence-deprecated.md)
- [List DNA Sequences (Deprecated)](https://docs.scispot.com/api-reference/scispot-api--sequence-api/list-dna-sequences-deprecated.md)
- [Download File](https://docs.scispot.com/api-reference/scispot-api--files-api/download-file.md): This endpoint allows the user to download a file from Scispot
- [Store Files](https://docs.scispot.com/api-reference/scispot-api--files-api/store-files.md): Legacy file repository upload endpoint implemented in scispot-legacy-backend FileController#uploadFilesOrMedia. Requires Authorization: Bearer token. Returns an array of per-file results. `mediaUrls` is accepted by the controller but not processed. Authenticated requests with no files can return HTT…
- [Upload Files And Queue Embedding](https://docs.scispot.com/api-reference/scispot-api--files-api/upload-files-and-queue-embedding.md): Legacy file upload + embedding queue endpoint implemented in scispot-legacy-backend FileController#uploadFilesAndEmbed. Requires Authorization: Bearer token. Uploads files to S3 and queues supported file types for knowledge-base embedding. `isGlobal` is interpreted as a string boolean and `fileSourc…
- [Fetch Root Locations](https://docs.scispot.com/api-reference/scispot-api--locations-api/fetch-root-locations.md): Retrieve list of all root locations.
- [Fetch Sub Locations by Location Id](https://docs.scispot.com/api-reference/scispot-api--locations-api/fetch-sub-locations-by-location-id.md): Given a **parent location UUID**, lists everything directly inside—child locations, storage racks, manifests (plates), and sample inventory rows.
- [Create Locations in Bulk](https://docs.scispot.com/api-reference/scispot-api--locations-api/create-locations-in-bulk.md): This API endpoint is used to create single locations or locations in bulk. This is an async process, so the return message will only return the request ID for the async ticket. In order to check the creation status of this endpoint, use the /location/create/status endpoint with the request ID as the…
- [Get Create Location Status](https://docs.scispot.com/api-reference/scispot-api--locations-api/get-create-location-status.md): This endpoint is used in conjunction with the location/create endpoint that creates locations in an async manner. This endpoint is used to check the status of the async request created by the location/create endpoint.
- [List all Samples in a Labflow](https://docs.scispot.com/api-reference/scispot-api--labflows-api/list-all-samples-in-a-labflow.md)
- [Add New Test in Labflow](https://docs.scispot.com/api-reference/scispot-api--labflows-api/add-new-test-in-labflow.md)
- [Link Samples to Test in Labflow](https://docs.scispot.com/api-reference/scispot-api--labflows-api/link-samples-to-test-in-labflow.md)
- [Push Webhook to Scispot](https://docs.scispot.com/api-reference/scispot-api--webhook-api/push-webhook-to-scispot.md): Push a JSON payload to Scispot. Depending on the "Scispot-Event-Type", automatic actions can be performed in Scispot.

## OpenAPI Specs

- [api-docs](https://docs.scispot.com/api-docs.yaml)