> ## 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.

# Knowledge API

> Store document metadata, index file chunks, and search project content.

Store document metadata, index file chunks, and search project content.

Manage [embeddings](/docs/cloud/rest/apis/knowledge-api#project-embeddings) for [vector search](/docs/cloud/rest/apis/knowledge-api#vector-search), or query [project knowledge metadata](/docs/cloud/rest/apis/knowledge-api#project-knowledge). Select a branch, environment, or release when the endpoint supports multiple content versions.

[Project documents](#project-documents) · [File Chunks](#file-chunks) · [Project embeddings](#project-embeddings) · [Vector search](#vector-search) · [Project knowledge](#project-knowledge)

## Project documents

List, create, or update metadata records in the project’s retrieval-augmented generation (RAG) store. Use [project file endpoints](/docs/cloud/rest/apis/projects-api#project-files) to edit source content.

| Endpoint | Methods | Description |
| - | - | - |
| `/projects/{project_reference}/rag/documents` | [GET](/docs/cloud/rest/api-reference/project-documents/list-rag-documents), [POST](/docs/cloud/rest/api-reference/project-documents/upsert-a-rag-document) | List RAG documents; Upsert a RAG document |
| `/projects/{project_reference}/rag/documents/{documentId}` | [DELETE](/docs/cloud/rest/api-reference/project-documents/delete-a-rag-document) | Delete a RAG document |

## File Chunks

Read file chunks used for indexing. Create or delete chunks on a branch, or read chunks from a branch, environment, or release.

| Endpoint | Methods | Description |
| - | - | - |
| `/projects/{project_reference}/branches/{branchName}/files/{filePath}/chunks` | [GET](/docs/cloud/rest/api-reference/file-chunks/list-branch-file-chunks), [POST](/docs/cloud/rest/api-reference/file-chunks/upsert-branch-file-chunks), [DELETE](/docs/cloud/rest/api-reference/file-chunks/delete-branch-file-chunks) | List branch file chunks; Upsert branch file chunks; Delete branch file chunks |
| `/projects/{project_reference}/branches/{branchName}/files/{filePath}/chunks/{chunkId}` | [GET](/docs/cloud/rest/api-reference/file-chunks/get-branch-file-chunk) | Get branch file chunk |
| `/projects/{project_reference}/environments/{environmentName}/files/{filePath}/chunks` | [GET](/docs/cloud/rest/api-reference/file-chunks/list-environment-file-chunks) | List environment file chunks |
| `/projects/{project_reference}/environments/{environmentName}/files/{filePath}/chunks/{chunkId}` | [GET](/docs/cloud/rest/api-reference/file-chunks/get-environment-file-chunk) | Get environment file chunk |
| `/projects/{project_reference}/releases/{version}/files/{filePath}/chunks` | [GET](/docs/cloud/rest/api-reference/file-chunks/list-release-file-chunks) | List release file chunks |
| `/projects/{project_reference}/releases/{version}/files/{filePath}/chunks/{chunkId}` | [GET](/docs/cloud/rest/api-reference/file-chunks/get-release-file-chunk) | Get release file chunk |
| `/projects/{project_reference}/chunks` | [GET](/docs/cloud/rest/api-reference/file-chunks/list-project-chunks) | List project chunks |

## Project embeddings

Store and retrieve vectors by chunk ID. Generate vectors through [the embeddings endpoint](/docs/cloud/rest/api-reference/embeddings/create-embeddings) or your provider before storing them here.

| Endpoint | Methods | Description |
| - | - | - |
| `/projects/{project_reference}/embeddings` | [GET](/docs/cloud/rest/api-reference/project-embeddings/list-embeddings), [POST](/docs/cloud/rest/api-reference/project-embeddings/upsert-embeddings) | List embeddings; Upsert embeddings |
| `/projects/{project_reference}/embeddings/{chunkId}` | [GET](/docs/cloud/rest/api-reference/project-embeddings/get-embedding), [DELETE](/docs/cloud/rest/api-reference/project-embeddings/delete-embedding) | Get embedding; Delete embedding |

## Vector search

Search indexed content with an embedding vector. Choose the branch, environment, or release endpoint for the content you need.

| Endpoint | Methods | Description |
| - | - | - |
| `/projects/{project_reference}/branches/{branchName}/search` | [POST](/docs/cloud/rest/api-reference/vector-search/search-branch-files-with-a-vector) | Search branch files with a vector |
| `/projects/{project_reference}/environments/{environmentName}/search` | [POST](/docs/cloud/rest/api-reference/vector-search/search-environment-files-with-a-vector) | Search environment files with a vector |
| `/projects/{project_reference}/releases/{version}/search` | [POST](/docs/cloud/rest/api-reference/vector-search/search-release-files-with-a-vector) | Search release files with a vector |

## Project knowledge

Search metadata in project knowledge files. Specify a branch, environment, or release to query the required content version.

| Endpoint | Methods | Description |
| - | - | - |
| `/projects/{project_reference}/knowledge/lookup` | [POST](/docs/cloud/rest/api-reference/project-knowledge/look-up-project-knowledge) | Look up project knowledge |

[Back to REST API reference](/docs/cloud/rest)


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.