v1

latestOpenAPI 3.0.12026-07-22231676.5 KB
Vault

Semantic search over a vault project

Performs semantic search over documents in a single vault project. Returns the most relevant text chunks for the given natural-language query. Intended for use by external systems (e.g. a customer's own assistant or LLM) that need to retrieve relevant passages and then generate responses using their own models.

Requires vault sharing to be enabled.

post/api/v1/vault/semantic_search

Request body

project_idstring uuid required

UUID of the vault project to search in

querystring required

Natural language search query.

include_file_namesboolean

When true, each chunk in the response includes a file_name field (display name of the source file, or null if the file was deleted after indexing). Omit or set to false for backward compatibility.

Response

Search completed successfully

status'COMPLETED' required

Status of the operation