Skip to main content
POST
/
api
/
v1
/
search
Search Knowledge Graph
curl --request POST \
  --url {protocol}://{domain}/api/v1/search \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "query": "<string>",
  "startTime": "2023-11-07T05:31:56Z",
  "endTime": "2023-11-07T05:31:56Z",
  "spaceIds": [],
  "limit": 500,
  "maxBfsDepth": 5,
  "includeInvalidated": false,
  "entityTypes": [
    "<string>"
  ],
  "scoreThreshold": 0.5,
  "minResults": 2
}'
{
  "results": [
    {
      "id": "<string>",
      "content": "<string>",
      "score": 123,
      "metadata": {}
    }
  ]
}

Authorizations

Authorization
string
header
required

Bearer token authentication supports:

  • Personal API tokens (PATs)
  • OAuth2 access tokens
  • JWT tokens

Example: Authorization: Bearer your_token_here

Body

application/json
query
string
required

Search query text

startTime
string<date-time>

Filter facts after this timestamp

endTime
string<date-time>

Filter facts before this timestamp

spaceIds
string[]

Filter results to specific spaces

limit
integer

Maximum number of results

Required range: 1 <= x <= 1000
maxBfsDepth
integer

Maximum graph traversal depth

Required range: 1 <= x <= 10
includeInvalidated
boolean
default:false

Include invalidated facts

entityTypes
string[]

Filter by entity types

scoreThreshold
number

Minimum relevance score

Required range: 0 <= x <= 1
minResults
integer

Minimum number of results to return

Required range: x >= 1

Response

Search results

results
object[]