{"openapi":"3.1.0","info":{"title":"BioGRID (BYOK) API","version":"0.1.0","description":"BioGRID (BYOK) lets an AI assistant read your own BioGRID data through the BioGRID API with a key you supply (BioGRID access key). Read-only: 8 tools (get_interaction, search_interactions_by_gene, search_interactions_by_gene_id_type, search_interactions_by_publication, list_interactions, list_organisms, list_identifier_types, list_evidence_types). The BYOK key travels with each request, is used...\n\nEvery operation is read-only or compute-only. The same tools are available over MCP (streamable HTTP) at https://byok-biogrid.connectorbay.com/mcp.","contact":{"name":"Unify Dynamics LLC","email":"agent@connectorbay.com","url":"https://connectorbay.com/byok-biogrid/docs"},"termsOfService":"https://connectorbay.com/byok-biogrid/terms"},"servers":[{"url":"https://byok-biogrid.connectorbay.com"}],"externalDocs":{"url":"https://connectorbay.com/byok-biogrid/docs"},"security":[{"upstreamKey":[]}],"components":{"securitySchemes":{"bearer":{"type":"http","scheme":"bearer","description":"Optional. A Pro API key raises rate limits; no credentials are required."},"upstreamKey":{"type":"apiKey","in":"header","name":"X-Upstream-Key","description":"Your own key for the service this connector wraps (bring your own key). Used for that one call only; never stored, logged or cached."}},"schemas":{"Error":{"type":"object","properties":{"ok":{"const":false},"error":{"type":"object"}}}}},"paths":{"/v1/tools/get_interaction":{"post":{"operationId":"get_interaction","summary":"Get one curated interaction by its BioGRID interaction id, with the interactors, experimental system, publication and th","description":"Get one curated interaction by its BioGRID interaction id, with the interactors, experimental system, publication and throughput. Use for \"Show BioGRID interaction 103\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"interaction_id":{"description":"The numeric BioGRID interaction id, for example 103.","title":"Interaction Id","type":"integer"},"format":{"anyOf":[{"enum":["json","jsonExtended"],"type":"string"},{"type":"null"}],"default":"json","description":"Answer detail: json (standard fields) or jsonExtended (adds source database identifiers, interactions per publication and additional identifiers).","title":"Format"}},"required":["interaction_id"],"title":"get_interactionArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/search_interactions_by_gene":{"post":{"operationId":"search_interactions_by_gene","summary":"Find interactions for one or more genes (official symbol, synonym or id) in chosen organisms; can include first-order in","description":"Find interactions for one or more genes (official symbol, synonym or id) in chosen organisms; can include first-order interactors. Use for \"What does BioGRID list as interactors of human MDM2\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"gene_list":{"description":"Pipe-separated gene names or ids, for example 'MDM2' or 'cdc27|apc1|apc2'.","maxLength":300,"title":"Gene List","type":"string"},"search_names":{"anyOf":[{"type":"boolean"},{"type":"null"}],"default":true,"description":"True to match gene_list against official symbols.","title":"Search Names"},"search_synonyms":{"anyOf":[{"type":"boolean"},{"type":"null"}],"default":false,"description":"True to also match gene_list against synonyms.","title":"Search Synonyms"},"search_ids":{"anyOf":[{"type":"boolean"},{"type":"null"}],"default":false,"description":"True to match Entrez gene ids, ordered locus and systematic names.","title":"Search Ids"},"include_interactors":{"anyOf":[{"type":"boolean"},{"type":"null"}],"default":true,"description":"True to include interactions with only one gene on the list (first-order interactors).","title":"Include Interactors"},"tax_id":{"anyOf":[{"maxLength":100,"type":"string"},{"type":"null"}],"default":"All","description":"Pipe-separated NCBI taxonomy ids to search in, for example '9606' for human or '9606|10090'; 'All' for every organism.","title":"Tax Id"},"throughput_tag":{"anyOf":[{"enum":["any","low","high"],"type":"string"},{"type":"null"}],"default":"any","description":"Keep only low-throughput or high-throughput evidence, or any.","title":"Throughput Tag"},"inter_species_excluded":{"anyOf":[{"type":"boolean"},{"type":"null"}],"default":false,"description":"True to drop interactions between different species.","title":"Inter Species Excluded"},"start":{"anyOf":[{"maximum":2147483647,"minimum":0,"type":"integer"},{"type":"null"}],"default":0,"description":"How many interactions to skip, for paging (0 for the first).","title":"Start"},"max":{"anyOf":[{"maximum":100,"minimum":1,"type":"integer"},{"type":"null"}],"default":25,"description":"How many interactions to return (1 to 100, default 25).","title":"Max"},"format":{"anyOf":[{"enum":["json","jsonExtended"],"type":"string"},{"type":"null"}],"default":"json","description":"Answer detail: json (standard fields) or jsonExtended (adds source database identifiers, interactions per publication and additional identifiers).","title":"Format"}},"required":["gene_list"],"title":"search_interactions_by_geneArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/search_interactions_by_gene_id_type":{"post":{"operationId":"search_interactions_by_gene_id_type","summary":"Find interactions for genes given by an identifier type such as UNIPROT, REFSEQ, ENSEMBL or SGD instead of gene names. U","description":"Find interactions for genes given by an identifier type such as UNIPROT, REFSEQ, ENSEMBL or SGD instead of gene names. Use for \"Which interactions involve RefSeq proteins NP_001119587 and NP_002383 in BioGRID\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"gene_list":{"description":"Pipe-separated identifiers of the chosen type, for example 'NP_001119587|NP_002383'.","maxLength":300,"title":"Gene List","type":"string"},"identifier_types":{"description":"Pipe-separated identifier type names from list_identifier_types, for example 'REFSEQ' or 'UNIPROT'.","maxLength":100,"title":"Identifier Types","type":"string"},"include_interactors":{"anyOf":[{"type":"boolean"},{"type":"null"}],"default":true,"description":"True to include interactions with only one gene on the list.","title":"Include Interactors"},"tax_id":{"anyOf":[{"maxLength":100,"type":"string"},{"type":"null"}],"default":"All","description":"Pipe-separated NCBI taxonomy ids to search in, for example '9606' for human or '9606|10090'; 'All' for every organism.","title":"Tax Id"},"start":{"anyOf":[{"maximum":2147483647,"minimum":0,"type":"integer"},{"type":"null"}],"default":0,"description":"How many interactions to skip, for paging (0 for the first).","title":"Start"},"max":{"anyOf":[{"maximum":100,"minimum":1,"type":"integer"},{"type":"null"}],"default":25,"description":"How many interactions to return (1 to 100, default 25).","title":"Max"},"format":{"anyOf":[{"enum":["json","jsonExtended"],"type":"string"},{"type":"null"}],"default":"json","description":"Answer detail: json (standard fields) or jsonExtended (adds source database identifiers, interactions per publication and additional identifiers).","title":"Format"}},"required":["gene_list","identifier_types"],"title":"search_interactions_by_gene_id_typeArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/search_interactions_by_publication":{"post":{"operationId":"search_interactions_by_publication","summary":"List interactions curated from given PubMed ids. Use for \"Which interactions were curated from PubMed 18316726 in BioGRI","description":"List interactions curated from given PubMed ids. Use for \"Which interactions were curated from PubMed 18316726 in BioGRID\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"pubmed_list":{"description":"Pipe-separated PubMed ids, for example '18316726|17662948'.","maxLength":300,"title":"Pubmed List","type":"string"},"start":{"anyOf":[{"maximum":2147483647,"minimum":0,"type":"integer"},{"type":"null"}],"default":0,"description":"How many interactions to skip, for paging (0 for the first).","title":"Start"},"max":{"anyOf":[{"maximum":100,"minimum":1,"type":"integer"},{"type":"null"}],"default":25,"description":"How many interactions to return (1 to 100, default 25).","title":"Max"},"format":{"anyOf":[{"enum":["json","jsonExtended"],"type":"string"},{"type":"null"}],"default":"json","description":"Answer detail: json (standard fields) or jsonExtended (adds source database identifiers, interactions per publication and additional identifiers).","title":"Format"}},"required":["pubmed_list"],"title":"search_interactions_by_publicationArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/list_interactions":{"post":{"operationId":"list_interactions","summary":"List BioGRID interactions in id order with optional organism, throughput and evidence filters, for browsing or paging. U","description":"List BioGRID interactions in id order with optional organism, throughput and evidence filters, for browsing or paging. Use for \"Show some low-throughput human interactions from BioGRID\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"tax_id":{"anyOf":[{"maxLength":100,"type":"string"},{"type":"null"}],"default":"All","description":"Pipe-separated NCBI taxonomy ids to search in, for example '9606' for human or '9606|10090'; 'All' for every organism.","title":"Tax Id"},"throughput_tag":{"anyOf":[{"enum":["any","low","high"],"type":"string"},{"type":"null"}],"default":"any","description":"Keep only low-throughput or high-throughput evidence, or any.","title":"Throughput Tag"},"evidence_list":{"anyOf":[{"maxLength":300,"type":"string"},{"type":"null"}],"default":null,"description":"Pipe-separated experimental system names to exclude (or include with include_evidence), for example 'Two-hybrid'.","title":"Evidence List"},"include_evidence":{"anyOf":[{"type":"boolean"},{"type":"null"}],"default":false,"description":"True to keep only the evidence in evidence_list instead of excluding it.","title":"Include Evidence"},"self_interactions_excluded":{"anyOf":[{"type":"boolean"},{"type":"null"}],"default":false,"description":"True to drop interactions with a single interactor.","title":"Self Interactions Excluded"},"start":{"anyOf":[{"maximum":2147483647,"minimum":0,"type":"integer"},{"type":"null"}],"default":0,"description":"How many interactions to skip, for paging (0 for the first).","title":"Start"},"max":{"anyOf":[{"maximum":100,"minimum":1,"type":"integer"},{"type":"null"}],"default":25,"description":"How many interactions to return (1 to 100, default 25).","title":"Max"},"format":{"anyOf":[{"enum":["json","jsonExtended"],"type":"string"},{"type":"null"}],"default":"json","description":"Answer detail: json (standard fields) or jsonExtended (adds source database identifiers, interactions per publication and additional identifiers).","title":"Format"}},"title":"list_interactionsArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/list_organisms":{"post":{"operationId":"list_organisms","summary":"List the organisms BioGRID supports with their NCBI taxonomy ids, for use in tax_id filters. Use for \"What organisms doe","description":"List the organisms BioGRID supports with their NCBI taxonomy ids, for use in tax_id filters. Use for \"What organisms does BioGRID cover\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"format":{"anyOf":[{"const":"json","type":"string"},{"type":"null"}],"default":"json","description":"Only json is offered here.","title":"Format"}},"title":"list_organismsArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/list_identifier_types":{"post":{"operationId":"list_identifier_types","summary":"List the additional gene identifier type names BioGRID can match (UNIPROT, REFSEQ, ENSEMBL and others). Use for \"Which i","description":"List the additional gene identifier type names BioGRID can match (UNIPROT, REFSEQ, ENSEMBL and others). Use for \"Which identifier types can I search BioGRID by\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"format":{"anyOf":[{"const":"json","type":"string"},{"type":"null"}],"default":"json","description":"Only json is offered here.","title":"Format"}},"title":"list_identifier_typesArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/list_evidence_types":{"post":{"operationId":"list_evidence_types","summary":"List the experimental evidence names (experimental systems) recorded in BioGRID, for use in evidence_list. Use for \"What","description":"List the experimental evidence names (experimental systems) recorded in BioGRID, for use in evidence_list. Use for \"What experimental systems does BioGRID record\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"format":{"anyOf":[{"const":"json","type":"string"},{"type":"null"}],"default":"json","description":"Only json is offered here.","title":"Format"}},"title":"list_evidence_typesArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}}}}