Raw schema
{
"type": "object",
"properties": {
"proteins": {
"description": "One or more protein identifiers (optionally with values). Separate entries with newline (%0d). Numeric values (e.g. expression data) can be provided after identifiers.",
"examples": [
"PTEN 0.234\nSMO -3.445"
],
"type": "string"
},
"species": {
"default": null,
"description": "NCBI/STRING taxonomy ID (e.g. 9606 for human, or STRG0AXXXXX for uploaded genomes).",
"type": "string"
},
"extend_network": {
"anyOf": [
{
"minimum": 0,
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"description": "Add specified number of additional nodes to the network based on their interaction scores. Default: 0, or 10 for single-protein queries."
},
"required_score": {
"anyOf": [
{
"maximum": 1000,
"minimum": 0,
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"description": "Minimum interaction confidence score. Omit for STRING default filtering. Set only when a threshold is requested or a broader/narrower threshold is needed."
},
"network_type": {
"anyOf": [
{
"enum": [
"functional",
"physical",
"regulatory"
],
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "Omit for the default functional network. Its typed view can include physical and directed regulatory attributes when STRING returns them; inspect `physical` and `regulatory.directions` before claiming those edge types. Set physical for binding, complex, or co-complex questions. Set regulatory for directed regulatory relationships between proteins."
},
"clustering_algorithm": {
"anyOf": [
{
"enum": [
"leiden",
"MCL",
"kmeans"
],
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "Leiden identifies natural communities based on network connectivity and is the default. MCL identifies densely connected subnetworks based on connectivity flow. kmeans partitions proteins into a fixed number of clusters."
},
"clustering_parameter": {
"anyOf": [
{
"minimum": 0.1,
"type": "number"
},
{
"type": "null"
}
],
"default": null,
"description": "Controls clustering granularity. For Leiden: resolution parameter 0.1-10.0, default 1.0; higher values produce more, smaller clusters. For MCL: inflation parameter 1.0-10.0, default 3.0. For kmeans: number of clusters, integer >=2, default 3."
},
"inter_cluster_edge_visibility": {
"anyOf": [
{
"enum": [
"faded",
"dotted",
"solid",
"noshow"
],
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "How to display edges between clusters: faded, dotted, solid, or noshow. Defaults to faded."
},
"show_cluster_names": {
"anyOf": [
{
"enum": [
0,
1
],
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"description": "Show cluster names on the image.",
"examples": [
0,
1
]
},
"cluster_aware_layout": {
"anyOf": [
{
"enum": [
0,
1
],
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"description": "Lay out the network by its clusters, e.g. for a dense network.",
"examples": [
0,
1
]
},
"network_flavor": {
"anyOf": [
{
"enum": [
"evidence",
"confidence",
"typed"
],
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "Defaults are typed for functional networks, evidence for physical networks, and confidence for regulatory networks. Typed returns functional pairs with any physical and directed regulatory attributes that STRING reports; it does not make every pair physical or regulatory. Typed is available only for functional networks. Set evidence or confidence only when the user requests that edge display style."
},
"hide_disconnected_nodes": {
"anyOf": [
{
"enum": [
0,
1
],
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"description": "Hide unconnected nodes. Set only if the user asks to hide disconnected or unconnected proteins.",
"examples": [
0,
1
]
},
"center_node_labels": {
"anyOf": [
{
"enum": [
0,
1
],
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"description": "Center protein labels on nodes. Set only if the user asks to center labels.",
"examples": [
0,
1
]
}
},
"required": [
"proteins"
]
}