Scispot Scispot API - MANIFESTS (PLATES, BOXES, RACKS) API
#### Overview The following API calls are for the manipulation of manifest data. #### Terminology - **Manifest** - A visual representation of a well plate.
#### Overview The following API calls are for the manipulation of manifest data. #### Terminology - **Manifest** - A visual representation of a well plate.
Every API here is available over the APIs.io API and to AI agents over MCP.
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
find_apisBrowse and filter every API in the catalog.get_api_artifactsOne API's artifacts, grouped by type.get_openapiThe primary OpenAPI for this API.find_similar_apisAPIs that look like this one.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.curl "https://apis.io/api/v1/apis/scispot:scispot-scispot-api-manifests-plates-boxes-racks-api-api"
curl "https://apis.io/api/v1/apis?limit=25"
Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.
openapi: 3.2.0
info:
title: Scispot's API Documentation Scispot API - MANIFESTS…
description: '### Welcome! Feel Free To Visit Scispot.com
#### Overview
This is a documentation listing API calls for the following Scispot applications:
1. Labsheets (LIMS)
2. ELN
3. Manifests (plates, boxes, racks, etc.)
4. Sequences
## Getting Started
### Create a new API Key in account settings
- Go to Scispot
- Click on the "Account" button in the navigation bar on the bottom left corner of your screen
- Click "Personal Tokens" on the left side of the pop-up modal
- Click "Generate New Token"
- Name your token, select token access, and click "Generate"
- Copy the API Key and save it somewhere safe - this token cannot be retrieved once it is generated
- This token will be used as "apiKey" in all API requests'
version: 1.0.0
servers:
- url: https://cloudlab.scispot.io
description: Scispot Cloud Lab
security:
- bearerAuth: []
tags:
- name: Scispot API - MANIFESTS (PLATES, BOXES, RACKS) API
description: '#### Overview
The following API calls are for the manipulation of manifest data.
#### Terminology
- **Manifest** - A visual representation of a well plate.'
paths:
/manifest/create:
post:
tags:
- Scispot API - MANIFESTS (PLATES, BOXES, RACKS) API
summary: Create A Manifest
description: 'Create a new manifest (plate, box, rack, etc.) from an existing manifest template.
Provide the manifest `name`, the `template` name to base it on, and the `plates` to populate,
where each plate can reference source labsheets and assign samples to specific wells.
By default a human-readable ID is generated automatically (`autoHrid`); set `autoHrid` to
false and supply your own `hrid` to control it.'
requestBody:
content:
application/json:
schema:
type: object
properties:
name:
type: string
description: The name of the manifest to create.
template:
type: string
description: The name of the existing manifest template to base this manifest on (e.g. a 96-well plate template). This defines the layout and number of wells.
plates:
type: array
description: The plates to create within the manifest. Each plate can reference source labsheets and assign their samples to wells.
items:
type: object
properties:
labsheets:
type: array
description: The source labsheets whose samples are placed into this plate.
items:
type: object
properties:
labsheet:
type: string
description: The name of the source labsheet to pull samples from.
idType:
type: string
description: 'The identifier used to reference samples in the source labsheet. Defaults to ID. One of: ID, ID_BARCODE, UUID, ROW_UUID.'
enum:
- ID
- ID_BARCODE
- UUID
- ROW_UUID
items:
type: array
description: The samples to place on the plate. Each item is either an object with `name` (the sample id) and `well` (the target well, e.g. A1), or a plain sample-id string that is assigned to a random empty well.
items:
type: object
additionalProperties: true
additionalProperties: true
additionalProperties: true
autoHrid:
type: boolean
description: (Optional) Whether to auto-generate the manifest's human-readable ID. Defaults to true. Set to false to supply your own `hrid`.
hrid:
type: string
description: (Optional) The human-readable ID to assign to the manifest. Required when `autoHrid` is false.
required:
- name
- template
- plates
additionalProperties: true
example:
name: Sample Plate
template: 96 Well Plate
plates:
- labsheets:
- labsheet: Sample Manager
idType: ID
items:
- name: SMPL000001
well: A1
- name: SMPL000002
well: A2
autoHrid: true
required: true
responses:
'200':
description: OK
headers:
Content-Type:
schema:
type: string
example: application/json
content:
application/json:
schema:
type: object
properties:
uuid:
type: string
success:
type: boolean
additionalProperties: true
example:
uuid: <uuid>
success: true
'401':
description: Invalid Authentication Token
content:
application/json:
schema:
type: object
properties:
success:
type: boolean
example: false
message:
type: string
additionalProperties: true
example:
success: false
message: Invalid Authentication Token
'403':
description: Missing Authentication Token
content:
application/json:
schema:
type: object
properties:
success:
type: boolean
example: false
message:
type: string
additionalProperties: true
example:
success: false
message: Missing Authentication Token
'422':
description: Validation error
content:
application/json:
schema:
type: object
properties:
success:
type: boolean
example: false
message:
type: string
additionalProperties: true
example:
success: false
message: Validation error
'500':
description: Operation failed
content:
application/json:
schema:
type: object
properties:
success:
type: boolean
example: false
message:
type: string
additionalProperties: true
example:
success: false
message: Operation failed
'409':
description: Conflict
content:
application/json:
schema:
type: object
properties:
success:
type: boolean
example: false
message:
type: string
additionalProperties: true
example:
success: false
message: Conflict
parameters: []
operationId: postManifestCreate
x-operation-id-source: derived
/manifest/fetch:
get:
tags:
- Scispot API - MANIFESTS (PLATES, BOXES, RACKS) API
summary: Find Manifest By Human Readable ID
description: 'Retrieve information about a specific manifest
Validation notes: provide at least one of hrid, uuid, barcode.
Lookup accepts one of hrid, uuid, or barcode. Missing/not-found identifiers surface as service errors in API-v2.'
parameters:
- name: hrid
in: query
schema:
type: string
example: PLT000001
description: Human Readable Id of the manifest
- name: uuid
in: query
schema:
type: string
example: <uuid>
description: uuid of the manfiest (optional parameter)
- name: barcode
in: query
schema:
type: string
example: PLT000001
description: barcode of the manfiest (optional parameter)
responses:
'200':
headers:
Content-Type:
schema:
type: string
example: application/json
content:
application/json:
schema:
type: object
properties:
name:
type: string
template:
type: string
plates:
type: array
items:
type: object
additionalProperties: true
data:
type: object
properties:
headers:
type: array
items:
type: string
rows:
type: array
items:
type: array
items:
type: string
additionalProperties: true
success:
type: boolean
additionalProperties: true
example:
name: Sample Plate
template: 96 Well Plate
plates:
- labsheets:
- labsheet: Sample Manager
data:
headers:
- Well
- Sample ID
- Labsheet
rows:
- - A1
- SMPL000001
- Sample Manager
- - A2
- SMPL000002
- Sample Manager
success: true
description: OK
'401':
description: Invalid Authentication Token
content:
application/json:
schema:
type: object
properties:
success:
type: boolean
example: false
message:
type: string
additionalProperties: true
example:
success: false
message: Invalid Authentication Token
'403':
description: Missing Authentication Token
content:
application/json:
schema:
type: object
properties:
success:
type: boolean
example: false
message:
type: string
additionalProperties: true
example:
success: false
message: Missing Authentication Token
'422':
description: Validation error
content:
application/json:
schema:
type: object
properties:
success:
type: boolean
example: false
message:
type: string
example: Validation error
example:
success: false
message: Validation error
'500':
description: Operation failed
content:
application/json:
schema:
type: object
properties:
success:
type: boolean
example: false
message:
type: string
additionalProperties: true
example:
success: false
message: Operation failed
operationId: getManifestFetch
x-operation-id-source: derived
/manifest/fetch-metadata:
get:
tags:
- Scispot API - MANIFESTS (PLATES, BOXES, RACKS) API
summary: Get Manifest Metadata
description: 'Fetch metadata about a manifest through either the UUID, HRID, or the Barcode.
Validation notes: provide at least one of hrid, uuid, barcode.
Lookup accepts one of hrid, uuid, or barcode. Missing/not-found identifiers surface as service errors in API-v2.'
parameters:
- name: uuid
in: query
schema:
type: string
description: UUID of the manifest, or
example: <uuid>
- name: hrid
in: query
schema:
type: string
description: HRID of the manifest, or
example: PLT000001
- name: barcode
in: query
schema:
type: string
description: Barcode value of the manifest
example: PLT000001
responses:
'200':
description: OK
headers:
Content-Type:
schema:
type: string
example: application/json
content:
application/json:
schema:
type: object
properties:
name:
type: string
template:
type: string
uuid:
type: string
hrid:
type: string
barcode:
type: string
emptySpaces:
type: string
lastUpdate:
type: string
success:
type: boolean
additionalProperties: true
example:
name: Sample Plate
template: 96 Well Plate
uuid: <uuid>
hrid: PLT000001
barcode: PLT000001
emptySpaces: '94'
lastUpdate: '2026-01-01T00:00:00.000Z'
success: true
'401':
description: Invalid Authentication Token
content:
application/json:
schema:
type: object
properties:
success:
type: boolean
example: false
message:
type: string
additionalProperties: true
example:
success: false
message: Invalid Authentication Token
'403':
description: Missing Authentication Token
content:
application/json:
schema:
type: object
properties:
success:
type: boolean
example: false
message:
type: string
additionalProperties: true
example:
success: false
message: Missing Authentication Token
'422':
description: Validation error
content:
application/json:
schema:
type: object
properties:
success:
type: boolean
example: false
message:
type: string
example: Validation error
example:
success: false
message: Validation error
'500':
description: Operation failed
content:
application/json:
schema:
type: object
properties:
success:
type: boolean
example: false
message:
type: string
additionalProperties: true
example:
success: false
message: Operation failed
operationId: getManifestFetchMetadata
x-operation-id-source: derived
/manifest/update:
post:
tags:
- Scispot API - MANIFESTS (PLATES, BOXES, RACKS) API
summary: Update A Manifest
description: 'This endpoint allows users to update an existing manifests.
### Update Operations
**Assign Operations** must be included in the `wells` array within the plate object. This operation adds or updates sample assignments (labsheet rows), labels, and tags to specific well positions.
**Remove Operations** must be included in the `removeFromWells` array within the plate object. This operation can only clear existing labels, or tags from specific well positions, but not sample assignments (labsheet rows).
### Assignment
Assign operations allow users to add or update well assignments including samples, labels, and tags. Multiple assignment types can be combined in a single well object.
```
{
"position": "A1",
"sample" : {
"id": "SM000001",
"labsheet": "Sample Manager"
},
"tags": ["PASSED_QC"],
"label": "SAMPLE"
}
```
**position** (string, required): The specified well position
**sample** (object, required): A dictionary object containing the id of the sample to be assigned and the corresponding origin labsheet.
**tags** (array, required): An array of string values representing custom metadata tags to associate with the well position.
**label** (string, required): When assigning a label, valid options include one of "SAMPLE", "POS_CONTROL", "NEG_CONTROL", "BLANK", "STANDARD" or left as an empty "" if no label should be assigned.
### Removal
Remove operations allow users to clear existing assignments from well positions. Users can selectively remove samples, labels, or tags from specific wells by specifying which fields to clear.
```
"removeFromWells" : [
{
"position" : "B1",
"fields" : ["LABEL"]
},
{
"position" : "A4",
"fields" : ["SAMPLE"]
}
]
```
**position** (string, required): The specified well position.
**fields** (array, required): An array of strings specifying which types of assignments to remove from the well position. Valid options include "SAMPLE", "LABEL", "TAGS".
Provide one of hrid or uuid. plate must contain wells and/or removeFromWells. Position format must match the manifest plate/box layout.'
requestBody:
content:
application/json:
schema:
type: object
properties:
hrid:
type: string
description: The human-readable ID of the manifest to update. Provide either `hrid` or `uuid`.
uuid:
type: string
description: The UUID of the manifest to update. Provide either `hrid` or `uuid`.
plate:
type: object
description: The plate operations to apply. Must contain `wells` (assign operations) and/or `removeFromWells` (remove operations), with at least one entry.
properties:
wells:
type: array
description: Assign operations that add or update sample assignments, labels, and tags at specific well positions.
items:
type: object
properties:
position:
type: string
description: The well position to assign (e.g. A1). Must match the manifest plate/box layout.
tags:
type: array
description: Custom metadata tags to associate with the well. May be an empty array.
items:
type: string
label:
type: string
description: 'The label to apply to the well. One of: SAMPLE, POS_CONTROL, NEG_CONTROL, BLANK, STANDARD, or an empty string "" for no label.'
enum:
- ''
- SAMPLE
- POS_CONTROL
- NEG_CONTROL
- BLANK
- STANDARD
sample:
type: object
description: The sample to assign to the well. Both `id` and `labsheet` are required when a sample is provided.
properties:
id:
type: string
description: The id of the sample to assign.
labsheet:
type: string
description: The name of the labsheet the sample originates from.
additionalProperties: true
required:
- position
- tags
- label
- sample
additionalProperties: true
removeFromWells:
type: array
description: Remove operations that clear existing sample assignments, labels, or tags from specific well positions.
items:
type: object
properties:
position:
type: string
description: The well position to clear (e.g. B1).
fields:
type: array
description: 'Which assignment types to remove from the well. Each value is one of: SAMPLE, TAGS, LABEL.'
items:
type: string
enum:
- SAMPLE
- TAGS
- LABEL
minItems: 1
required:
- position
- fields
additionalProperties: true
additionalProperties: true
required:
- plate
additionalProperties: true
example:
hrid: PLT000001
plate:
wells:
- position: A1
tags:
- PASSED_QC
label: SAMPLE
sample:
id: SMPL000001
labsheet: Sample Manager
removeFromWells:
- position: A2
fields:
- SAMPLE
required: true
parameters: []
responses:
'200':
description: OK
headers:
Content-Type:
schema:
type: string
example: application/json
content:
application/json:
schema:
type: object
properties:
success:
type: boolean
message:
type: string
data:
type: object
additionalProperties: true
updatedManifest:
type: object
additionalProperties: true
additionalProperties: true
example:
success: true
message: Manifest updated successfully
data:
hrid: PLT000001
'401':
description: Invalid Authentication Token
content:
application/json:
schema:
type: object
properties:
success:
type: boolean
example: false
message:
type: string
additionalProperties: true
example:
success: false
message: Invalid Authentication Token
'403':
description: Missing Authentication Token
content:
application/json:
schema:
type: object
properties:
success:
type: boolean
example: false
message:
type: string
additionalProperties: true
example:
success: false
message: Missing Authentication Token
'422':
description: Validation error
content:
application/json:
schema:
type: object
properties:
success:
type: boolean
example: false
message:
type: string
example: Validation error
example:
success: false
message: Validation error
'500':
description: Operation failed
content:
application/json:
schema:
type: object
properties:
success:
type: boolean
example: false
message:
type: string
additionalProperties: true
example:
success: false
message: Operation failed
'400':
description: Bad request
content:
application/json:
schema:
type: object
properties:
success:
type: boolean
example: false
message:
type: string
additionalProperties: true
example:
success: false
message: Bad request
operationId: postManifestUpdate
x-operation-id-source: derived
/manifest/assign-to-location:
post:
tags:
- Scispot API - MANIFESTS (PLATES, BOXES, RACKS) API
summary: Assign A Manifest To A Location
description: '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.
Provide one of hrid or uuid. position is optional and only validated for rack destinations.'
requestBody:
content:
application/json:
schema:
type: object
properties:
hrid:
type: string
description: The human-readable ID of the manifest to assign. Provide either `hrid` or `uuid`.
uuid:
type: string
description: The UUID of the manifest to assign. Provide either `hrid` or `uuid`.
locationId:
type: string
description: The UUID of the target storage location to move the manifest into.
position:
type: string
description: (Optional) The position within the target location to assign the manifest to. Only applicable and validated when the destination is a rack.
required:
- locationId
additionalProperties: true
example:
hrid: PLT000001
locationId: <uuid>
position: A1
required: true
parameters: []
responses:
'200':
headers:
Content-Type:
schema:
type: string
example: application/json
content:
application/json:
schema:
type: object
properties:
success:
type: boolean
message:
type: string
error:
type: string
additionalProperties: true
example:
success: true
message: Manifest assigned to location successfully
description: OK
'401':
description: Invalid Authentication Token
content:
application/json:
schema:
type: object
properties:
success:
type: boolean
example: false
message:
type: string
additionalProperties: true
example:
success: false
message: Invalid Authentication Token
'403':
description: Missing Authentication Token
content:
application/json:
schema:
type: object
properties:
success:
type: boolean
example: false
message:
type: string
additionalProperties: true
example:
success: false
message: Missing Authentication Token
'422':
description: Validation error
content:
application/json:
schema:
type: object
properties:
success:
type: boolean
example: false
message:
type: string
example: Validation error
example:
success: false
message: Validation error
'500':
description: Operation failed
content:
application/json:
schema:
type: object
properties:
success:
type: boolean
example: false
message:
type: string
additionalProperties: true
example:
success: false
message: Operation failed
'400':
description: Bad request
content:
application/json:
schema:
type: object
properties:
success:
type: boolean
example: false
message:
type: string
additionalProperties: true
example:
success: false
message: Bad request
operationId: postManifestAssignToLocation
x-operation-id-source: derived
components:
securitySchemes:
bearerAuth:
type: http
scheme: bearer
bearerFormat: UUID
description: Personal access token from Scispot Account → Personal Tokens