{"openapi":"3.1.0","info":{"title":"Apizie","version":"2.0.0","description":"One API key, one envelope, many public data sources."},"servers":[{"url":"https://zieapi.vercel.app"}],"security":[{"ApiKeyAuth":[]}],"paths":{"/v1/open-data:bridgedb/get-organism-attribute-search-query":{"get":{"operationId":"open_data_bridgedb_get_organism_attribute_search_query","summary":"Returns a list of xrefs and associated attributes that contain the query string for a given organism.…","description":"GET /{organism}/attributeSearch/{query}","tags":["open-data"],"parameters":[{"name":"organism","in":"query","required":true,"description":"Organism [Latin name](http://vocabularies.bridgedb.org/#latinName) or [short name](http://vocabularies.bridgedb.org/#shortName).","schema":{"type":"string","description":"Organism [Latin name](http://vocabularies.bridgedb.org/#latinName) or [short name](http://vocabularies.bridgedb.org/#shortName)."}},{"name":"query","in":"query","required":true,"description":"Text to find in attributes","schema":{"type":"string","description":"Text to find in attributes"}},{"name":"limit","in":"query","required":false,"description":"Number of results","schema":{"type":"integer","description":"Number of results"}},{"name":"attrName","in":"query","required":false,"description":"Restrict search by attribute name (case sensitive). Use GET /{organism}/attributeSet to find out which attributes are supported.","schema":{"type":"string","description":"Restrict search by attribute name (case sensitive). Use GET /{organism}/attributeSet to find out which attributes are supported."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/open-data:bridgedb/get-organism-attribute-set":{"get":{"operationId":"open_data_bridgedb_get_organism_attribute_set","summary":"Returns the supported attributes to the given Organism.","description":"GET /{organism}/attributeSet","tags":["open-data"],"parameters":[{"name":"organism","in":"query","required":true,"description":"Organism [Latin name](http://vocabularies.bridgedb.org/#latinName) or [short name](http://vocabularies.bridgedb.org/#shortName).","schema":{"type":"string","description":"Organism [Latin name](http://vocabularies.bridgedb.org/#latinName) or [short name](http://vocabularies.bridgedb.org/#shortName)."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/open-data:bridgedb/get-organism-attributes-system-code-identifier":{"get":{"operationId":"open_data_bridgedb_get_organism_attributes_system_code_identifier","summary":"Returns the attributes for a given identifier, data source, organism. Optionally display only a specified…","description":"GET /{organism}/attributes/{systemCode}/{identifier}","tags":["open-data"],"parameters":[{"name":"organism","in":"query","required":true,"description":"Organism [Latin name](http://vocabularies.bridgedb.org/#latinName) or [short name](http://vocabularies.bridgedb.org/#shortName).","schema":{"type":"string","description":"Organism [Latin name](http://vocabularies.bridgedb.org/#latinName) or [short name](http://vocabularies.bridgedb.org/#shortName)."}},{"name":"systemCode","in":"query","required":true,"description":"System","schema":{"type":"string","enum":["En","Cs","X","E","Rh","Ck","Eco","Cg","Ch","Il","Uc","Rf","Pd","U","Ma","Lm","Wd","Wi","Cpc","Mb","Rk","Ce","S","L","Wg","Om","T","Mc","Ik","H","Re","Ag","Q","Ca","Up","Cks"],"default":"En","description":"System"}},{"name":"identifier","in":"query","required":true,"description":"Identifier","schema":{"type":"string","default":"ENSG00000122375","description":"Identifier"}},{"name":"attrName","in":"query","required":false,"description":"Type of attribute","schema":{"type":"string","description":"Type of attribute"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/open-data:bridgedb/get-organism-is-free-search-supported":{"get":{"operationId":"open_data_bridgedb_get_organism_is_free_search_supported","summary":"Returns `true` or `false` based on whether or not /{organism}/search/{query} is supported for a given…","description":"GET /{organism}/isFreeSearchSupported","tags":["open-data"],"parameters":[{"name":"organism","in":"query","required":true,"description":"Organism [Latin name](http://vocabularies.bridgedb.org/#latinName) or [short name](http://vocabularies.bridgedb.org/#shortName).","schema":{"type":"string","description":"Organism [Latin name](http://vocabularies.bridgedb.org/#latinName) or [short name](http://vocabularies.bridgedb.org/#shortName)."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/open-data:bridgedb/get-organism-is-mapping-supported-source-system-code-target":{"get":{"operationId":"open_data_bridgedb_get_organism_is_mapping_supported_source_system_code_target","summary":"Returns `true` or `false` based on whether or not /{organism}/xrefs/{systemCode}/{identifier} would possibly…","description":"GET /{organism}/isMappingSupported/{sourceSystemCode}/{targetSystemCode}","tags":["open-data"],"parameters":[{"name":"organism","in":"query","required":true,"description":"Organism [Latin name](http://vocabularies.bridgedb.org/#latinName) or [short name](http://vocabularies.bridgedb.org/#shortName).","schema":{"type":"string","description":"Organism [Latin name](http://vocabularies.bridgedb.org/#latinName) or [short name](http://vocabularies.bridgedb.org/#shortName)."}},{"name":"sourceSystemCode","in":"query","required":true,"description":"[System code](http://vocabularies.bridgedb.org/#systemCode) for source (input/query) data source","schema":{"type":"string","enum":["En","Cs","X","E","Rh","Ck","Eco","Cg","Ch","Il","Uc","Rf","Pd","U","Ma","Lm","Wd","Wi","Cpc","Mb","Rk","Ce","S","L","Wg","Om","T","Mc","Ik","H","Re","Ag","Q","Ca","Up","Cks"],"default":"L","description":"[System code](http://vocabularies.bridgedb.org/#systemCode) for source (input/query) data source"}},{"name":"targetSystemCode","in":"query","required":true,"description":"[System code](http://vocabularies.bridgedb.org/#systemCode) for target (output/result) data source","schema":{"type":"string","enum":["En","Cs","X","E","Rh","Ck","Eco","Cg","Ch","Il","Uc","Rf","Pd","U","Ma","Lm","Wd","Wi","Cpc","Mb","Rk","Ce","S","L","Wg","Om","T","Mc","Ik","H","Re","Ag","Q","Ca","Up","Cks"],"description":"[System code](http://vocabularies.bridgedb.org/#systemCode) for target (output/result) data source"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/open-data:bridgedb/get-organism-properties":{"get":{"operationId":"open_data_bridgedb_get_organism_properties","summary":"Returns the list of properties available for a given organism","description":"GET /{organism}/properties","tags":["open-data"],"parameters":[{"name":"organism","in":"query","required":true,"description":"Organism [Latin name](http://vocabularies.bridgedb.org/#latinName) or [short name](http://vocabularies.bridgedb.org/#shortName).","schema":{"type":"string","description":"Organism [Latin name](http://vocabularies.bridgedb.org/#latinName) or [short name](http://vocabularies.bridgedb.org/#shortName)."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/open-data:bridgedb/get-organism-search-query":{"get":{"operationId":"open_data_bridgedb_get_organism_search_query","summary":"Returns a list of xrefs with identifiers that contain the query string for a given organism. Results are not…","description":"GET /{organism}/search/{query}","tags":["open-data"],"parameters":[{"name":"organism","in":"query","required":true,"description":"Organism [Latin name](http://vocabularies.bridgedb.org/#latinName) or [short name](http://vocabularies.bridgedb.org/#shortName).","schema":{"type":"string","description":"Organism [Latin name](http://vocabularies.bridgedb.org/#latinName) or [short name](http://vocabularies.bridgedb.org/#shortName)."}},{"name":"query","in":"query","required":true,"description":"Identifier query","schema":{"type":"string","default":"1234","description":"Identifier query"}},{"name":"limit","in":"query","required":false,"description":"Number of results per data source","schema":{"type":"integer","description":"Number of results per data source"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/open-data:bridgedb/get-organism-source-data-sources":{"get":{"operationId":"open_data_bridgedb_get_organism_source_data_sources","summary":"Returns a list of data sources available as xref sources for a given organism.","description":"GET /{organism}/sourceDataSources","tags":["open-data"],"parameters":[{"name":"organism","in":"query","required":true,"description":"Organism [Latin name](http://vocabularies.bridgedb.org/#latinName) or [short name](http://vocabularies.bridgedb.org/#shortName).","schema":{"type":"string","description":"Organism [Latin name](http://vocabularies.bridgedb.org/#latinName) or [short name](http://vocabularies.bridgedb.org/#shortName)."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/open-data:bridgedb/get-organism-target-data-sources":{"get":{"operationId":"open_data_bridgedb_get_organism_target_data_sources","summary":"Returns a list of data sources available as xref targets for a given organism.","description":"GET /{organism}/targetDataSources","tags":["open-data"],"parameters":[{"name":"organism","in":"query","required":true,"description":"Organism [Latin name](http://vocabularies.bridgedb.org/#latinName) or [short name](http://vocabularies.bridgedb.org/#shortName).","schema":{"type":"string","description":"Organism [Latin name](http://vocabularies.bridgedb.org/#latinName) or [short name](http://vocabularies.bridgedb.org/#shortName)."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/open-data:bridgedb/get-organism-xref-exists-system-code-identifier":{"get":{"operationId":"open_data_bridgedb_get_organism_xref_exists_system_code_identifier","summary":"Returns `true` or `false` based on whether or not an xref exists in the database given an identifier, data…","description":"GET /{organism}/xrefExists/{systemCode}/{identifier}","tags":["open-data"],"parameters":[{"name":"organism","in":"query","required":true,"description":"Organism [Latin name](http://vocabularies.bridgedb.org/#latinName) or [short name](http://vocabularies.bridgedb.org/#shortName).","schema":{"type":"string","description":"Organism [Latin name](http://vocabularies.bridgedb.org/#latinName) or [short name](http://vocabularies.bridgedb.org/#shortName)."}},{"name":"systemCode","in":"query","required":true,"description":"Source (input) data source [system code](https://bridgedb.github.io/pages/system-codes.html)","schema":{"type":"string","enum":["En","Cs","X","E","Rh","Ck","Eco","Cg","Ch","Il","Uc","Rf","Pd","U","Ma","Lm","Wd","Wi","Cpc","Mb","Rk","Ce","S","L","Wg","Om","T","Mc","Ik","H","Re","Ag","Q","Ca","Up","Cks"],"default":"L","description":"Source (input) data source [system code](https://bridgedb.github.io/pages/system-codes.html)"}},{"name":"identifier","in":"query","required":true,"description":"Identifier","schema":{"type":"string","default":"1234","description":"Identifier"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/open-data:bridgedb/get-organism-xrefs-system-code-identifier":{"get":{"operationId":"open_data_bridgedb_get_organism_xrefs_system_code_identifier","summary":"Returns a list of xrefs that map to a given identifier, data source, and organism.","description":"GET /{organism}/xrefs/{systemCode}/{identifier}","tags":["open-data"],"parameters":[{"name":"dataSource","in":"query","required":false,"description":"(Optional) Restrict results by data source [system code](https://bridgedb.github.io/pages/system-codes.html)","schema":{"type":"string","enum":["En","Cs","X","E","Rh","Ck","Eco","Cg","Ch","Il","Uc","Rf","Pd","U","Ma","Lm","Wd","Wi","Cpc","Mb","Rk","Ce","S","L","Wg","Om","T","Mc","Ik","H","Re","Ag","Q","Ca","Up","Cks"],"description":"(Optional) Restrict results by data source [system code](https://bridgedb.github.io/pages/system-codes.html)"}},{"name":"organism","in":"query","required":true,"description":"Organism [Latin name](http://vocabularies.bridgedb.org/#latinName) or [short name](http://vocabularies.bridgedb.org/#shortName).","schema":{"type":"string","description":"Organism [Latin name](http://vocabularies.bridgedb.org/#latinName) or [short name](http://vocabularies.bridgedb.org/#shortName)."}},{"name":"systemCode","in":"query","required":true,"description":"Source (input) data source [system code](https://bridgedb.github.io/pages/system-codes.html)","schema":{"type":"string","enum":["En","Cs","X","E","Rh","Ck","Eco","Cg","Ch","Il","Uc","Rf","Pd","U","Ma","Lm","Wd","Wi","Cpc","Mb","Rk","Ce","S","L","Wg","Om","T","Mc","Ik","H","Re","Ag","Q","Ca","Up","Cks"],"default":"L","description":"Source (input) data source [system code](https://bridgedb.github.io/pages/system-codes.html)"}},{"name":"identifier","in":"query","required":true,"description":"Identifier","schema":{"type":"string","default":"1234","description":"Identifier"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/open-data:bridgedb/post-organism-xrefs-batch":{"post":{"operationId":"open_data_bridgedb_post_organism_xrefs_batch","summary":"Returns a list of xrefs, per identifier, that maps to a given list of identifiers an data source given an…","description":"POST /{organism}/xrefsBatch","tags":["open-data"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["organism"],"properties":{"dataSource":{"type":"string","enum":["En","Cs","X","E","Rh","Ck","Eco","Cg","Ch","Il","Uc","Rf","Pd","U","Ma","Lm","Wd","Wi","Cpc","Mb","Rk","Ce","S","L","Wg","Om","T","Mc","Ik","H","Re","Ag","Q","Ca","Up","Cks"],"description":"(Optional) Restrict results by data source [system code](https://bridgedb.github.io/pages/system-codes.html)"},"organism":{"type":"string","description":"Organism [Latin name](http://vocabularies.bridgedb.org/#latinName) or [short name](http://vocabularies.bridgedb.org/#shortName)."}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/open-data:bridgedb/post-organism-xrefs-batch-system-code":{"post":{"operationId":"open_data_bridgedb_post_organism_xrefs_batch_system_code","summary":"Returns a list of xrefs, that maps to a given list of identifiers to a given data source and organism.","description":"POST /{organism}/xrefsBatch/{systemCode}","tags":["open-data"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["organism","systemCode"],"properties":{"dataSource":{"type":"string","enum":["En","Cs","X","E","Rh","Ck","Eco","Cg","Ch","Il","Uc","Rf","Pd","U","Ma","Lm","Wd","Wi","Cpc","Mb","Rk","Ce","S","L","Wg","Om","T","Mc","Ik","H","Re","Ag","Q","Ca","Up","Cks"],"description":"(Optional) Restrict results by data source [system code](https://bridgedb.github.io/pages/system-codes.html)"},"organism":{"type":"string","description":"Organism [Latin name](http://vocabularies.bridgedb.org/#latinName) or [short name](http://vocabularies.bridgedb.org/#shortName)."},"systemCode":{"type":"string","enum":["En","Cs","X","E","Rh","Ck","Eco","Cg","Ch","Il","Uc","Rf","Pd","U","Ma","Lm","Wd","Wi","Cpc","Mb","Rk","Ce","S","L","Wg","Om","T","Mc","Ik","H","Re","Ag","Q","Ca","Up","Cks"],"default":"L","description":"Source (input) data source [system code](http://vocabularies.bridgedb.org/#systemCode)"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}}},"components":{"securitySchemes":{"ApiKeyAuth":{"type":"apiKey","in":"header","name":"x-api-key"}},"schemas":{"RunEnvelope":{"type":"object","required":["project","data","timestamp"],"properties":{"project":{"type":"string","example":"dev-tools:hash"},"data":{},"timestamp":{"type":"string","format":"date-time"}}},"ErrorEnvelope":{"type":"object","properties":{"content":{},"message":{"type":"string"},"errors":{"type":"array","items":{}},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"}}}}}},"responses":{"Error":{"description":"Invalid key, plan gate, rate limit or upstream failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}}}}