Skip to main content
POST
Look up 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 file paths and frontmatter. On the first request, provide query without cursor.

Required string length: 1 - 500
cursor
string

Opaque pagination token. Omit on the first request. To continue REST or MCP pagination, pass page_info.next from the previous response as cursor.

Required string length: 1 - 13334
lookup_target
object

Optional. Omit to search the main preview branch (the default). Set this to target another preview branch, a deployed environment, or a published release; unresolved targets are returned as not found.

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

Resolved query used for scoring.

mode
enum<string>
required

search when results scored positively; browse when no positive matches exist.

Available options:
search,
browse
data
object[]
required

Knowledge Markdown paths with frontmatter previews.

page_info
object
required
returned
integer
required
Required range: x >= 0
total_matches
integer
required
Required range: x >= 0
shard
object
required