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
  }
}

Documentation Index

Fetch the complete documentation index at: https://veryfront.com/docs/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

Authorization
string
header
required

Use a JWT bearer token or a Veryfront API key in the Authorization header.

Path Parameters

project_reference
string
required

Project ID or slug.

Body

application/json
query
string

Search query or free-form prompt for the tool.

Required string length: 1 - 500
cursor
string

Opaque pagination cursor returned by a previous response.

Required string length: 1 - 13334
lookup_target
object

Provide the lookup target.

limit
integer

Maximum number of results to return.

Required range: 1 <= x <= 12
shard_count
integer

Provide the shard count.

Required range: 1 <= x <= 8
shard_index
integer

Provide the shard index.

Required range: x >= 0

Response

Knowledge lookup results.

query
string
required

Query string associated with this result.

mode
enum<string>
required

The mode associated with this tool result.

Available options:
search,
browse
data
object[]
required

Primary result records returned by the tool.

page_info
object
required

Pagination cursor values for traversing the result set.

returned
integer
required

The returned associated with this tool result.

Required range: x >= 0
total_matches
integer
required

Total number of matches found by the tool.

Required range: x >= 0
shard
object
required

Structured shard details associated with this tool result.