Skip to main content
POST
Lookup project knowledge

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

Text to match against knowledge frontmatter.

Required string length: 1 - 500
cursor
string

Opaque pagination token. Omit on the first request — only pass a value returned verbatim in a previous response's page_info.next.

Required string length: 1 - 13334
lookup_target
object

Optional. Omit to search the current branch (the default). Only set this to target a specific deployed environment or release.

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.