{"openapi":"3.1.0","info":{"title":"3D Beacons HUB API","description":"The 3D-Beacons Network provides unified programmatic access to experimentally determined and predicted structure models.","contact":{"name":"3D-Beacons Network","url":"https://3dbeacons.org/","email":"pdbekb_help@ebi.ac.uk"},"license":{"name":"CC BY 4.0","url":"https://creativecommons.org/licenses/by/4.0/"},"version":"2.7.1"},"servers":[{"url":"/pdbe/pdbe-kb/3dbeacons/api/v2"}],"paths":{"/uniprot/summary/{qualifier}.json":{"get":{"tags":["UniProt"],"summary":"Get Uniprot Summary","description":"Retrieve a summary of experimentally determined and predicted structure models\n    available for a UniProtKB accession, entry name, or CRC64 checksum associated\n    with a UniProt sequence.\n\n    Note that some model providers may not support searches by entry name or\n    CRC64 checksum.","operationId":"get_uniprot_summary_uniprot_summary__qualifier__json_get","parameters":[{"name":"qualifier","in":"path","required":true,"schema":{"description":"UniProtKB accession number (AC), entry name (ID) or CRC64 checksum of the UniProt sequence","title":"Qualifier"},"description":"UniProtKB accession number (AC), entry name (ID) or CRC64 checksum of the UniProt sequence","example":"P38398"},{"name":"provider","in":"query","required":false,"schema":{"anyOf":[{},{"type":"null"}],"enum":["pdbe","ped","swissmodel","alphafold","sasbdb","alphafill","hegelab","modelarchive","isoformio","levylab"],"title":"Provider"}},{"name":"template","in":"query","required":false,"schema":{"anyOf":[{},{"type":"null"}],"description":"Template is 4 letter PDB code, or 4 letter code with assembly ID and chain for SMTL entries","title":"Template"},"description":"Template is 4 letter PDB code, or 4 letter code with assembly ID and chain for SMTL entries"},{"name":"range","in":"query","required":false,"schema":{"anyOf":[{},{"type":"null"}],"description":"Specify a UniProt sequence residue range","title":"Range"},"description":"Specify a UniProt sequence residue range"},{"name":"exclude_provider","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Provider to exclude.","enum":["pdbe","ped","swissmodel","alphafold","sasbdb","alphafill","hegelab","modelarchive","isoformio","levylab"],"title":"Exclude Provider"},"description":"Provider to exclude."},{"name":"uniprot_checksum","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"CRC64 checksum of the UniProt sequence","title":"Uniprot Checksum"},"description":"CRC64 checksum of the UniProt sequence"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UniprotSummary"}}}}}}},"/uniprot/summary":{"post":{"tags":["UniProt"],"summary":"Get List Of Uniprot Summary","description":"Returns summary of experimental and theoretical models for a list of UniProt accessions","operationId":"get_list_of_uniprot_summary_uniprot_summary_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessionListRequest"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/UniprotSummary"},"type":"array","title":"Response Get List Of Uniprot Summary Uniprot Summary Post"}}}}}}},"/uniprot/{qualifier}.json":{"get":{"tags":["UniProt"],"summary":"Get Uniprot","description":"Retrieve residue-level mappings for experimentally determined and predicted\n    structure models available for a UniProtKB accession, entry name, or CRC64\n    checksum associated with a UniProt sequence.\n\n    Note that some model providers may not support searches by entry name or\n    CRC64 checksum.","operationId":"get_uniprot_uniprot__qualifier__json_get","parameters":[{"name":"qualifier","in":"path","required":true,"schema":{"description":"UniProtKB accession number (AC), entry name (ID) or CRC64 checksum of the UniProt sequence","title":"Qualifier"},"description":"UniProtKB accession number (AC), entry name (ID) or CRC64 checksum of the UniProt sequence","example":"P38398"},{"name":"provider","in":"query","required":false,"schema":{"anyOf":[{},{"type":"null"}],"enum":["swissmodel","pdbe"],"title":"Provider"}},{"name":"template","in":"query","required":false,"schema":{"anyOf":[{},{"type":"null"}],"description":"Template is 4 letter PDB code, or 4 letter code with assembly ID and chain for SMTL entries","title":"Template"},"description":"Template is 4 letter PDB code, or 4 letter code with assembly ID and chain for SMTL entries"},{"name":"range","in":"query","required":false,"schema":{"anyOf":[{},{"type":"null"}],"description":"Specify a UniProt sequence residue range","title":"Range"},"description":"Specify a UniProt sequence residue range"},{"name":"uniprot_checksum","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"CRC64 checksum of the UniProt sequence","title":"Uniprot Checksum"},"description":"CRC64 checksum of the UniProt sequence"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UniprotDetails"}}}}}}},"/ensembl/summary/{qualifier}.json":{"get":{"tags":["Ensembl"],"summary":"Get Ensembl Summary","operationId":"get_ensembl_summary_ensembl_summary__qualifier__json_get","parameters":[{"name":"qualifier","in":"path","required":true,"schema":{"description":"Ensembl identifier.","title":"Qualifier"},"description":"Ensembl identifier.","example":"ENSG00000288864"},{"name":"provider","in":"query","required":false,"schema":{"anyOf":[{},{"type":"null"}],"enum":["pdbe","ped","swissmodel","alphafold","sasbdb","alphafill","hegelab","modelarchive","isoformio","levylab"],"title":"Provider"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EnsemblSummary"}}}}}}},"/sequence/search":{"post":{"tags":["Sequence"],"summary":"Search","operationId":"search_sequence_search_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Sequence"}}},"required":true},"responses":{"202":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SearchSuccessMessage","type":"string","title":"Response Search Sequence Search Post"}}}},"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SearchSuccessMessage"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/JobSubmissionErrorMessage"}}}}}}},"/sequence/result":{"get":{"tags":["Sequence"],"summary":"Result","operationId":"result_sequence_result_get","parameters":[{"name":"job_id","in":"query","required":true,"schema":{"type":"string","title":"Job Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/SearchAccession"},"title":"Response 200 Result Sequence Result Get"}}}},"202":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SearchInProgressMessage"}}},"description":"Accepted"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NoJobFoundMessage"}}},"description":"Bad Request"}}}},"/sequence/summary":{"get":{"tags":["Sequence"],"summary":"Sequence Summary","description":"Retrieve a summary of experimentally determined and predictedstructure models available for a sequence.","operationId":"sequence_summary_api_sequence_summary_get","parameters":[{"name":"id","in":"query","required":true,"schema":{"type":"string","description":"Identifier for the type specified in the type parameter","title":"Id"},"description":"Identifier for the type specified in the type parameter"},{"name":"type","in":"query","required":false,"schema":{"anyOf":[{"$ref":"#/components/schemas/SequenceIdType"},{"type":"null"}],"description":"Type of the identifier","default":"sequence","title":"Type"},"description":"Type of the identifier"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SequenceSummary"}}}}}}},"/annotations/{uniprot_qualifier}.json":{"get":{"tags":["Annotations"],"summary":"Get annotations for a UniProt residue range","description":"Get annotations for a range of UniProt residues.","operationId":"get_annotations_api_annotations__uniprot_qualifier__json_get","parameters":[{"name":"uniprot_qualifier","in":"path","required":true,"schema":{"description":"UniProtKB accession number (AC) or entry name (ID)","title":"Uniprot Qualifier"},"description":"UniProtKB accession number (AC) or entry name (ID)","example":"Q14676"},{"name":"type","in":"query","required":true,"schema":{"$ref":"#/components/schemas/FeatureType","description":"Annotation type"},"description":"Annotation type"},{"name":"provider","in":"query","required":false,"schema":{"anyOf":[{},{"type":"null"}],"enum":["pdbe","alphafold"],"title":"Provider"}},{"name":"range","in":"query","required":false,"schema":{"description":"Specify a UniProt sequence residue range; separated by hyphen(-).","title":"Range"},"description":"Specify a UniProt sequence residue range; separated by hyphen(-)."}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Annotation"}}}}}}},"/health/":{"get":{"summary":"Health Check","description":"Returns the health status of all the beacons.","operationId":"health_check_health__get","responses":{"200":{"description":"Service is healthy.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HealthResponse"}},"application/health+json":{"example":[{"status":"pass","service_id":"pdbe","beacons_api_version":"2.7.0","output":""}]}}},"500":{"description":"Service is down or unhealthy.","content":{"application/health+json":{"example":[{"status":"fail","service_id":"pdbe","beacons_api_version":"2.7.0","output":"Service is unhealthy, not able to reach the backend!"}]}}}}}}},"components":{"schemas":{"AccessionListRequest":{"properties":{"accessions":{"items":{"type":"string"},"type":"array","title":"Accessions","description":"A list of UniProt accessions","example":["P00734","P38398"]},"provider":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Provider","description":"Name of the model provider","example":"swissmodel"},"exclude_provider":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Exclude Provider","description":"Provider to exclude.","example":"pdbe"}},"type":"object","required":["accessions"],"title":"AccessionListRequest"},"Annotation":{"properties":{"accession":{"type":"string","title":"Accession","description":"A UniProt accession","example":"P00734"},"id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Id","description":"A UniProt identifier","example":"FGFR2_HUMAN"},"sequence":{"type":"string","title":"Sequence","description":"The sequence of the protein","example":"AFFGVAATRKL"},"annotation":{"anyOf":[{"items":{"$ref":"#/components/schemas/FeatureItem"},"type":"array"},{"type":"null"}],"title":"Annotation"}},"type":"object","required":["accession","sequence"],"title":"Annotation"},"Chain":{"properties":{"chain_id":{"type":"string","title":"Chain Id"},"segments":{"anyOf":[{"items":{"$ref":"#/components/schemas/Segment"},"type":"array"},{"type":"null"}],"title":"Segments"}},"type":"object","required":["chain_id"],"title":"Chain"},"Chains":{"items":{"$ref":"#/components/schemas/Chain"},"type":"array","title":"Chains"},"ChecksumType":{"type":"string","enum":["CRC64","MD5"],"title":"ChecksumType","description":"Type of checksum enumeration"},"Detailed":{"properties":{"summary":{"$ref":"#/components/schemas/app__uniprot__schema__SummaryItems"},"chains":{"$ref":"#/components/schemas/Chains"}},"type":"object","required":["summary","chains"],"title":"Detailed"},"EnsemblSummary":{"properties":{"ensembl_id":{"type":"string","title":"Ensembl Id","description":"An Ensembl identifier"},"species":{"type":"string","title":"Species","description":"Species name"},"taxid":{"type":"string","title":"Taxid","description":"Taxonomy identifier"},"uniprot_mappings":{"items":{"$ref":"#/components/schemas/UniprotMapping"},"type":"array","title":"Uniprot Mappings"}},"type":"object","required":["ensembl_id","species","taxid","uniprot_mappings"],"title":"EnsemblSummary"},"EnsemblTranscript":{"properties":{"transcript_id":{"type":"string","title":"Transcript Id","description":"Transcript identifier"},"seqRegionStart":{"type":"integer","title":"Seqregionstart","description":"Start position of the transcript"},"seqRegionEnd":{"type":"integer","title":"Seqregionend","description":"End position of the transcript"},"alignment_difference":{"anyOf":[{"type":"number","maximum":1.0,"minimum":0.0},{"type":"null"}],"title":"Alignment Difference","description":"Fraction of alignment difference (0 to 1)"}},"type":"object","required":["transcript_id","seqRegionStart","seqRegionEnd"],"title":"EnsemblTranscript"},"EnsembleSampleFormat":{"type":"string","enum":["PDB","MMCIF","BCIF"],"title":"EnsembleSampleFormat"},"Entry":{"properties":{"sequence":{"type":"string","title":"Sequence","description":"The protein sequence"},"checksum":{"type":"string","title":"Checksum","description":"CRC64 or MD5 checksum of the sequence"},"checksum_type":{"$ref":"#/components/schemas/ChecksumType","description":"Type of the checksum"}},"type":"object","required":["sequence","checksum","checksum_type"],"title":"Entry","description":"Entry information for sequence summary"},"Evidence":{"type":"string","enum":["EXPERIMENTALLY DETERMINED","COMPUTATIONAL/PREDICTED","FROM LITERATURE"],"title":"Evidence"},"ExperimentalMethod1":{"type":"string","enum":["ELECTRON CRYSTALLOGRAPHY","ELECTRON MICROSCOPY","EPR","FIBER DIFFRACTION","FLUORESCENCE TRANSFER","INFRARED SPECTROSCOPY","NEUTRON DIFFRACTION","POWDER DIFFRACTION","SOLID-STATE NMR","SOLUTION NMR","SOLUTION SCATTERING","THEORETICAL MODEL","X-RAY DIFFRACTION","HYBRID"],"title":"ExperimentalMethod1"},"FeatureItem":{"properties":{"type":{"$ref":"#/components/schemas/FeatureType","description":"Type of the annotation","example":"ACT_SITE"},"description":{"type":"string","title":"Description","description":"Description/Label of the annotation","example":"Pfam N1221 (PF07923})"},"source_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Source Name","description":"Name of the source of the annotations, i.e. where is the data from"},"source_url":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Source Url","description":"URL of the source of the annotation, i.e. where to find more data"},"evidence":{"anyOf":[{"$ref":"#/components/schemas/Evidence"},{"type":"null"}],"description":"Evidence category of the annotation"},"residues":{"anyOf":[{"items":{"type":"integer"},"type":"array"},{"type":"null"}],"title":"Residues","description":"An array of residue indices"},"regions":{"anyOf":[{"items":{"$ref":"#/components/schemas/Region"},"type":"array"},{"type":"null"}],"title":"Regions"}},"type":"object","required":["type","description"],"title":"FeatureItem"},"FeatureType":{"type":"string","enum":["CARBOHYD","DOMAIN","ACT_SITE","METAL","BINDING","NON_STD","MOD_RES","DISULFID","MUTAGEN","HELIX","STRAND","DISORDERED","INTERFACE","CHANNEL"],"title":"FeatureType"},"HSPS":{"properties":{"hsp_score":{"type":"number","title":"Hsp Score"},"hsp_bit_score":{"type":"number","title":"Hsp Bit Score"},"hsp_align_len":{"type":"integer","title":"Hsp Align Len"},"hsp_identity":{"type":"number","title":"Hsp Identity"},"hsp_positive":{"type":"number","title":"Hsp Positive"},"hsp_qseq":{"type":"string","title":"Hsp Qseq"},"hsp_hseq":{"type":"string","title":"Hsp Hseq"},"hsp_mseq":{"type":"string","title":"Hsp Mseq"},"hsp_expect":{"type":"number","title":"Hsp Expect"}},"type":"object","required":["hsp_score","hsp_bit_score","hsp_align_len","hsp_identity","hsp_positive","hsp_qseq","hsp_hseq","hsp_mseq","hsp_expect"],"title":"HSPS"},"HTTPValidationError":{"properties":{"detail":{"items":{"$ref":"#/components/schemas/ValidationError"},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"},"HealthResponse":{"items":{"$ref":"#/components/schemas/HealthStatus"},"type":"array","title":"HealthResponse","description":"Response model for /health endpoint - returns array of status objects"},"HealthStatus":{"properties":{"status":{"$ref":"#/components/schemas/HealthStatusEnum","description":"The status of the service"},"service_id":{"type":"string","title":"Service Id","description":"The identifier of the service, corresponds to the provider ID in the registry"},"beacons_api_version":{"type":"string","title":"Beacons Api Version","description":"The version of the 3DBeacons API"},"output":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Output","description":"Raw error output, in case of 'fail' or 'warn' states"}},"type":"object","required":["status","service_id","beacons_api_version"],"title":"HealthStatus","description":"Individual service health status model for /health endpoint"},"HealthStatusEnum":{"type":"string","enum":["pass","warn","fail"],"title":"HealthStatusEnum","description":"Health status enumeration based on the OpenAPI spec"},"JobSubmissionErrorMessage":{"properties":{"message":{"type":"string","title":"Message","default":"Error in submitting the job, please retry!"}},"type":"object","title":"JobSubmissionErrorMessage"},"NoJobFoundMessage":{"properties":{"message":{"type":"string","title":"Message","default":"No search job found for the given sequence, please submit the job again!"}},"type":"object","title":"NoJobFoundMessage"},"Overview":{"properties":{"summary":{"$ref":"#/components/schemas/app__uniprot__schema__SummaryItems"}},"type":"object","required":["summary"],"title":"Overview"},"Region":{"properties":{"start":{"type":"integer","title":"Start","description":"The first position of the annotation","example":23},"end":{"type":"integer","title":"End","description":"The last position of the annotation","example":42},"annotation_value":{"type":"string","title":"Annotation Value","description":"The value of the annotation","example":"0.9"},"unit":{"type":"string","title":"Unit","description":"The unit of the annotation value, if applicable","example":"mmol"}},"type":"object","required":["start","end"],"title":"Region"},"Residue":{"properties":{"confidence":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Confidence","description":"Confidence score in the range of [0,1]","example":0.99},"model_residue_label":{"type":"integer","title":"Model Residue Label","description":"Model residue index","example":1},"uniprot_residue_number":{"type":"integer","title":"Uniprot Residue Number","description":"UniProt residue index","example":1}},"type":"object","required":["model_residue_label","uniprot_residue_number"],"title":"Residue"},"SearchAccession":{"properties":{"accession":{"type":"string","title":"Accession"},"id":{"type":"string","title":"Id"},"description":{"type":"string","title":"Description"},"hit_length":{"type":"integer","title":"Hit Length"},"hit_hsps":{"items":{"$ref":"#/components/schemas/HSPS"},"type":"array","title":"Hit Hsps"},"summary":{"$ref":"#/components/schemas/UniprotSummary"},"hit_uni_ox":{"type":"integer","title":"Hit Uni Ox"},"hit_uni_os":{"type":"string","title":"Hit Uni Os"},"hit_com_os":{"type":"string","title":"Hit Com Os"},"title":{"type":"string","title":"Title"}},"type":"object","required":["accession","id","description","hit_length","hit_hsps","hit_uni_ox","hit_uni_os","hit_com_os","title"],"title":"SearchAccession"},"SearchInProgressMessage":{"properties":{"message":{"type":"string","title":"Message","default":"Search in progress, please try after sometime!"}},"type":"object","title":"SearchInProgressMessage"},"SearchSuccessMessage":{"properties":{"job_id":{"type":"string","title":"Job Id"}},"type":"object","required":["job_id"],"title":"SearchSuccessMessage"},"Segment":{"properties":{"templates":{"anyOf":[{"items":{"$ref":"#/components/schemas/Template"},"type":"array"},{"type":"null"}],"title":"Templates","description":"Information on the template(s) used for the model"},"seqres":{"$ref":"#/components/schemas/Seqres","description":"Information on the sequence of the model"},"uniprot":{"$ref":"#/components/schemas/Uniprot"},"residues":{"items":{"$ref":"#/components/schemas/Residue"},"type":"array","title":"Residues"}},"type":"object","required":["seqres","uniprot","residues"],"title":"Segment"},"Seqres":{"properties":{"aligned_sequence":{"type":"string","title":"Aligned Sequence","description":"Sequence of the model","example":"AAGTGHLKKKYT..."},"from":{"type":"integer","title":"From","description":"1-indexed first residue","example":32},"to":{"type":"integer","title":"To","description":"1-indexed last residue","example":976}},"type":"object","required":["aligned_sequence","from","to"],"title":"Seqres"},"Sequence":{"properties":{"sequence":{"type":"string","title":"Sequence"}},"type":"object","required":["sequence"],"title":"Sequence"},"SequenceIdType":{"type":"string","enum":["sequence","crc64","md5"],"title":"SequenceIdType"},"SequenceOverview":{"properties":{"summary":{"$ref":"#/components/schemas/app__sequence__schema__SummaryItems","description":"Summary information for the structure"}},"type":"object","required":["summary"],"title":"SequenceOverview","description":"Sequence overview containing summary items"},"SequenceSummary":{"properties":{"entry":{"$ref":"#/components/schemas/Entry","description":"Entry information including sequence and checksum"},"structures":{"items":{"$ref":"#/components/schemas/SequenceOverview"},"type":"array","title":"Structures","description":"List of available structures"}},"type":"object","required":["entry","structures"],"title":"SequenceSummary","description":"Main response model for /sequence/summary endpoint"},"Template":{"properties":{"template_id":{"type":"string","title":"Template Id","description":"Identifier of the template","example":"2aqa"},"chain_id":{"type":"string","title":"Chain Id","description":"Identifier of the chain of the template; this is label_asym_id in mmCIF","example":"C"},"template_sequence_identity":{"type":"number","title":"Template Sequence Identity","description":"Sequence identity of the template with the  UniProt accession, in the range of [0,1]\n","example":0.97},"last_updated":{"type":"string","title":"Last Updated","description":"Date of release of the last update in  the format of YYYY-MM-DD\n","example":"2021-08-06"},"provider":{"type":"string","title":"Provider","description":"Provider of the template","example":"PDB"},"experimental_method":{"$ref":"#/components/schemas/ExperimentalMethod1","description":"Experimental method used to determine the template","example":"HYBRID"},"resolution":{"type":"number","title":"Resolution","description":"Resolution of the template, in Angstrom","example":2.1},"preferred_assembly_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Preferred Assembly Id","description":"Identifier of the preferred assembly of the template","example":"1"}},"type":"object","required":["template_id","chain_id","template_sequence_identity","last_updated","provider","experimental_method","resolution"],"title":"Template"},"Uniprot":{"properties":{"aligned_sequence":{"type":"string","title":"Aligned Sequence","description":"Sequence of the UniProt accession","example":"AAGTGHLKKKYTAAGTGHLKKKYT..."},"from":{"type":"integer","title":"From","description":"1-indexed first residue","example":23},"to":{"type":"integer","title":"To","description":"1-indexed last residue","example":868}},"type":"object","required":["aligned_sequence","from","to"],"title":"Uniprot"},"UniprotDetails":{"properties":{"uniprot_entry":{"anyOf":[{"$ref":"#/components/schemas/UniprotEntry"},{"type":"null"}]},"structures":{"anyOf":[{"items":{"$ref":"#/components/schemas/Detailed"},"type":"array"},{"type":"null"}],"title":"Structures"}},"type":"object","title":"UniprotDetails"},"UniprotEntry":{"properties":{"ac":{"type":"string","title":"Ac","description":"UniProt accession","example":"P00520"},"id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Id","description":"UniProt identifier","example":"ABL1_MOUSE"},"uniprot_checksum":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Uniprot Checksum","description":"CRC64 checksum of the UniProt sequence","example":"5F9BA1D4C7DE6925"},"sequence_length":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Sequence Length","description":"Length of the UniProt sequence","example":76},"segment_start":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Segment Start","description":"1-indexed first residue of the UniProt sequence segment","example":1},"segment_end":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Segment End","description":"1-indexed last residue of the UniProt sequence segment","example":86},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description","description":"Description of the UniProt entry","example":"Proto-oncogene tyrosine-protein kinase ABL1"}},"type":"object","required":["ac"],"title":"UniprotEntry"},"UniprotMapping":{"properties":{"ensembl_transcript":{"$ref":"#/components/schemas/EnsemblTranscript"},"uniprot_accession":{"$ref":"#/components/schemas/UniprotSummary"}},"type":"object","required":["ensembl_transcript","uniprot_accession"],"title":"UniprotMapping"},"UniprotSummary":{"properties":{"uniprot_entry":{"anyOf":[{"$ref":"#/components/schemas/UniprotEntry"},{"type":"null"}]},"structures":{"anyOf":[{"items":{"$ref":"#/components/schemas/Overview"},"type":"array"},{"type":"null"}],"title":"Structures"}},"type":"object","title":"UniprotSummary"},"ValidationError":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"type":"array","title":"Location"},"msg":{"type":"string","title":"Message"},"type":{"type":"string","title":"Error Type"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError"},"app__sequence__schema__ConfidenceType":{"type":"string","enum":["pLDDT","QMEANDisCo","ipTM+pTM"],"title":"ConfidenceType","description":"Confidence type enumeration"},"app__sequence__schema__Entity":{"properties":{"entity_type":{"$ref":"#/components/schemas/app__sequence__schema__EntityType","description":"Type of the molecular entity"},"entity_poly_type":{"anyOf":[{"$ref":"#/components/schemas/app__sequence__schema__EntityPolyType"},{"type":"null"}],"description":"Type of the molecular entity polymer"},"identifier":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Identifier","description":"Identifier of the molecule"},"identifier_category":{"anyOf":[{"$ref":"#/components/schemas/app__sequence__schema__IdentifierCategory"},{"type":"null"}],"description":"Category of the identifier"},"description":{"type":"string","title":"Description","description":"Textual label of the molecule"},"chain_ids":{"items":{"type":"string"},"type":"array","title":"Chain Ids","description":"List of chain identifiers of the molecule"}},"type":"object","required":["entity_type","description","chain_ids"],"title":"Entity","description":"Molecular entity in the model"},"app__sequence__schema__EntityPolyType":{"type":"string","enum":["CYCLIC-PSEUDO-PEPTIDE","PEPTIDE NUCLEIC ACID","POLYDEOXYRIBONUCLEOTIDE","POLYDEOXYRIBONUCLEOTIDE/POLYRIBONUCLEOTIDE HYBRID","POLYPEPTIDE(D)","POLYPEPTIDE(L)","POLYRIBONUCLEOTIDE","OTHER"],"title":"EntityPolyType","description":"Entity poly type enumeration"},"app__sequence__schema__EntityType":{"type":"string","enum":["BRANCHED","MACROLIDE","NON-POLYMER","POLYMER","WATER"],"title":"EntityType","description":"Entity type enumeration"},"app__sequence__schema__ExperimentalMethod":{"type":"string","enum":["ELECTRON CRYSTALLOGRAPHY","ELECTRON MICROSCOPY","EPR","FIBER DIFFRACTION","FLUORESCENCE TRANSFER","INFRARED SPECTROSCOPY","NEUTRON DIFFRACTION","X-RAY POWDER DIFFRACTION","SOLID-STATE NMR","SOLUTION NMR","X-RAY SOLUTION SCATTERING","THEORETICAL MODEL","X-RAY DIFFRACTION","HYBRID"],"title":"ExperimentalMethod","description":"Experimental method enumeration"},"app__sequence__schema__IdentifierCategory":{"type":"string","enum":["UNIPROT","RFAM","CCD","SMILES","INCHI","INCHIKEY"],"title":"IdentifierCategory","description":"Identifier category enumeration"},"app__sequence__schema__ModelCategory":{"type":"string","enum":["EXPERIMENTALLY DETERMINED","TEMPLATE-BASED","AB-INITIO","CONFORMATIONAL ENSEMBLE"],"title":"ModelCategory","description":"Model category enumeration"},"app__sequence__schema__ModelFormat":{"type":"string","enum":["PDB","MMCIF","BCIF"],"title":"ModelFormat","description":"Model format enumeration"},"app__sequence__schema__ModelType":{"type":"string","enum":["ATOMIC","DUMMY","MIX"],"title":"ModelType","description":"Model type enumeration"},"app__sequence__schema__OligomericState":{"type":"string","enum":["MONOMER","HOMODIMER","HETERODIMER","HOMO-OLIGOMER","HETERO-OLIGOMER"],"title":"OligomericState","description":"Oligomeric state enumeration"},"app__sequence__schema__SummaryItems":{"properties":{"model_identifier":{"type":"string","title":"Model Identifier","description":"Identifier of the model, such as PDB id"},"model_category":{"$ref":"#/components/schemas/app__sequence__schema__ModelCategory","description":"Category of the model"},"model_url":{"type":"string","title":"Model Url","description":"URL of the model coordinates"},"model_format":{"$ref":"#/components/schemas/app__sequence__schema__ModelFormat","description":"File format of the coordinates"},"model_type":{"anyOf":[{"$ref":"#/components/schemas/app__sequence__schema__ModelType"},{"type":"null"}],"description":"Defines if coordinates are atomic-level or contain dummy atoms"},"model_page_url":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Model Page Url","description":"URL of a web page showing the model"},"provider":{"type":"string","title":"Provider","description":"Name of the model provider"},"number_of_conformers":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Number Of Conformers","description":"Number of conformers in a conformational ensemble"},"ensemble_sample_url":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Ensemble Sample Url","description":"URL of a sample of conformations from ensemble"},"ensemble_sample_format":{"anyOf":[{"$ref":"#/components/schemas/app__sequence__schema__ModelFormat"},{"type":"null"}],"description":"File format of the sample coordinates"},"created":{"type":"string","title":"Created","description":"Date of release of model generation in the format of YYYY-MM-DD","example":"2021-12-21"},"sequence_identity":{"type":"number","maximum":1.0,"minimum":0.0,"title":"Sequence Identity","description":"Sequence identity of model to UniProt sequence"},"coverage":{"type":"number","maximum":1.0,"minimum":0.0,"title":"Coverage","description":"Fraction of UniProt sequence covered by the model"},"experimental_method":{"anyOf":[{"$ref":"#/components/schemas/app__sequence__schema__ExperimentalMethod"},{"type":"null"}],"description":"Experimental method used to determine structure"},"resolution":{"anyOf":[{"type":"number","exclusiveMinimum":0.0},{"type":"null"}],"title":"Resolution","description":"Resolution of the model in Angstrom"},"confidence_type":{"anyOf":[{"$ref":"#/components/schemas/app__sequence__schema__ConfidenceType"},{"type":"null"}],"description":"Type of confidence measure"},"confidence_version":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Confidence Version","description":"Version of confidence measure software"},"confidence_avg_local_score":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Confidence Avg Local Score","description":"Average of confidence measures"},"oligomeric_state":{"anyOf":[{"$ref":"#/components/schemas/app__sequence__schema__OligomericState"},{"type":"null"}],"description":"Oligomeric state of the model"},"oligomeric_state_confidence":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Oligomeric State Confidence","description":"Confidence in oligomeric state"},"preferred_assembly_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Preferred Assembly Id","description":"Identifier of preferred assembly"},"entities":{"items":{"$ref":"#/components/schemas/app__sequence__schema__Entity"},"type":"array","title":"Entities","description":"List of molecular entities in the model"}},"type":"object","required":["model_identifier","model_category","model_url","model_format","provider","created","sequence_identity","coverage","entities"],"title":"SummaryItems","description":"Summary items for a structure"},"app__uniprot__schema__ConfidenceType":{"type":"string","enum":["pLDDT","QMEANDisCo","ipTM+pTM"],"title":"ConfidenceType"},"app__uniprot__schema__Entity":{"properties":{"entity_type":{"$ref":"#/components/schemas/app__uniprot__schema__EntityType","description":"The type of the molecular entity; similar to _entity.type in mmCIF","example":"POLYMER"},"entity_poly_type":{"anyOf":[{"$ref":"#/components/schemas/app__uniprot__schema__EntityPolyType"},{"type":"null"}],"description":"The type of the molecular entity; similar to _entity_poly.type in mmCIF","example":"PEPTIDE NUCLEIC ACID"},"identifier":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Identifier","description":"Identifier of the molecule","example":"Q13033"},"identifier_category":{"anyOf":[{"$ref":"#/components/schemas/app__uniprot__schema__IdentifierCategory"},{"type":"null"}],"description":"Category of the identifier","example":"UNIPROT"},"description":{"type":"string","title":"Description","description":"A textual label of the molecule","example":"Striatin-3"},"chain_ids":{"items":{"type":"string"},"type":"array","title":"Chain Ids","description":"A list of label_asym identifiers ( chain_id in the case of PDB format) of the molecule","example":["A","B"]}},"type":"object","required":["entity_type","description","chain_ids"],"title":"Entity"},"app__uniprot__schema__EntityPolyType":{"type":"string","enum":["CYCLIC-PSEUDO-PEPTIDE","PEPTIDE NUCLEIC ACID","POLYDEOXYRIBONUCLEOTIDE","POLYDEOXYRIBONUCLEOTIDE/POLYRIBONUCLEOTIDE HYBRID","POLYPEPTIDE(D)","POLYPEPTIDE(L)","POLYRIBONUCLEOTIDE","OTHER"],"title":"EntityPolyType"},"app__uniprot__schema__EntityType":{"type":"string","enum":["BRANCHED","MACROLIDE","NON-POLYMER","POLYMER","WATER"],"title":"EntityType"},"app__uniprot__schema__ExperimentalMethod":{"type":"string","enum":["ELECTRON CRYSTALLOGRAPHY","ELECTRON MICROSCOPY","EPR","FIBER DIFFRACTION","FLUORESCENCE TRANSFER","INFRARED SPECTROSCOPY","NEUTRON DIFFRACTION","X-RAY POWDER DIFFRACTION","SOLID-STATE NMR","SOLUTION NMR","X-RAY SOLUTION SCATTERING","THEORETICAL MODEL","X-RAY DIFFRACTION","HYBRID"],"title":"ExperimentalMethod"},"app__uniprot__schema__IdentifierCategory":{"type":"string","enum":["UNIPROT","RFAM","CCD","SMILES","INCHI","INCHIKEY"],"title":"IdentifierCategory"},"app__uniprot__schema__ModelCategory":{"type":"string","enum":["EXPERIMENTALLY DETERMINED","TEMPLATE-BASED","AB-INITIO","CONFORMATIONAL ENSEMBLE"],"title":"ModelCategory"},"app__uniprot__schema__ModelFormat":{"type":"string","enum":["PDB","MMCIF","BCIF"],"title":"ModelFormat"},"app__uniprot__schema__ModelType":{"type":"string","enum":["ATOMIC","DUMMY","MIX"],"title":"ModelType"},"app__uniprot__schema__OligomericState":{"type":"string","enum":["MONOMER","HOMODIMER","HETERODIMER","HOMO-OLIGOMER","HETERO-OLIGOMER"],"title":"OligomericState"},"app__uniprot__schema__SummaryItems":{"properties":{"model_identifier":{"type":"string","title":"Model Identifier","description":"Identifier of the model, such as PDB id","example":"8kfa"},"model_category":{"$ref":"#/components/schemas/app__uniprot__schema__ModelCategory","description":"Category of the model","example":"TEMPLATE-BASED"},"model_url":{"type":"string","title":"Model Url","description":"URL of the model coordinates","example":"https://www.ebi.ac.uk/pdbe/static/entry/1t29_updated.cif"},"model_format":{"$ref":"#/components/schemas/app__uniprot__schema__ModelFormat","description":"File format of the coordinates","example":"MMCIF"},"model_type":{"anyOf":[{"$ref":"#/components/schemas/app__uniprot__schema__ModelType"},{"type":"null"}],"description":"Defines if the coordinates are atomic-level or contains dummy atoms (e.g. SAXS models), or a mix of both (e.g. hybrid models)\n","example":"ATOMIC"},"model_page_url":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Model Page Url","description":"URL of a web page of the data provider that show the model","example":"https://alphafold.ebi.ac.uk/entry/Q5VSL9"},"provider":{"type":"string","title":"Provider","description":"Name of the model provider","example":"SWISS-MODEL"},"number_of_conformers":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Number Of Conformers","description":"The number of conformers in a conformational ensemble","example":42},"ensemble_sample_url":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Ensemble Sample Url","description":"URL of a sample of conformations from a conformational ensemble","example":"https://proteinensemble.org/api/ensemble_sample/PED00001e001"},"ensemble_sample_format":{"anyOf":[{"$ref":"#/components/schemas/EnsembleSampleFormat"},{"type":"null"}],"description":"File format of the sample coordinates, e.g. PDB","example":"PDB"},"created":{"type":"string","title":"Created","description":"Date of release of model generation in the format of YYYY-MM-DD","example":"2021-12-21"},"sequence_identity":{"type":"number","title":"Sequence Identity","description":"Sequence identity in the range of [0,1] of the model to the UniProt sequence\n","example":0.97},"uniprot_start":{"type":"integer","title":"Uniprot Start","description":"1-indexed first residue of the model according to UniProt sequence numbering\n","example":1},"uniprot_end":{"type":"integer","title":"Uniprot End","description":"1-indexed last residue of the model according to UniProt sequence numbering\n","example":142},"coverage":{"type":"number","title":"Coverage","description":"Fraction in range of [0, 1] of the UniProt sequence covered by the model.  This is calculated as (uniprot_end - uniprot_start + 1) / uniprot_sequence_length\n","example":0.4},"experimental_method":{"anyOf":[{"$ref":"#/components/schemas/app__uniprot__schema__ExperimentalMethod"},{"type":"null"}],"description":"Experimental method used to determine the structure, if applicable"},"resolution":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Resolution","description":"The resolution of the model in Angstrom, if applicable","example":1.4},"confidence_type":{"anyOf":[{"$ref":"#/components/schemas/app__uniprot__schema__ConfidenceType"},{"type":"null"}],"description":"Type of the confidence measure. This is required for  theoretical models.\n","example":"QMEANDisCo"},"confidence_version":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Confidence Version","description":"Version of confidence measure software used to calculate quality. This is required for theoretical models.\n","example":"v1.0.2"},"confidence_avg_local_score":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Confidence Avg Local Score","description":"Average of the confidence measures in the range of [0,1] for QMEANDisCo  and [0,100] for pLDDT. Please contact 3D-Beacons developers if other  estimates are to be added. This is required for theoretical models.\n","example":0.95},"oligomeric_state":{"anyOf":[{"$ref":"#/components/schemas/app__uniprot__schema__OligomericState"},{"type":"null"}],"description":"Oligomeric state of the model","example":"MONOMER"},"oligomeric_state_confidence":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Oligomeric State Confidence","description":"Numerical value that describes the confidence in the oligomeric state of the predicted complex","example":0.4603},"preferred_assembly_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Preferred Assembly Id","description":"Identifier of the preferred assembly in the model","example":"1A"},"entities":{"items":{"$ref":"#/components/schemas/app__uniprot__schema__Entity"},"type":"array","title":"Entities","description":"A list of molecular entities in the model"}},"type":"object","required":["model_identifier","model_category","model_url","model_format","provider","created","sequence_identity","uniprot_start","uniprot_end","coverage","entities"],"title":"SummaryItems"}}}}