Breaking changes to the AFDB predictions API

logo

The AlphaFold Database has significant upcoming changes to the “prediction” API endpoint. The primary driver behind these changes is the expanding dataset of predicted protein structures. 

 

 

 

 

 

 

 

 

 

 

Deprecation Timeline: Ensuring a Smooth Transition

We understand that transitioning to a new API can be a significant step for our users, and we want to make the process as seamless as possible. We have developed a carefully planned “API deprecation timeline” to facilitate this transition, guide you through the changes and ensure a smooth migration.

  1. Dual Support Period

Duration: 9 months

The old and new APIs will be supported during this phase, allowing users to migrate at their own pace. This period is designed to provide ample time to update workflows or applications.

  1. Sunset Date

End Date: 25-06-2026 (DD-MM-YYYY)

The sunset date marks the end of support for the old API fields. After this date, the old fields will be replaced by the new API fields and will be served as usual.

The following table summarises deprecated fields and their new equivalents. During the deprecation window, both versions will be available to support a smooth transition.

 

Current (deprecated) Field New Field Notes
entryId modelEntityId Renamed for clarity in entity representation
uniprotStart sequenceStart Aligns terminology with sequence context
uniprotEnd sequenceEnd Consistent with sequenceStart
uniprotSequence sequence New field retains the same value; renamed for clarity
isReviewed isUniProtReviewed More descriptive of the data source
isReferenceProteome isUniProtReferenceProteome Clarifies connection to UniProt Reference Proteome

 

Field Removal Notice
Removed Field Notes
paeImageUrl The predicted aligned error (PAE) image will no longer be provided or accessible via the API.

 

 

For complete schema reference, see: https://alphafold.ebi.ac.uk/api-doc