Skip to main content
POST
/
api
/
search
curl --request POST \
  --url https://neode.ai/api/search \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "query": "electric vehicle companies",
  "types": [
    "entities",
    "triples"
  ],
  "limit": 20
}
'
{
  "success": true,
  "data": {
    "entities": [
      {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "name": "<string>",
        "description": "<string>",
        "avatar_url": "<string>",
        "index_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "index_name": "<string>",
        "created_at": "2023-11-07T05:31:56Z",
        "updated_at": "2023-11-07T05:31:56Z",
        "similarity": 123,
        "triple_count": 123
      }
    ],
    "triples": [
      {
        "subject": "<string>",
        "predicate": "<string>",
        "object": "<string>",
        "object_type": "literal",
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "confidence": 0.5,
        "source": "<string>",
        "graph_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "index_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "subject_entity_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "object_entity_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "created_at": "2023-11-07T05:31:56Z",
        "similarity": 123
      }
    ],
    "graphs": [
      {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "name": "<string>",
        "description": "<string>",
        "index_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "metadata": {},
        "triple_count": 123,
        "created_at": "2023-11-07T05:31:56Z",
        "updated_at": "2023-11-07T05:31:56Z",
        "similarity": 123
      }
    ]
  },
  "count": {
    "entities": 123,
    "triples": 123,
    "graphs": 123
  }
}

Authorizations

​
Authorization
string
header
required

API key for authentication

Body

application/json

Request for semantic search across the knowledge graph

​
query
string
required

Natural language search query

​
types
enum<string>[]

Types of objects to search

Available options:
entities,
triples,
graphs
​
index_id
string<uuid>

Filter results to a specific index

​
limit
integer
default:20

Maximum results per type

Required range: 1 <= x <= 100
​
threshold
number
default:0.3

Minimum similarity score (0-1)

Required range: 0 <= x <= 1

Response

Search results

​
success
boolean
​
data
object
​
count
object