Skip to navigation

Annotate domains on AA sequences

Beta
Annotate registered AA domain sequences with PipeBio, updating the annotations and domain schema fields of each annotated sequence and recording the outcome for every sequence in a new Data Catalog dataset. Existing annotations on domain sequences will be removed and overwritten.

Authentication

AuthorizationBearer

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

Headers

EARLY-ACCESSstringOptional

Set to true to access beta operations via /api/v3.

Request

This endpoint expects an object.
aaSequenceIdslist of stringsRequired

IDs of the registered AA sequences to annotate. Each sequence must use a schema that implements the AA domain system category (ssi_aadomain), and all sequences must belong to the same registry.

folderIdstringRequired
ID of the folder to create the annotation results dataset in.
germlineIdstringRequired
ID of the germline to annotate the sequences against.

Response

Task started
pollingUristringOptionalformat: "uri"
taskIdstringOptional

Errors

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