Skip to main content
POST
/
projects
/
{project_reference}
/
branches
/
{branchName}
/
search
Search Branch Files (Vector)
curl --request POST \
  --url https://api.veryfront.com/projects/{project_reference}/branches/{branchName}/search \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "vector": [
    123
  ],
  "dimension": 768,
  "limit": 10,
  "threshold": 0.7
}
'
{
  "data": [
    {
      "chunk": {
        "id": "<string>",
        "file_path": "<string>",
        "file_id": "<string>",
        "file_version_id": "<string>",
        "index": 123,
        "content": "<string>",
        "start_offset": 123,
        "end_offset": 123,
        "token_count": 123,
        "metadata": {}
      },
      "score": 123,
      "match_type": "semantic"
    }
  ],
  "page_info": {
    "self": "<string>",
    "first": null,
    "next": "<string>",
    "prev": "<string>"
  },
  "search_time_ms": 123,
  "total_matches": 123
}

Authorizations

Authorization
string
header
required

Authentication via JWT token or API key. JWT: Get from Veryfront dashboard. API Key: Format "vf__" - create via /api-keys endpoint.

Path Parameters

project_reference
string
required
branchName
string
required

Body

application/json
vector
number[]
required

Query embedding vector

Required array length: 768 - 4096 elements
dimension
required

Vector dimension (768, 1024, 1536, 3072, 4096)

Available options:
768
limit
number
default:10
Required range: 1 <= x <= 100
threshold
number
default:0.7
Required range: 0 <= x <= 1

Response

Search results

data
object[]
required
page_info
object
required
search_time_ms
number
required
total_matches
number
required