Skip to main content
GET
/
projects
/
{project_reference}
/
branches
/
{branchName}
/
files
/
{filePath}
/
chunks
/
{chunkId}
Get Branch File Chunk
curl --request GET \
  --url https://api.veryfront.com/projects/{project_reference}/branches/{branchName}/files/{filePath}/chunks/{chunkId} \
  --header 'Authorization: Bearer <token>'
{
  "id": "<string>",
  "file_path": "<string>",
  "file_version_id": "<string>",
  "index": 123,
  "content": "<string>",
  "start_offset": 123,
  "end_offset": 123,
  "token_count": 123,
  "source_checksum": "<string>",
  "created_at": "<string>",
  "file_id": "<string>",
  "metadata": {},
  "embedding": {
    "id": "<string>",
    "model": "<string>"
  }
}

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, slug, or domain from the authenticated context.

​
branchName
string
required

Branch name or ID from the route.

​
filePath
string
required

URL-encoded file path for the chunked file.

​
chunkId
string<uuid>
required

File chunk UUID.

Query Parameters

​
include_embedding
boolean
default:false

Whether to include embedding metadata when available.

Response

Chunk

​
id
string
required
​
file_path
string
required
​
file_version_id
string
required
​
index
number
required
​
content
string
required
​
start_offset
number
required
​
end_offset
number
required
​
token_count
number
required
​
source_checksum
string
required
​
created_at
string
required
​
file_id
string
​
metadata
object
​
embedding
object