For AI agents: a documentation index is available at the root level at /llms.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
Bearer authentication of the form Bearer <token>, where token is your auth token.
Path parameters
protein_schema_idstringRequired
ID of the ProteinSchema.
Headers
EARLY-ACCESSstringOptional
Set to true to access beta operations via /api/v3.
Request
This endpoint expects an object.
archiveReasonstringOptional
archivedbooleanOptional
availableRegistrationNamingOptionslist of enumsOptional
containerNameTemplateobject or nullOptional
Replaces all existing container name template parts. Legacy datetimeFormat configurations are not preserved.
descriptionstringOptional
Updated description. When provided, must be at most 1000 characters.
includeRegistryIdInChipsbooleanOptional
isContainablebooleanOptional
itemIdPrefixstringOptional
namestringOptional
Updated user-facing name. When provided, must be non-empty after stripping whitespace, at most 255 characters, and unique within the organization.
nameTemplateobject or nullOptional
Replaces all existing entity name template parts. Legacy datetimeFormat configurations are not preserved. Updating the name template does not automatically modify availableRegistrationNamingOptions — update that field separately if needed.
systemCategorieslist of objectsOptional
systemNamestringOptional
Updated SQL identifier for the warehouse table name. When provided, must match the pattern [a-z_][a-z0-9_$]*, cannot be a reserved table name, cannot start with ‘bnch$’, and must be unique within the organization.
useRegistryIdForItemDisplayLabelbooleanOptional
displayNamestringOptionalDeprecated
Deprecated. Use name instead.
Response
OK
__typenamestringOptional
archiveReasonstring or nullOptional
archivedbooleanOptional
availableRegistrationNamingOptionslist of enumsOptional
chainLinkedSchemaslist of objectsOptional
Schema or interface links for each chain label in the protein format.
constraintobject or nullOptional
Defines uniqueness requirements for entities within a schema. Constraints ensure that
registered entities have unique values across specified fields (see fieldDefinitionNames)
or unique domain-specific properties (see TypeSpecificConstraint). The hasUniqueResidues
field is a legacy indicator for sequence uniqueness.
containableTypeenumOptional
Allowed values:
containerNameTemplateobject or nullOptional
A name template for containers.
createdAtstring or nullOptional
descriptionstringOptional
domainLinkedSchemaslist of objectsOptional
Schema or interface links for each domain type in the protein format.
fieldDefinitionsstringOptionalformat: "uri"
fieldsetsstringOptionalformat: "uri"
formatobjectOptional
The protein format that defines the structure (domains, chains, interactions) for entities of this schema.
iconIdenumOptional
Allowed values:
idstringOptional
includeRegistryIdInChipsbooleanOptional
itemIdPrefixstringOptional
modifiedAtstringOptional
namestringOptional
nameTemplateobject or nullOptional
A name template for entities.
organizationobjectOptional
systemCategorieslist of objectsOptional
systemNamestringOptional
useRegistryIdForItemDisplayLabelbooleanOptional
validationRulesstringOptionalformat: "uri"
Errors
400
Protein Schema Update Request Bad Request Error
403
Protein Schema Update Request Forbidden Error
404
Protein Schema Update Request Not Found Error
409
Protein Schema Update Request Conflict Error
429
Protein Schema Update Request Too Many Requests Error
500
Protein Schema Update Request Internal Server Error
