Skip to main content
POST
/
projects
/
{project_reference}
/
knowledge
/
lookup
Lookup Project Knowledge
curl --request POST \
  --url https://api.veryfront.com/projects/{project_reference}/knowledge/lookup \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "query": "<string>",
  "cursor": "<string>",
  "limit": 6,
  "shard_count": 4,
  "shard_index": 1
}
'
{
  "query": "<string>",
  "mode": "search",
  "data": [
    {
      "path": "<string>",
      "matched_fields": [
        "<string>"
      ],
      "frontmatter": [
        {
          "key": "<string>",
          "value": "<string>"
        }
      ]
    }
  ],
  "page_info": {
    "self": "<string>",
    "first": null,
    "next": "<string>",
    "prev": "<string>"
  },
  "returned": 1,
  "total_matches": 1,
  "shard": {
    "shard_index": 1,
    "shard_count": 2,
    "total_items": 1
  }
}

Authorizations

Authorization
string
header
required

Authentication via JWT token or API key. JWT: Get from Veryfront dashboard. API Key: Format "vf__" - create via /api-keys endpoint.

Path Parameters

project_reference
string
required

Project ID or slug

Body

application/json
query
string
Required string length: 1 - 500
cursor
string
Required string length: 1 - 13334
lookup_target
object
limit
integer
Required range: 1 <= x <= 12
shard_count
integer
Required range: 1 <= x <= 8
shard_index
integer
Required range: x >= 0

Response

Knowledge lookup results

query
string
required
mode
enum<string>
required
Available options:
search,
browse
data
object[]
required
page_info
object
required
returned
integer
required
Required range: x >= 0
total_matches
integer
required
Required range: x >= 0
shard
object
required