Search AA Sequences

POST

https://{tenant_name}.benchling.com/api/v2/aa-sequences:search-amino-acids

POST

/api/v2/aa-sequences:search-amino-acids

curl -X POST https://{tenant_name}.benchling.com/api/v2/aa-sequences:search-amino-acids \
     -H "Authorization: Bearer <token>" \
     -H "Content-Type: application/json" \
     -d '{
  "aminoAcids": "string"
}'

{
  "aaSequences": [
    {
      "aliases": [
        "string"
      ],
      "aminoAcids": "IKTATARRELAETSWTGDRLWGFSDNWAPALRRPSPSALGK",
      "annotations": [
        {
          "color": "string",
          "end": 1,
          "id": "prtnann_o7zMPG0P",
          "name": "string",
          "notes": "Cong et al Science. 2013 Jan 3.",
          "start": 1,
          "type": "Site"
        }
      ],
      "apiURL": "https://benchling.com/api/v2/aa-sequences/prtn_7nMBOMm0",
      "archiveRecord": {
        "reason": "Made in error"
      },
      "authors": [
        {
          "handle": "string",
          "id": "string",
          "name": "string"
        }
      ],
      "createdAt": "2024-01-15T09:30:00Z",
      "creator": {
        "handle": "string",
        "id": "string",
        "name": "string"
      },
      "customFields": {},
      "entityRegistryId": "string",
      "fields": {},
      "folderId": "string",
      "id": "prtn_ObbdtGhC",
      "length": 1,
      "modifiedAt": "2024-01-15T09:30:00Z",
      "name": "string",
      "registrationOrigin": {
        "originEntryId": "string",
        "registeredAt": "2024-01-15T09:30:00Z"
      },
      "registryId": "string",
      "schema": {
        "id": "string",
        "name": "string"
      },
      "url": "string",
      "webURL": "https://benchling.com/benchling/f/lib_55UxcIps-registry/prtn_7nMBOMm0-kedchain11/edit\""
    }
  ],
  "nextToken": "string"
}

Returns AA Sequences that contain the provided amino acids. Search indexing is asynchronous, so results my be not be available immediately after creation.

Authentication

AuthorizationBearer

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

Request

This endpoint expects an object.

aminoAcidsstringRequired>=3 characters

archiveReasonenumOptionalDefaults to NOT_ARCHIVED

Allowed values:

nextTokenstringOptional

pageSizeintegerOptional0-100Defaults to 50

registryIdstring or nullOptional

ID of a registry. Restricts results to those registered in this registry. Specifying null returns unregistered items.

sortenumOptionalDefaults to modifiedAt:desc

Allowed values:

Response

A filtered list of AA Sequences

aaSequenceslist of objectsOptional

nextTokenstringOptional

Errors

400

Bad Request Error