Developer documentation

Your first shared record.

Connect your application or agent, propose a change, and inspect the current record. These guides cover the public integration contracts.

SDK release status: the TypeScript SDK and types are in pre-release validation. Public npm installation will be available after release. You can connect a compatible client through hosted MCP today.

Start with one customer preference

Support learns that a customer prefers email. An operations agent needs the same preference before its next action. Both use one stable customer reference in the same authorized database.

  1. Create a database and get its endpoint and workspace key from Connections.
  2. Read the available vocabulary. Reuse the existing customer type and field names, or use a fresh database for the quickstart.
  3. Propose a contact channel, then send a second observation with the updated channel.
  4. Inspect each write result, read the current record, and retrieve the previous value and its source.

Know what each result means

Current state is the record accepted under your configured rules. History lets you inspect earlier values and changes. Provenance identifies the recorded source, actor, confidence, and time.

A completed call can contain skipped fields, warnings, or pending reviews. Read those results before your application acts on a proposed change. The type reference explains the response fields.

Choose how to provide observations

Send structured observations prepared by your application or its own model. Hosted text extraction and other LLM-assisted features depend on service availability and your selected policies. See the upcoming credit-based AI offer for the planned usage model.

Workspace keys identify programmatic access. Keep them on a trusted server or in your MCP client’s secret configuration. A key does not grant human schema administration; use the console for human administration.