Overview

The KV runtime API — the methods available on a bound namespace, plus their option and result types.

The types in this reference are exported from @telnyx/edge-runtime (TypeScript) and describe version ≥ 0.2.2 — the first release where expirationTtl is applied and list() entries carry sizeBytes/updatedAt. They describe the env binding — the in-function surface. To read or write KV from another language or outside a function, use the REST API.

The KV Runtime API is a single binding type and the small set of option/result types its methods take. A namespace declared as [storage.kv.<NAME>] in func.toml resolves on env.<NAME> as a KvNamespace.

Surface	Where it lives	What it’s for
KvNamespace	env.<BINDING>	The binding handle — get, put, delete, list.
KvGetTextOptions / KvGetJsonOptions	get() options	Select the raw-text read or a JSON.parsed read.
KvPutOptions	put() options	expirationTtl — server-side TTL in seconds (metadata is deprecated and ignored).
KvListOptions / KvListResult / KvKeyInfo	list() options + result	Prefix, pagination cursor, and the returned key entries.

Getting the Binding

import { env } from "@telnyx/edge-runtime";

// env.MY_KV is a KvNamespace, from [storage.kv.MY_KV] in func.toml
await env.MY_KV.put("greeting", "hello");
const greeting = await env.MY_KV.get("greeting"); // "hello"

Declaring the binding is covered in the Quick Start. The binding resolves at runtime from func.toml; run telnyx-edge types (CLI ≥ v0.2.3) after editing the manifest to regenerate telnyx-env.d.ts, which types env.<NAME> as a KvNamespace.

Related Resources

• KvNamespace — the method-by-method reference
• Bindings — how bindings resolve on env
• REST API — the same operations over HTTP
• Key Expiration — server-side TTL via expirationTtl, ttl_secs, or --ttl