Search

GET

https://api.flockx.io/api/v1/knowledge/:id/search

GET

/api/v1/knowledge/:id/search

1 curl https://api.flockx.io/api/v1/knowledge/id/search

Try it

200Retrieved

1 {
2   "total_nodes": 1,
3   "total_edges": 1,
4   "nodes": [
5     {
6       "uuid": "uuid",
7       "name": "name",
8       "summary": "summary",
9       "labels": [
10         "labels",
11         "labels"
12       ],
13       "created_at": "created_at"
14     },
15     {
16       "uuid": "uuid",
17       "name": "name",
18       "summary": "summary",
19       "labels": [
20         "labels",
21         "labels"
22       ],
23       "created_at": "created_at"
24     }
25   ],
26   "edges": [
27     {
28       "uuid": "uuid",
29       "fact": "fact",
30       "source_node_uuid": "source_node_uuid",
31       "target_node_uuid": "target_node_uuid",
32       "name": "name",
33       "created_at": "created_at",
34       "valid_at": "valid_at"
35     },
36     {
37       "uuid": "uuid",
38       "fact": "fact",
39       "source_node_uuid": "source_node_uuid",
40       "target_node_uuid": "target_node_uuid",
41       "name": "name",
42       "created_at": "created_at",
43       "valid_at": "valid_at"
44     }
45   ]
46 }

Search the specified knowledge graph for facts (nodes and edges) based on an optional query.

Path parameters

idstringRequiredformat: "uuid"

Query parameters

querystringOptionalDefaults to *

Search query to filter nodes and edges of the graph.

limitintegerOptional>=1<=50Defaults to 10

Maximum number of results per result.

Response

Successful Response

total_nodesinteger

total_edgesinteger

nodeslist of objects

edgeslist of objects