Skip to Content
Management APIEmbeddings

Embeddings

Manage vector embedding resources for semantic search. See Embeddings for the full end-user REST API reference.

Read Queries

OperationGraphQL
List resourcesapp_embedding_resources(where: {application_id: {_eq: $appId}}, order_by: {created_at: desc})
List itemsapp_embedding_resource_items(where: {resource_id: {_eq: $resourceId}}, order_by: {created_at: desc}, limit: $limit)
Available modelsapp_available_model_catalog_v1(where: {_or: [{application_id: {_eq: $appId}}, {application_id: {_is_null: true}}]}, order_by: [{provider: asc}, {model: asc}]) (view)

Mutations (Hasura Actions)

OperationGraphQL
Create resourceBuilderEmbeddingsCreateResource(input: {key, name, description, model, accessMode, items}) (Hasura Action)
Update resourceBuilderEmbeddingsUpdateResource(input: {resourceKey, name, description}) (Hasura Action)
Delete resourceBuilderEmbeddingsDeleteResource(input: {resourceKey}) (Hasura Action)
Upsert itemsBuilderEmbeddingsUpsertItems(input: {resourceKey, items: [{itemId, text, vector, metadata}]}) (Hasura Action)
Delete itemBuilderEmbeddingsDeleteItem(input: {resourceKey, itemId}) (Hasura Action)
QueryBuilderEmbeddingsQuery(input: {resourceKey, query, queryVector, topK, minScore, filter}) (Hasura Action)
Import filesBuilderEmbeddingsImportFiles(input: {resourceKey, fileIds, truncateAtChars}) (Hasura Action)

Key parameters

  • model (create): Provider-prefixed embedding model. Required for the GraphQL/Builder path. For model-free (direct-vector-only) resources, use the REST API instead (POST /v1/embeddings/resources with dimensions and no model).
  • accessMode (create): 'application_shared' (default) or 'user_private'. Immutable after creation. Private resources are invisible to non-owners.
  • vector (upsert items): Pre-computed embedding vector (array of floats). When provided, text is optional and server-side embedding is skipped. Dimensions must match the resource.
  • queryVector (query): Pre-computed query vector. When provided, query text is optional. At least one of query or queryVector is required.

Note: Model-free resources (created via REST with dimensions instead of model) only accept pre-computed vectors. Text upserts and text queries on model-free resources return a 400 error.

Last updated on