Skip to main content
POST
/
search
Search Query
curl --request POST \
  --url https://api.example.com/search \
  --header 'Content-Type: application/json' \
  --data '
{
  "query": "<string>"
}
'
{
  "success": true,
  "org_id": "<string>",
  "mode": "sql_only",
  "user_id": "<string>",
  "source": "<string>",
  "processing_time_ms": 123
}

Body

application/json

Search query request.

​
query
string
required

Search query string

Minimum string length: 1

Response

Successful Response

Search query response.

​
success
boolean
required

Whether the search was successful

​
org_id
string
required

Organization ID

​
mode
enum<string>
required

Search mode used

Available options:
sql_only,
full
​
user_id
string
required

User ID who performed the search

​
source
string | null

Source of the result

​
processing_time_ms
number | null

Processing time in milliseconds