BEbenchling
Protein Format

Create ProteinFormat

Create ProteinFormat.

post/api/v3/protein-format

Request

  • Base URL
    https://{tenant_name}.benchling.com
  • Auth
    HTTP bearer

Request body

namestring

Display name of the protein format. When omitted, the VERITAS name is used. When provided, the name must be non-empty after stripping whitespace, at most 255 characters, and unique among all protein format names in the organization (including built-in format names).

veritasNamestring required

VERITAS name that defines the protein format structure and visualization. Must be a supported VERITAS format name; invalid or unsupported values are rejected. The structure implied by this name cannot be changed after the format is created. Creating a custom protein format requires Biologics create access for the authenticated user or app.

Response

Created

__typenamestring
archiveReasonstring nullable
archivedboolean
builtInboolean

Whether this is an out-of-the-box Benchling-provided format. These formats come pre-loaded and cannot be modified or deleted by users.

createdAtstring datetime

When the protein format was created.

idstring

API identifier of the protein format. Custom formats use the abfmt_ prefix; built-in formats use builtinabfmt_.

modifiedAtstring datetime

When the protein format was last modified.

namestring

The display name of the protein format.

originalVeritasstring nullable

The VERITAS string used to create the format.

Changes

No recorded changes to this operation across all 1 revision of this API.