Create AaSequence

POST

https://{tenant_name}.benchling.com/api/v3/aa-sequence

POST

/api/v3/aa-sequence

curl -X POST https://{tenant_name}.benchling.com/api/v3/aa-sequence \
     -H "Authorization: Bearer <token>" \
     -H "Content-Type: application/json" \
     -d '{
  "aminoAcids": "MADYKDDDDKMVSKGEEDNMAIIKEFMRFKV",
  "folderId": "lib_o2thOLlq",
  "name": "Example recombinant protein",
  "aliases": [
    "protein-a",
    "rec-protein-01"
  ],
  "annotations": [
    {
      "end": 10,
      "name": "N-terminal tag",
      "start": 0,
      "color": "#FF6B6B",
      "notes": "Affinity purification tag",
      "type": "Tag"
    },
    {
      "end": 30,
      "name": "Catalytic domain",
      "start": 10,
      "color": "#4ECDC4",
      "type": "Domain"
    }
  ],
  "namingStrategy": "NEW_IDS",
  "registryId": "src_abcdefghij",
  "schemaFields": {
    "expression_level": {
      "value": "High"
    }
  },
  "schemaId": "ts_aBcDeFgH"
}'

{
  "__typename": "__typename",
  "authors": "authors",
  "creator": {
    "__typename": "__typename",
    "id": "id"
  },
  "schemaFields": [
    {
      "__typename": "__typename",
      "id": "id",
      "linkedEntityId": "linkedEntityId"
    }
  ],
  "aliases": [
    "aliases"
  ],
  "aminoAcids": "aminoAcids",
  "annotations": "annotations",
  "archiveReason": "archiveReason",
  "archived": true,
  "createdAt": "createdAt",
  "customFields": [
    {
      "__typename": "__typename",
      "name": "name",
      "value": "value"
    }
  ],
  "entityRegistryId": "entityRegistryId",
  "folder": {
    "__typename": "__typename",
    "id": "id"
  },
  "id": "id",
  "modifiedAt": "modifiedAt",
  "name": "name",
  "project": {
    "__typename": "__typename",
    "id": "id"
  },
  "registrationOrigin": {
    "__typename": "__typename",
    "originEntry": {
      "__typename": "__typename",
      "id": "id"
    },
    "registeredAt": "registeredAt"
  },
  "registry": {
    "__typename": "__typename",
    "id": "id"
  },
  "schema": {
    "__typename": "__typename",
    "id": "id"
  },
  "typedSchema": {
    "__typename": "__typename",
    "id": "id"
  }
}

Create a new AA sequence.

Authentication

AuthorizationBearer

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

Request

This endpoint expects an object.

aminoAcidsstringRequired

Amino acids of the AA sequence. Letters A-Z only (case-insensitive). Invalid characters are rejected. There is a per-tenant limit on sequence length (50,000 characters by default).

folderIdstringRequired

namestringRequired

Name of the item.

aliaseslist of stringsOptional

Array of aliases

annotationslist of objectsOptional

Optional annotations to create on the new sequence. Each entry defines a region with 0-based start (inclusive) and end (exclusive) indices.

authorIdslist of stringsOptional

customFieldsmap from strings to objectsOptional

Custom fields set on the AA sequence.

entityRegistryIdstringOptional

Registry ID to assign to the entity. If one is specified, the labeling_strategy must be unspecified.

namingStrategyenumOptional

Strategy to use for labeling the item in the registry. If one is specified, the entity_registry_id must be unspecified.

registryIdstring or nullOptional

A not null value means the entity should be registered. If not null, the value must match the registry of the item's schema.

schemaFieldsmap from strings to objectsOptional

schemaIdstringOptional

Response

Created

__typenamestringOptional

authorsstring or nullOptionalformat: "uri"

creatorobject or nullOptional

schemaFieldslist of objects or nullOptional

aliaseslist of strings or nullOptional

Array of aliases

aminoAcidsstringOptional

Amino acids of the AA sequence.

annotationsstringOptionalformat: "uri"

Annotations marking functional regions, domains, binding sites, post-translational modifications, or other features on the AA sequence.

archiveReasonstring or nullOptional

archivedbooleanOptional

createdAtstring or nullOptional

DateTime the AA sequence was created.

customFieldslist of objects or nullOptional

Custom fields set on the AA sequence.

entityRegistryIdstring or nullOptional

The registry-assigned identifier for this item (e.g. its registry ID shown in the UI), present only once the item has been registered. Null if the item is not registered.

folderobject or nullOptional

Folder containing the AA sequence.

idstringOptional

ID of the AA sequence.

modifiedAtstring or nullOptional

DateTime the AA sequence was last modified.

namestringOptional

Name of the item.

projectobject or nullOptional

registrationOriginobject or nullOptional

Provenance of this item’s registration — where and when it was registered. Null if unregistered.

registryobject or nullOptional

The Registry this item belongs to, if registered. Null if unregistered.

schemaobject or nullOptional

Use typedSchema instead, which returns the per-type schema.

typedSchemaobject or nullOptional

Errors

400

Aa Sequence Create Request Bad Request Error

403

Aa Sequence Create Request Forbidden Error

404

Aa Sequence Create Request Not Found Error

409

Aa Sequence Create Request Conflict Error

429

Aa Sequence Create Request Too Many Requests Error

500

Aa Sequence Create Request Internal Server Error