Forge Tools dgidb_interactions

dgidb_interactions read

scidex.forge.dgidb_interactions

Query DGIdb (Drug Gene Interaction Database) for drug-gene interactions. Aggregates curated interactions from 30+ sources including FDA drug labels, clinical trials, CIViC, ChEMBL, and PharmGKB. For each gene symbol, returns drug interactions with names, concept IDs, interaction types (inhibitor/activator/etc.), supporting sources, PubMed citation count, and FDA-approval status. REST API: https://dgidb.org/api/v2 — free, no auth required.

HTTP: POST /api/scidex/forge/dgidb_interactions

Invoke

Calls scidex.tool.invoke on the substrate with this tool name. Edit the JSON below — it must match the input schema. The substrate runs the tool, records the call in substrate_tool_calls, and returns a structured envelope.

Sign in to invoke this tool. Schema and curl snippet are visible to anyone.

Schemas

Input schema 
{
  "additionalProperties": false,
  "description": "Input schema for ``scidex.forge.dgidb_interactions``.",
  "properties": {
    "gene_symbols": {
      "description": "HGNC gene symbols to query (e.g. ``['BRAF', 'EGFR']``). DGIdb returns drug interactions where the queried gene is the target. 1–20 symbols per call.",
      "items": {
        "type": "string"
      },
      "maxItems": 20,
      "minItems": 1,
      "title": "Gene Symbols",
      "type": "array"
    },
    "interaction_types": {
      "description": "Optional filter by interaction type (e.g. ``['inhibitor', 'activator']``). Case-insensitive. Empty list returns all interaction types.",
      "items": {
        "type": "string"
      },
      "title": "Interaction Types",
      "type": "array"
    },
    "limit": {
      "default": 50,
      "description": "Maximum number of interaction records to return. Default 50.",
      "maximum": 500,
      "minimum": 1,
      "title": "Limit",
      "type": "integer"
    }
  },
  "required": [
    "gene_symbols"
  ],
  "title": "ForgeDGIdbIn",
  "type": "object"
}
Output schema 
{
  "$defs": {
    "DGIdbInteraction": {
      "description": "One DGIdb drug-gene interaction record.",
      "properties": {
        "gene_name": {
          "description": "HGNC gene symbol for the target gene.",
          "title": "Gene Name",
          "type": "string"
        },
        "drug_name": {
          "description": "Drug name as provided by DGIdb.",
          "title": "Drug Name",
          "type": "string"
        },
        "drug_concept_id": {
          "default": "",
          "description": "Drug concept identifier (e.g. 'chembl:CHEMBL25', 'ncit:C123').",
          "title": "Drug Concept Id",
          "type": "string"
        },
        "interaction_types": {
          "description": "Curated interaction types (inhibitor, activator, agonist, antagonist, etc.).",
          "items": {
            "type": "string"
          },
          "title": "Interaction Types",
          "type": "array"
        },
        "sources": {
          "description": "Source database names that evidence this interaction.",
          "items": {
            "type": "string"
          },
          "title": "Sources",
          "type": "array"
        },
        "pmid_count": {
          "default": 0,
          "description": "Number of PubMed publications supporting this interaction.",
          "title": "Pmid Count",
          "type": "integer"
        },
        "approved": {
          "default": false,
          "description": "True when the drug is FDA-approved.",
          "title": "Approved",
          "type": "boolean"
        }
      },
      "required": [
        "gene_name",
        "drug_name"
      ],
      "title": "DGIdbInteraction",
      "type": "object"
    }
  },
  "description": "Response shape for ``scidex.forge.dgidb_interactions``.",
  "properties": {
    "gene_symbols": {
      "description": "The gene symbols that were queried.",
      "items": {
        "type": "string"
      },
      "title": "Gene Symbols",
      "type": "array"
    },
    "interactions": {
      "description": "DGIdb drug-gene interaction records.",
      "items": {
        "$ref": "#/$defs/DGIdbInteraction"
      },
      "title": "Interactions",
      "type": "array"
    },
    "total_found": {
      "description": "Total interaction records found before limit was applied.",
      "title": "Total Found",
      "type": "integer"
    },
    "sources_used": {
      "description": "Unique source database names present in the returned interactions.",
      "items": {
        "type": "string"
      },
      "title": "Sources Used",
      "type": "array"
    },
    "took_ms": {
      "description": "Wall-clock time for all upstream calls.",
      "title": "Took Ms",
      "type": "integer"
    }
  },
  "required": [
    "gene_symbols",
    "total_found",
    "took_ms"
  ],
  "title": "ForgeDGIdbOut",
  "type": "object"
}

curl snippet

Replace $SCIDEX_JWT with a valid bearer token. Read verbs are usually accessible without auth in dev; production requires a JWT.

curl -sS -X POST '/api/scidex/forge/dgidb_interactions' \
  -H 'authorization: Bearer $SCIDEX_JWT' \
  -H 'content-type: application/json' \
  -d '{
  "gene_symbols": []
}'

Discussion

Posting anonymously. Sign in for attribution.

No comments yet — be the first.