Explore documentation
  1. Welcome to Warehouse 👋
  2. Ingesting data
    1. Ingesting events
    2. S3 vs NVMe hosted data
    3. Host events in your S3 bucket
  3. Querying data
    1. Querying events & time series
    2. Writing ClickHouse SQL queries
    3. Query speeds
    4. Ad-hoc SQL API
    5. Generate client-facing APIs
    6. Visualizing data
  4. Vector embeddings
    1. Introduction to embeddings
    2. Using built-in embeddings
    3. Bringing your own embeddings
    4. Data structures and indices
  5. Use cases
    1. Retrieval Augmented Generation
  6. Management
    1. Controlling costs
  7. Warehouse API
    1. Getting an API token
    2. Warehouse sources API
    3. Warehouse source groups API
    4. Time series API
    5. Embeddings API
      1. List all embeddings GET
      2. Create an embedding POST
      3. Remove an embedding DELETE

Create an embedding

Creates a new embedding configuration for a Warehouse source.

POST https://warehouse.betterstack.com/api/v1/sources/{source_id}/embeddings

URL parameters

source_id
required string

The ID of the Warehouse source to create the embedding for.

Headers

Authorization
required string

Bearer $TOKEN

Content-Type
required string

application/json

Body parameters

embed_from
required string

The source column name containing the text to embed.

embed_to
required string

The target column name where the generated embeddings will be stored.

model
required string

The name of the embedding model to use (e.g., embeddinggemma:300m).

dimension
required integer

The vector dimension of the embeddings to generate.

201

The newly created embedding configuration.

Response body

{
  "data": {
    "id": "9012",
    "type": "embedding",
    "attributes": {
      "embed_from": "message",
      "embed_to": "message_embedding",
      "dimension": 512,
      "model": "embeddinggemma:300m"
    }
  }
}
401

Unauthorized

Response body

{
  "errors": "Invalid authentication"
}
404

Not Found

Response body

{
  "errors": "Source with the provided ID was not found"
}
422

Unprocessable Entity - Validation Errors

Response body

{
  "errors": "Validation errors",
  "invalid_values": {
    "embed_from": [
      "cannot be the same as embed_to"
    ]
  }
}

Example cURL

Example
curl --request POST \
  --url https://warehouse.betterstack.com/api/v1/sources/123/embeddings \
  --header "Authorization: Bearer $TOKEN" \
  --header 'Content-Type: application/json' \
  --data '{
    "embed_from": "description",
    "embed_to": "description_embedding",
    "model": "embeddinggemma:300m",
    "dimension": 512
  }'

Previous article

List all embeddings

Next article

Remove an embedding