Skip to main content
POST
/
api
/
v1
/
search
Error
A valid request URL is required to generate request examples
{
  "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

​
labelIds
string[]

Filter results to specific labels

​
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[]