Create Protein | Benchling Documentation

curl -X POST https://{tenant_name}.benchling.com/api/v3/protein \
     -H "Authorization: Bearer <token>" \
     -H "Content-Type: application/json" \
     -d '{
  "chains": [
    {
      "aaSequenceId": "prtn_pQrStUvW",
      "label": "Heavy"
    },
    {
      "aaSequenceId": "prtn_xYzAbCdE",
      "label": "Light"
    }
  ],
  "domains": [
    {
      "aaSequenceId": "prtn_aBcDeFgH",
      "label": "VH"
    },
    {
      "aaSequenceId": "prtn_hIjKlMnO",
      "label": "VL"
    }
  ],
  "folderId": "lib_o2thOLlq",
  "name": "Example IgG1",
  "schemaId": "ts_aBcDeFgH",
  "aliases": [
    "mAb-001"
  ],
  "schemaFields": {
    "expression_host": {
      "value": "CHO"
    }
  }
}'

{
  "__typename": "__typename",
  "authors": "authors",
  "creator": {
    "__typename": "__typename",
    "id": "id"
  },
  "schemaFields": [
    {
      "__typename": "__typename",
      "id": "id",
      "linkedEntityId": "linkedEntityId"
    }
  ],
  "aliases": [
    "aliases"
  ],
  "archiveReason": "archiveReason",
  "archived": true,
  "chains": [
    {
      "__typename": "__typename",
      "chainPositions": [
        {}
      ],
      "domains": [
        {}
      ],
      "label": "label",
      "type": "HEAVY"
    }
  ],
  "createdAt": "createdAt",
  "customFields": [
    {
      "__typename": "__typename",
      "name": "name",
      "value": "value"
    }
  ],
  "domains": [
    {
      "__typename": "__typename",
      "domainPositions": [
        {}
      ],
      "label": "label",
      "type": "VL"
    }
  ],
  "entityRegistryId": "entityRegistryId",
  "folder": {
    "__typename": "__typename",
    "id": "id"
  },
  "format": {
    "__typename": "__typename",
    "id": "id"
  },
  "fullHistory": "fullHistory",
  "history": "history",
  "id": "id",
  "modifiedAt": "modifiedAt",
  "name": "name",
  "outOfSync": true,
  "outOfSyncReason": "outOfSyncReason",
  "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 Protein.

Authentication

AuthorizationBearer

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

Request

This endpoint expects an object.

chainslist of objectsRequired

One entry per chain label on the protein format. Every chain on the format must be included; unknown or duplicate labels are rejected.

domainslist of objectsRequired

One entry per domain label on the protein format. Every required domain must be included; unknown or duplicate labels are rejected. Optional domains may be omitted. When included, an optional label must be specified once and applies at every format position for that label.

folderIdstringRequired

namestringRequired

Name of the item.

schemaIdstringRequired

The ID of the protein schema to create the protein in. The schema’s format defines required domain and chain labels.

aliaseslist of stringsOptional

Array of aliases

authorIdslist of stringsOptional

customFieldsmap from strings to objectsOptional

Custom fields set on the protein.

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

Values for schema-defined fields on this protein.

studyIdslist of stringsOptional

Study IDs to add the new protein to.

Response

Created

__typenamestringOptional

authorsstring or nullOptionalformat: "uri"

creatorobjectOptional

schemaFieldslist of objects or nullOptional

Values for schema-defined fields on this protein.

aliaseslist of strings or nullOptional

Array of aliases

archiveReasonstring or nullOptional

archivedbooleanOptional

chainslist of objectsOptional

The chains and associated amino acid sequences on the protein.

createdAtstringOptional

DateTime the protein was created.

customFieldslist of objects or nullOptional

Custom fields set on the protein.

domainslist of objectsOptional

The domains and associated amino acid sequences on the protein.

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

formatobjectOptional

The protein format that defines the structure (domains, chains, interactions) for the protein.

fullHistorystringOptionalformat: "uri"

fullHistory is a superset of history that also returns inactive versions that are not part of the current version history. Versions are returned in chronological order (oldest first).

historystringOptionalformat: "uri"

Only the currently active version lineage, in chronological order (oldest first).

If a change was made and then undone by resetting to an earlier version, the version recording that change is not relevant to the current state of the entity, so it is not included in this listing.

idstringOptional

ID of the protein.

modifiedAtstringOptional

DateTime the protein was last modified.

namestringOptional

Name of the item.

outOfSyncbooleanOptional

Indicates if constituent domain or chain entities have changed since the protein was last updated.

outOfSyncReasonstring or nullOptional

Any additional information about why the protein is out of sync.

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.

schemaobjectOptional

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

typedSchemaobjectOptional

Schema reference for this protein. Callers can retrieve the schema separately when they need its field definitions.

Errors

400

Protein Create Request Bad Request Error

403

Protein Create Request Forbidden Error

404

Protein Create Request Not Found Error

409

Protein Create Request Conflict Error

429

Protein Create Request Too Many Requests Error

500

Protein Create Request Internal Server Error