Add project knowledge

Add a Markdown knowledge file to project source, then look it up and read the matching content. Use a project you can edit and set an API credential. The example stores a synthetic policy under knowledge/; replace its contents with your project’s information.

1. Write a knowledge file

Create the file with PUT /projects/{project_reference}/files/{file_path}. The path is URL-encoded, and expected_absent prevents replacing an existing file.

add-knowledge.sh

curl -X PUT https://api.veryfront.com/projects/support-assistant/files/knowledge%2Frefund-policy.md \
  -H "Authorization: Bearer $VERYFRONT_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "content": "---\ntitle: Refund policy\ndescription: Sample refund policy for support requests.\n---\nThis is example policy content. Replace it before using it in an agent.\n",
    "content_type": "text/markdown",
    "expected_absent": true
  }'

2. Find the knowledge file

Find the file through POST /projects/{project_reference}/knowledge/search:

find-knowledge.sh

curl -X POST https://api.veryfront.com/projects/support-assistant/knowledge/search \
  -H "Authorization: Bearer $VERYFRONT_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"query":"refund policy"}'

Search matches file paths and frontmatter and returns paths with matching metadata. It does not return the document body. Read a matching path with GET /projects/{project_reference}/files/{file_path}.

Verify the result

Confirm that search returns knowledge/refund-policy.md, then read that file and check its content. Use the same branch or content version for both requests. If search returns no match, check the file’s location, frontmatter, and selected content version. Importing a file into upload storage does not automatically add it to this source-based search.

Vector retrieval

For semantic search, index content chunks and their embeddings through the Knowledge API. That index is separate from frontmatter search and project uploads.

API references

Interface	Operations
REST	Write a file · Search knowledge files
GraphQL	Semantic file search
MCP	Search knowledge · Read a file

Get started

APIs

REST API

GraphQL API

MCP API

Add project knowledge

1. Write a knowledge file

2. Find the knowledge file

Verify the result

Vector retrieval

API references

​1. Write a knowledge file

​2. Find the knowledge file

​Verify the result

​Vector retrieval

​API references

1. Write a knowledge file

2. Find the knowledge file

Verify the result

Vector retrieval

API references