Create an AA sequence

POST

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

POST

/api/v2/aa-sequences

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

{
  "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\""
}

Create an 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 for the AA sequence.

namestringRequired

Name of the AA sequence.

aliaseslist of stringsOptional

Aliases to add to the AA sequence

annotationslist of objectsOptional

Annotations to create on the AA sequence.

authorIdslist of stringsOptional

IDs of users to set as the AA sequence's authors.

customFieldsmap from strings to objectsOptional

Custom fields to add to the AA sequence. Every field should have its name as a key, mapping to an object with information about the value of the field.

entityRegistryIdstringOptional

Entity registry ID to set for the registered entity. Cannot specify both entityRegistryId and namingStrategy at the same time.

fieldsmap from strings to objectsOptional

Fields to set on the AA sequence. Must correspond with the schema's field definitions. Every field should have its name as a key, mapping to an object with information about the value of the field.

folderIdstringOptional

ID of the folder containing the AA sequence.

namingStrategyenumOptional

Specifies the behavior for automatically generated names when registering an entity.

NEW_IDS: Generate new registry IDs
IDS_FROM_NAMES: Generate registry IDs based on entity names
DELETE_NAMES: Generate new registry IDs and replace name with registry ID
SET_FROM_NAME_PARTS: Generate new registry IDs, rename according to name template, and keep old name as alias
REPLACE_NAMES_FROM_PARTS: Generate new registry IDs, and replace name according to name template
KEEP_NAMES: Keep existing entity names as registry IDs
REPLACE_ID_AND_NAME_FROM_PARTS: Generate registry IDs and names according to name template

registryIdstringOptional

Registry ID into which entity should be registered. this is the ID of the registry which was configured for a particular organization To get available registryIds, use the /registries endpoint

Required in order for entities to be created directly in the registry.

schemaIdstringOptional

ID of the AA sequence's schema.

Response

Created

aliaseslist of stringsOptional

Array of aliases

aminoAcidsstringOptional

Amino acids of the AA sequence.

annotationslist of objectsOptional

Array of annotation objects on the AA sequence.

apiURLstringOptionalRead-onlyformat: "uri"

The canonical url of the AA Sequence in the API.

archiveRecordobject or nullOptional

authorslist of objectsOptional

createdAtdatetimeOptionalRead-only

DateTime the AA sequence was created.

creatorobjectOptional

customFieldsmap from strings to objectsOptional

Custom fields set on the AA sequence.

entityRegistryIdstring or nullOptional

Registry ID of the AA sequence if registered.

fieldsmap from strings to objectsOptional

folderIdstring or nullOptional

ID of the folder that contains the AA sequence.

idstringOptional

ID of the AA sequence.

lengthintegerOptional

Number of amino acids in the AA sequence.

modifiedAtdatetimeOptionalRead-only

DateTime the AA sequence was last modified.

namestringOptional

Name of the AA sequence.

registrationOriginobject or nullOptional

registryIdstring or nullOptional

Registry the AA sequence is registered in.

schemaobject or nullOptional

urlstringOptional

The path of the web URL, omitting the tenant domain

webURLstringOptionalRead-onlyformat: "uri"

URL of the AA sequence.

Errors

400

Bad Request Error

503

Service Unavailable Error