Database Tools

Sapiom provides four database types: Redis for key-value storage, Vector for similarity search, Search for full-text search with auto-embedding, and Postgres for relational databases. Redis, Vector, and Search are backed by Upstash; Postgres is backed by Neon.

All database tools accept an optional agentName parameter for spend attribution.

---

Redis

Key-value storage with full Redis command support. Databases are ephemeral with configurable TTL.

sapiom_redis_create

Create an Upstash Redis database. Returns the database URL for executing commands. Databases expire after the specified TTL.

name string required

Database name (1–128 chars)

region string default: us-east-1

Region

ttl string

Time-to-live (e.g. "1h", "24h", "7d")

sapiom_redis_list

List all Redis databases for the current account. Returns database IDs and URLs.

This tool takes no required parameters.

sapiom_redis_delete

Delete a Redis database by ID. This permanently destroys the database and all its data.

id string required

Database ID to delete (e.g. "rds_abc123")

sapiom_redis_update

Update a Redis database — rename it or extend its expiry. Use to keep a database alive before it expires.

id string required

Database ID (e.g. "rds_abc123")

name string

New name for the database (1–128 chars)

expiresAt string

New expiry as ISO 8601 timestamp (must be in the future)

sapiom_redis_command

Execute Redis commands against a database. Pass the database URL (from sapiom_redis_create/sapiom_redis_list) and a command array. Supports pipelines by passing an array of command arrays.

url string required

Database URL from sapiom_redis_create or sapiom_redis_list

command string[]

Redis command as array (e.g. ["SET", "key", "value"]). Required unless pipeline is provided.

pipeline string[][]

Pipeline: array of command arrays for batch execution

---

Vector

Similarity search with vector embeddings. Create indexes, upsert vectors, and query by similarity.

sapiom_vector_create

Create an Upstash Vector index for similarity search. Returns the index URL for data operations. Choose dimensions and similarity function based on your embedding model.

name string required

Index name (1–128 chars)

region string default: us-east-1

Region

dimensions number default: 1536

Vector dimensions (1–10000, default: 1536 for OpenAI)

similarityFunction enum default: cosine

Similarity function: cosine, euclidean, dotProduct

ttl string

Time-to-live (e.g. "1h", "24h", "7d")

sapiom_vector_list

List all Vector indexes for the current account.

This tool takes no required parameters.

sapiom_vector_delete

Delete a Vector index by ID. This permanently destroys the index and all its data.

id string required

Index ID to delete (e.g. "vec_abc123")

sapiom_vector_update

Update a Vector index — rename it or extend its expiry. Use to keep an index alive before it expires.

id string required

Index ID (e.g. "vec_abc123")

name string

New name for the index (1–128 chars)

expiresAt string

New expiry as ISO 8601 timestamp (must be in the future)

sapiom_vector_upsert

Upsert vectors into an Upstash Vector index. Pass the index URL and an array of vectors with IDs, values, and optional metadata.

url string required

Index URL from sapiom_vector_create or sapiom_vector_list

namespace string default: default

Namespace to upsert into

vectors object[] required

Array of vectors to upsert. Each vector: { id: string, vector?: number[], data?: string, metadata?: object }

sapiom_vector_query

Query an Upstash Vector index for similar vectors. Returns ranked results with scores.

url string required

Index URL from sapiom_vector_create or sapiom_vector_list

namespace string default: default

Namespace to query

vector number[]

Query vector values (provide this or data)

data string

Query text for auto-embedding (alternative to vector)

topK number default: 10

Number of results to return (1–1000)

includeMetadata boolean default: true

Include metadata in results

includeData boolean

Include stored data in results

filter string

Metadata filter expression

---

Search

Full-text search with auto-embedding. Create indexes, upsert documents, and query with optional reranking.

sapiom_searchindex_create

Create an Upstash Search index for full-text search with auto-embedding. Returns the index URL for data operations.

name string required

Index name (1–128 chars)

region string default: us-central1

Region

ttl string

Time-to-live (e.g. "1h", "24h", "7d")

sapiom_searchindex_list

List all Search indexes for the current account.

This tool takes no required parameters.

sapiom_searchindex_delete

Delete a Search index by ID. This permanently destroys the index and all its data.

id string required

Index ID to delete (e.g. "srch_abc123")

sapiom_searchindex_update

Update a Search index — rename it or extend its expiry. Use to keep an index alive before it expires.

id string required

Index ID (e.g. "srch_abc123")

name string

New name for the index (1–128 chars)

expiresAt string

New expiry as ISO 8601 timestamp (must be in the future)

sapiom_searchindex_upsert

Upsert documents into an Upstash Search index. Documents are auto-embedded for semantic search.

url string required

Index URL from sapiom_searchindex_create or sapiom_searchindex_list

indexName string required

Search index name to upsert into (e.g. "articles", "default")

documents object[] required

Array of documents to upsert. Each document: { id: string, content: object, metadata?: object }

sapiom_searchindex_query

Search an Upstash Search index. Supports text queries with optional reranking for improved relevance.

url string required

Index URL from sapiom_searchindex_create or sapiom_searchindex_list

indexName string required

Search index name to query (e.g. "articles", "default")

query string required

Search query text

limit number default: 5

Number of results to return (1–1000)

reranking boolean

Enable reranking for improved relevance (additional cost)

filter string

Metadata filter expression

---

Postgres

Ephemeral Neon Postgres databases with specified lifetimes. Returns connection credentials for direct SQL access.

sapiom_database_create

Provision an ephemeral Neon Postgres database with a specified lifetime. Returns connection credentials once provisioning completes. Use sapiom_database_price to estimate cost before creating.

duration enum required

Database lifetime: 15m, 1h, 4h, 24h, 7d

handle string

Stable LLM-friendly handle for lookups (lowercase alphanumeric + hyphens, 3–63 chars, e.g. "analytics-db")

name string

Human-readable name for the database (max 100 chars)

description string

What this database is for — helps identify it in future sessions (max 500 chars)

region string default: aws-us-east-1

Neon region

pgVersion number default: 17

PostgreSQL version: 15, 16, or 17

sapiom_database_price

Get the price estimate for creating a Neon Postgres database. Free endpoint — no payment required. Use before sapiom_database_create to check costs.

duration enum required

Database lifetime to get price for: 15m, 1h, 4h, 24h, 7d

sapiom_database_list

List all your active and provisioning Neon Postgres databases, including connection URIs. Use sapiom_database_get to retrieve a specific database by ID or handle.

This tool takes no required parameters.

sapiom_database_get

Get details and connection URI for a specific Neon Postgres database. Accepts either a database ID or a handle.

id string required

Database ID (ndb_xxx) or handle (e.g. "analytics-db")

sapiom_database_delete

Delete a Neon Postgres database and its underlying project. Accepts either a database ID or a handle. This action is irreversible.

id string required

Database ID (ndb_xxx) or handle (e.g. "analytics-db")