Skip to main content
GET
/
projects
/
{project_reference}
/
branches
/
{branchName}
/
files
/
{filePath}
/
chunks
List Branch File Chunks
curl --request GET \
  --url https://api.veryfront.com/projects/{project_reference}/branches/{branchName}/files/{filePath}/chunks \
  --header 'Authorization: Bearer <token>'
{
  "data": [
    {
      "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>"
      }
    }
  ],
  "page_info": {
    "self": "<string>",
    "next": "<string>",
    "prev": "<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.

Query Parameters

​
limit
number
default:100

Maximum chunks to return, from 1 to 100.

Required range: 1 <= x <= 100
​
cursor
string

Opaque cursor from page_info.next.

​
include_embeddings
boolean
default:false

Whether to include embedding metadata when available.

Response

File chunks

​
data
object[]
required

File chunks in the requested branch, environment, or release context.

​
page_info
object
required

Pagination cursor values for traversing the result set.