Create a DNA sequence

POST

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

POST

/api/v2/dna-sequences

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

{
  "aliases": [
    "string"
  ],
  "annotations": [
    {
      "color": "#F58A5E",
      "customFields": [
        {
          "name": "string",
          "value": "string"
        }
      ],
      "name": "string",
      "notes": "Cong et al Science. 2013 Jan 3.",
      "end": 1,
      "start": 1,
      "strand": 1,
      "type": "string"
    }
  ],
  "apiURL": "https://benchling.com/api/v2/dna-sequences/seq_asQya4lk",
  "archiveRecord": {
    "reason": "Made in error"
  },
  "authors": [
    {
      "handle": "string",
      "id": "string",
      "name": "string"
    }
  ],
  "bases": "string",
  "createdAt": "2024-01-15T09:30:00Z",
  "creator": {
    "handle": "string",
    "id": "string",
    "name": "string"
  },
  "customFields": {
    "Legacy ID": {
      "value": "STR100"
    }
  },
  "dnaAlignmentIds": [
    "string"
  ],
  "entityRegistryId": "string",
  "fields": {},
  "folderId": "string",
  "id": "string",
  "isCircular": true,
  "length": 1,
  "modifiedAt": "2024-01-15T09:30:00Z",
  "name": "string",
  "parts": [
    {
      "end": 1,
      "sequenceId": "seq_VfVOART1",
      "start": 1,
      "strand": 1
    }
  ],
  "primers": [
    {
      "bases": "string",
      "bindPosition": 1,
      "color": "string",
      "end": 1,
      "name": "string",
      "oligoId": "string",
      "overhangLength": 1,
      "start": 1,
      "strand": 1
    }
  ],
  "registrationOrigin": {
    "originEntryId": "string",
    "registeredAt": "2024-01-15T09:30:00Z"
  },
  "registryId": "string",
  "schema": {
    "id": "string",
    "name": "string"
  },
  "transcriptions": [
    {
      "end": 1,
      "sequenceId": "seq_VfVOART1",
      "start": 1,
      "strand": 1
    }
  ],
  "translations": [
    {
      "color": "#F58A5E",
      "customFields": [
        {
          "name": "string",
          "value": "string"
        }
      ],
      "name": "string",
      "notes": "Cong et al Science. 2013 Jan 3.",
      "aminoAcids": "string",
      "coerceStartCodonToMethionine": false,
      "end": 1,
      "geneticCode": "STANDARD",
      "regions": [
        {
          "end": 1,
          "start": 1
        }
      ],
      "start": 1,
      "strand": 1
    }
  ],
  "url": "string",
  "webURL": "string"
}

Create a DNA sequence

Authentication

AuthorizationBearer

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

Request

This endpoint expects an object.

aliaseslist of stringsOptional

Aliases to add to the DNA sequence

annotationslist of objectsOptional

Annotations to create on the DNA sequence.

authorIdslist of stringsOptional

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

basesstringOptional

Base pairs for the DNA sequence.

customFieldsmap from strings to objectsOptional

Custom fields to add to the DNA 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 DNA 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 DNA sequence.

isCircularbooleanOptional

Whether the DNA sequence is circular or linear.

namestringOptional

Name of the DNA 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

partslist of objectsOptional

primerslist of objectsOptional

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 DNA sequence's schema.

translationslist of objectsOptional

Translations to create on the DNA sequence. Translations are specified by either a combination of 'start' and 'end' fields, or a list of regions. Both cannot be provided.

Response

Created

aliaseslist of stringsOptional

annotationslist of objectsOptional

apiURLstringOptionalRead-onlyformat: "uri"

The canonical url of the DNA Sequence in the API.

archiveRecordobject or nullOptional

authorslist of objectsOptional

basesstringOptional

createdAtdatetimeOptionalRead-only

creatorobjectOptional

customFieldsmap from strings to objectsOptional

dnaAlignmentIdslist of stringsOptional

API IDs of Nucleotide Alignments involving the RNA sequence

entityRegistryIdstring or nullOptional

fieldsmap from strings to objectsOptional

folderIdstring or nullOptional

idstringOptional

isCircularbooleanOptional

lengthintegerOptional

modifiedAtdatetimeOptionalRead-only

namestringOptional

partslist of objectsOptional

primerslist of objectsOptional

registrationOriginobject or nullOptional

registryIdstring or nullOptional

schemaobject or nullOptional

transcriptionslist of objectsOptional

translationslist of objectsOptional

urlstringOptional

The path of the web URL, omitting the tenant domain

webURLstringOptionalRead-only

Errors

400

Bad Request Error

503

Service Unavailable Error