Skip to navigation
Benchling APINucleotide Alignment

Create a consensus nucleotide alignment

Create a consensus nucleotide alignment

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Request

This endpoint expects an object.
algorithmenumRequired
Multiple sequence alignment algorithm to use.
Allowed values:
fileslist of objectsRequired
Sequence files to align. Minimum 2, maximum 250.
clustaloOptionsobjectOptional
Options to pass to the ClustalO algorithm, only applicable for ClustalO.
mafftOptionsobjectOptional
Options to pass to the MAFFT algorithm, only applicable for MAFFT.
namestringOptional

The name of the alignment. When omitted, a name is automatically generated. If specified, it must contain at least one non-whitespace character. Up to 255 characters.

newSequenceobjectOptional
Specifies a folder in which to create a new NucleotideSequence to store the consensus alignment result. Mutually exclusive with sequenceId.
sequenceIdstringOptional

API ID of an existing empty NucleotideSequence to overwrite with the consensus alignment result. The target sequence must have no bases; requests fail with ‘Sequence must be empty’ otherwise. Mutually exclusive with newSequence.

Response

Task started
pollingUristringOptionalformat: "uri"
taskIdstringOptional

Errors

400
Nucleotide Alignment Create Consensus Alignment Request Bad Request Error
403
Nucleotide Alignment Create Consensus Alignment Request Forbidden Error
404
Nucleotide Alignment Create Consensus Alignment Request Not Found Error
409
Nucleotide Alignment Create Consensus Alignment Request Conflict Error
429
Nucleotide Alignment Create Consensus Alignment Request Too Many Requests Error
500
Nucleotide Alignment Create Consensus Alignment Request Internal Server Error