Forge Tools interpro_domains

interpro_domains read

scidex.forge.interpro_domains

Resolve a UniProt accession to its InterPro entries — families, domains, repeats, sites, PTMs — with contributing member databases and per-protein sequence locations. Completes the protein-annotation layer alongside scidex.forge.uniprot_lookup (symbol → accession) and scidex.forge.alphafold_structure (accession → 3D).

HTTP: POST /api/scidex/forge/interpro_domains

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.interpro_domains``.",
  "properties": {
    "accession": {
      "description": "UniProt accession (canonical form, e.g. ``P23560`` for BDNF). Upper-case alphanumerics, 6–10 characters. Gene symbols are not accepted at this verb; resolve them via ``scidex.forge.uniprot_lookup`` first.",
      "maxLength": 10,
      "minLength": 6,
      "title": "Accession",
      "type": "string"
    }
  },
  "required": [
    "accession"
  ],
  "title": "InterproDomainsIn",
  "type": "object"
}
Output schema 
{
  "$defs": {
    "InterproEntryOut": {
      "description": "One InterPro entry as returned by the verb.",
      "properties": {
        "interpro_id": {
          "description": "Stable InterPro identifier (e.g. ``IPR020635``).",
          "title": "Interpro Id",
          "type": "string"
        },
        "name": {
          "default": "",
          "description": "Human-readable entry name from InterPro curation.",
          "title": "Name",
          "type": "string"
        },
        "type": {
          "default": "",
          "description": "Entry type — ``Family``, ``Domain``, ``Repeat``, ``Site``, ``Active Site``, ``Binding Site``, ``Conserved Site``, ``Homologous Superfamily``, ``PTM``, or ``Unknown``.",
          "title": "Type",
          "type": "string"
        },
        "description": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "description": "Long-form description if InterPro ships one.",
          "title": "Description"
        },
        "member_databases": {
          "description": "Contributing member databases (``pfam``, ``smart``, ``panther``, ``prosite``, …), sorted alphabetically.",
          "items": {
            "type": "string"
          },
          "title": "Member Databases",
          "type": "array"
        },
        "locations": {
          "description": "Inclusive 1-based residue ranges the signature hits.",
          "items": {
            "$ref": "#/$defs/InterproLocationOut"
          },
          "title": "Locations",
          "type": "array"
        },
        "entry_url": {
          "default": "",
          "description": "Web URL for the InterPro entry detail page.",
          "title": "Entry Url",
          "type": "string"
        }
      },
      "required": [
        "interpro_id"
      ],
      "title": "InterproEntryOut",
      "type": "object"
    },
    "InterproLocationOut": {
      "description": "One inclusive sequence range an InterPro signature hits.",
      "properties": {
        "start": {
          "description": "1-based residue start position.",
          "title": "Start",
          "type": "integer"
        },
        "end": {
          "description": "1-based residue end position (inclusive).",
          "title": "End",
          "type": "integer"
        }
      },
      "required": [
        "start",
        "end"
      ],
      "title": "InterproLocationOut",
      "type": "object"
    }
  },
  "description": "Response shape for ``scidex.forge.interpro_domains``.",
  "properties": {
    "uniprot_accession": {
      "description": "Echo of the queried accession.",
      "title": "Uniprot Accession",
      "type": "string"
    },
    "entries": {
      "items": {
        "$ref": "#/$defs/InterproEntryOut"
      },
      "title": "Entries",
      "type": "array"
    },
    "returned": {
      "description": "Length of ``entries``.",
      "title": "Returned",
      "type": "integer"
    },
    "took_ms": {
      "description": "Wall-clock time for the upstream call.",
      "title": "Took Ms",
      "type": "integer"
    }
  },
  "required": [
    "uniprot_accession",
    "returned",
    "took_ms"
  ],
  "title": "InterproDomainsOut",
  "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/interpro_domains' \
  -H 'authorization: Bearer $SCIDEX_JWT' \
  -H 'content-type: application/json' \
  -d '{
  "accession": ""
}'

Discussion

Posting anonymously. Sign in for attribution.

No comments yet — be the first.