Skip to main content
GET
Get embedding

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 or slug.

chunkId
string<uuid>
required

Chunk ID.

Query Parameters

environment
enum<string>

Deployment index to read. Omit all scope selectors for project-wide stored embeddings, including branch, release, historical, and legacy indexes. PREVIEW explicitly selects current main or the selected branch.

Available options:
PREVIEW,
PRODUCTION,
RELEASE
branch_id
string<uuid> | null

Select a current preview branch. Use null to explicitly select current main; when PREVIEW is set, an omitted branch also selects main.

release_id
string<uuid>

Select a frozen release by ID. RELEASE is inferred when environment is omitted.

release_version
string

Select a frozen release by version when no release ID is supplied. RELEASE is inferred when environment is omitted.

dimension
enum<string>
required

Vector dimension to retrieve.

Available options:
768,
1024,
1536,
3072,
4096
include_vector
boolean
default:true

Include raw vector data. Defaults to true.

Response

Embedding metadata and optionally the vector for a specific chunk.

id
string
required

Embedding ID.

chunk_id
string
required

File chunk ID associated with the embedding.

model
object
required

Embedding model that produced the vector. Not an agent chat model.

status
enum<string>
required

Embedding lifecycle status.

Available options:
ready,
stale,
missing
created_at
string
required

Embedding creation timestamp in ISO 8601 format.

vector
number[]

Raw embedding vector when requested.