Skip to navigation
Benchling APINucleotide Alignment

Create a template nucleotide alignment

Create a template 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 against the template. Minimum 1, maximum 250.
templateSequenceIdstringRequired

The API ID of the template (reference) sequence to align against.

clustaloOptionsobjectOptional
Options to pass to the ClustalO algorithm, only applicable for ClustalO.
disableCircularSequenceRotationbooleanOptional
When true, disables circular sequence rotation during template alignment.
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.

Response

Task started
pollingUristringOptionalformat: "uri"
taskIdstringOptional

Errors

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