Skip to main content
GET
List embeddings

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.

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: 768, 1024, 1536, 3072, or 4096.

Available options:
768,
1024,
1536,
3072,
4096
limit
number
default:100

Maximum embeddings to return.

Required range: 1 <= x <= 100
offset
number | null
default:0

Result offset.

Required range: x >= 0
sort_by
enum<string>
default:created_at

Sort field. Defaults to "created_at".

Available options:
created_at
sort_order
enum<string>
default:desc

Sort order. Defaults to "desc".

Available options:
asc,
desc

Response

List of embeddings.

data
object[]
required

Embedding summaries for the project.

total
number
required

Total matching embeddings.

limit
number
required

Page size used for the query.

offset
number
required

Offset used for the query.