#Home

Welcome to the Telepact docs. Use this page to find the right path based on what you are trying to do: learn the basics, design a schema, build clients and servers, or place Telepact inside a larger service.

#Start here

• Quickstart for the fastest end-to-end example

• Learn Telepact by Example for a guided tour

• Demos for runnable end-to-end examples

#Common paths

• I want the quickest possible start

  • Quickstart

  • Then Learn Telepact by Example

• I want browser + Node usage

  • Transport Guide for browser TypeScript + fetch and WebSocket patterns

  • Client Paths for choosing between plain JSON, runtime libraries, schema-backed mocks, and optional generated code

  • TypeScript library README for the runtime client/server API

• I want schema-backed integration confidence

  • Tooling Workflow for the fetch/compare/mock/codegen workflow

  • Learn by Example: Mock server

  • Learn by Example: Verify

• I need auth

  • Auth Guide for Telepact's canonical auth convention

  • example/py-http-cookie-auth for one browser/session-cookie example

• I need operating-boundary guidance

  • Operating Boundary Guide

  • Runtime Error Guide

• I need tooling or optional code generation

  • Tooling Workflow

  • CLI

  • Learn by Example: Code generation

• I want runnable examples

  • Demos

  • Transport Guide for the guide-to-demo mapping

#Design APIs

• Schema Writing Guide for the full schema language

• Core Concepts for Telepact's message model, schema role, headers, links, select, and binary at a high level

• Extensions overview for Telepact's reserved _ext.*_ types

• _ext.Select_ for response selection

• Mock extensions for _ext.Call_ and _ext.Stub_

• JSON Schema for schema-file validation

#Build clients and servers

• Transport Guide for HTTP and WebSocket wiring patterns

• Client Paths for choosing between plain JSON, client libraries, schema-backed mocks, and optional generated code

• Server Paths for choosing a runtime and wiring a server

• Auth Guide for Telepact's canonical auth convention

• Tooling Workflow for fetch, compare, mock, and codegen

#Libraries

• TypeScript

• Python

• Java

• Go

#SDK tools

• CLI

  • Fetch schemas, compare versions, run schema-backed mocks, and optionally generate code from the command line

• Browser Console

  • Browse docs and submit live requests against a running Telepact server

• Prettier Plugin

  • Format checked-in Telepact schema files consistently

#Operate

• Operating Boundary Guide for Telepact-specific auth, compatibility, and observability boundaries

• Runtime Error Guide for local/runtime debugging

• Versions for the latest published library and SDK versions

#Background and reference

• FAQ for Telepact's more unusual design decisions

• Motivation for the ecosystem goals and tradeoffs