Rumor

GET/api/v1/rumor/graphs

List_graphs

Authorization

bearer_token

AuthorizationBearer <token>

In: header

Query Parameters

page?integer

1-indexed page number.

Formatint64

Range0 <= value

page_size?integer

Page size.

Formatint64

Range0 <= value

sort_by?string

Sort field (created_at, node_count, edge_count).

sort_order?string

Sort order (asc or desc).

Value in

"asc"
"desc"

Response Body

`application/json`

curl -X GET "https://example.com/api/v1/rumor/graphs"

{  "graphs": [    {      "created_at": "2019-08-24T14:15:22Z",      "created_by": "string",      "defaults": {        "edge_bandwidth": 0,        "edge_fidelity": 0.1,        "edge_latency_seconds": 0      },      "deterministic": {        "enabled": true,        "seed": 0      },      "distortion": {        "arbiter_paraphrase": true,        "mode": "mutation_table",        "table_id": "string"      },      "edge_count": 0,      "forgetting": {        "default_ttl_seconds": 0,        "reinforcement_extends": true      },      "graph_id": "string",      "node_count": 0,      "updated_at": "2019-08-24T14:15:22Z"    }  ],  "pagination": {    "has_more": true,    "page": 0,    "page_size": 0,    "total": 0  }}

POST/api/v1/rumor/graphs

Create_graph

Authorization

bearer_token

AuthorizationBearer <token>

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Create a propagation graph.

defaults?null|

deterministic?null|

distortion?null|

forgetting?null|

graph_id?|

Human-friendly graph identifier (defaults to a generated id when omitted).

Response Body

`application/json`

curl -X POST "https://example.com/api/v1/rumor/graphs" \  -H "Content-Type: application/json" \  -d '{}'

{  "created_at": "2019-08-24T14:15:22Z",  "created_by": "string",  "defaults": {    "edge_bandwidth": 0,    "edge_fidelity": 0.1,    "edge_latency_seconds": 0  },  "deterministic": {    "enabled": true,    "seed": 0  },  "distortion": {    "arbiter_paraphrase": true,    "mode": "mutation_table",    "table_id": "string"  },  "edge_count": 0,  "forgetting": {    "default_ttl_seconds": 0,    "reinforcement_extends": true  },  "graph_id": "string",  "node_count": 0,  "updated_at": "2019-08-24T14:15:22Z"}

GET/api/v1/rumor/graphs/{graph_id}

Get_graph

Authorization

bearer_token

AuthorizationBearer <token>

In: header

Path Parameters

graph_id*string

Response Body

`application/json`

curl -X GET "https://example.com/api/v1/rumor/graphs/string"

{  "created_at": "2019-08-24T14:15:22Z",  "created_by": "string",  "defaults": {    "edge_bandwidth": 0,    "edge_fidelity": 0.1,    "edge_latency_seconds": 0  },  "deterministic": {    "enabled": true,    "seed": 0  },  "distortion": {    "arbiter_paraphrase": true,    "mode": "mutation_table",    "table_id": "string"  },  "edge_count": 0,  "forgetting": {    "default_ttl_seconds": 0,    "reinforcement_extends": true  },  "graph_id": "string",  "node_count": 0,  "updated_at": "2019-08-24T14:15:22Z"}

POST/api/v1/rumor/graphs/{graph_id}/correct

Correct_fact

Authorization

bearer_token

AuthorizationBearer <token>

In: header

Path Parameters

graph_id*string

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Inject a correction that chases a target fact through the same graph.

fact_id*string

The fact id to correct.

origin_node*string

Origin node from which the correction is seeded.

payload*unknown

Corrected payload to propagate.

Response Body

`application/json`

curl -X POST "https://example.com/api/v1/rumor/graphs/string/correct" \  -H "Content-Type: application/json" \  -d '{    "fact_id": "string",    "origin_node": "string",    "payload": null  }'

{  "beliefs_corrected": 0,  "fact_id": "string",  "graph_id": "string",  "original_footprint": 0}

POST/api/v1/rumor/graphs/{graph_id}/edges

Add_edges

Authorization

bearer_token

AuthorizationBearer <token>

In: header

Path Parameters

graph_id*string

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Add one or more directed edges to a graph (bulk import supported).

edges*array<>

Edges to add.

Response Body

`application/json`

curl -X POST "https://example.com/api/v1/rumor/graphs/string/edges" \  -H "Content-Type: application/json" \  -d '{    "edges": [      {        "from": "string",        "to": "string"      }    ]  }'

{  "added": 0,  "edge_count": 0,  "graph_id": "string"}

GET/api/v1/rumor/graphs/{graph_id}/facts/{fact_id}/trace

Trace_fact

Authorization

bearer_token

AuthorizationBearer <token>

In: header

Path Parameters

graph_id*string

fact_id*string

Response Body

`application/json`

curl -X GET "https://example.com/api/v1/rumor/graphs/string/facts/string/trace"

{  "fact_id": "string",  "graph_id": "string",  "injected_at": "2019-08-24T14:15:22Z",  "nodes": [    {      "corrected": true,      "fidelity_remaining": 0.1,      "form": null,      "node_id": "string",      "received_via": [        "string"      ]    }  ],  "origin_node": "string",  "prevalence": {    "corrected": 0,    "distorted": 0,    "total_known": 0,    "true_form": 0  },  "propagation": [    {      "corrected": true,      "fidelity_remaining": 0.1,      "from_node": "string",      "hop": 0,      "mutated": true,      "received_at": "2019-08-24T14:15:22Z",      "to_node": "string"    }  ],  "topic": "string"}

POST/api/v1/rumor/graphs/{graph_id}/inject

Inject_fact

Authorization

bearer_token

AuthorizationBearer <token>

In: header

Path Parameters

graph_id*string

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Inject a fact at an origin node.

fact_id?|

Optional explicit fact id (defaults to a generated id).

origin_node*string

Origin node id where the fact is injected.

payload*unknown

Structured fact payload.

topic*string

Topic the fact concerns.

truth_value*boolean

Whether the fact is true.

Response Body

`application/json`

curl -X POST "https://example.com/api/v1/rumor/graphs/string/inject" \  -H "Content-Type: application/json" \  -d '{    "origin_node": "string",    "payload": null,    "topic": "string",    "truth_value": true  }'

{  "beliefs_recorded": 0,  "fact_id": "string",  "first_hops": [    {      "scheduled_at": "2019-08-24T14:15:22Z",      "to_node": "string"    }  ],  "graph_id": "string",  "injected_at": "2019-08-24T14:15:22Z",  "origin_node": "string",  "topic": "string"}

POST/api/v1/rumor/graphs/{graph_id}/nodes

Add_nodes

Authorization

bearer_token

AuthorizationBearer <token>

In: header

Path Parameters

graph_id*string

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Add one or more nodes to a graph (bulk import supported).

nodes*array<>

Nodes to add.

Response Body

`application/json`

curl -X POST "https://example.com/api/v1/rumor/graphs/string/nodes" \  -H "Content-Type: application/json" \  -d '{    "nodes": [      {        "id": "string"      }    ]  }'

{  "added": 0,  "graph_id": "string",  "node_count": 0}

GET/api/v1/rumor/graphs/{graph_id}/nodes/{node}/beliefs

Get_beliefs

Authorization

bearer_token

AuthorizationBearer <token>

In: header

Path Parameters

graph_id*string

node*string

Query Parameters

topic?string

Topic to filter beliefs by.

Response Body

`application/json`

curl -X GET "https://example.com/api/v1/rumor/graphs/string/nodes/string/beliefs"

{  "beliefs": [    {      "confidence": 0.1,      "corrected": true,      "expires_at": "2019-08-24T14:15:22Z",      "fact_id": "string",      "fidelity_remaining": 0.1,      "form": null,      "node_id": "string",      "received_at": "2019-08-24T14:15:22Z",      "received_via": [        "string"      ],      "topic": "string",      "truth_value": true    }  ],  "count": 0,  "node_id": "string"}

POST/api/v1/rumor/graphs/{graph_id}/nodes/{node}/quarantine

Quarantine_node

Authorization

bearer_token

AuthorizationBearer <token>

In: header

Path Parameters

graph_id*string

node*string

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Quarantine or release a node.

quarantined*boolean

Whether the node should be quarantined (true) or released (false).

Response Body

`application/json`

curl -X POST "https://example.com/api/v1/rumor/graphs/string/nodes/string/quarantine" \  -H "Content-Type: application/json" \  -d '{    "quarantined": true  }'

{  "graph_id": "string",  "node_id": "string",  "quarantined": true}

POST/api/v1/rumor/graphs/{graph_id}/subscribe

Authorization

bearer_token

AuthorizationBearer <token>

In: header

Path Parameters

graph_id*string

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Provision fanout for belief-change events.

node?|

Restrict the subscription to a single node id.

topic?|

Restrict the subscription to a single topic.

webhook_url?|

Deliver matching belief-change events to this webhook URL (http/https).

Response Body

`application/json`

curl -X POST "https://example.com/api/v1/rumor/graphs/string/subscribe" \  -H "Content-Type: application/json" \  -d '{}'

{  "channel": "string",  "graph_id": "string",  "node": "string",  "subscription_id": "string",  "topic": "string",  "webhook_url": "string"}

POST/api/v1/rumor/graphs/{graph_id}/tick

Tick

Authorization

bearer_token

AuthorizationBearer <token>

In: header

Path Parameters

graph_id*string

Response Body

`application/json`

curl -X POST "https://example.com/api/v1/rumor/graphs/string/tick"

{  "beliefs_recorded": 0,  "graph_id": "string",  "hops_processed": 0,  "hops_scheduled": 0}

Rumor

200application/json

201application/json

400

403

409

200application/json

404

200application/json

400

403

404

201application/json

400

403

404

200application/json

404

201application/json

400

403

404

201application/json

400

403

404

409

200application/json

404

200application/json

403

404

200application/json

400

404

200application/json

403

404

On this page

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`