Documentation

Documentation Gateway

Use this page to navigate the full DriftGate docs corpus for installation, platform architecture, SDK tracks, API contracts, and operational references.

Open Full DocumentationTypeScript Quickstart

Start Here

  1. Step 1

    Install + Verify

    Set up credentials and validate the environment.

    Open

  2. Step 2

    Platform Overview

    Understand sessions, executions, and the control-plane model.

    Open

  3. Step 3

    Pick SDK Track

    Choose your language and implement the quickstart path.

    Open

  4. Step 4

    Validate API Contract

    Use the canonical response envelope and error code references.

    Open

Core Links

Frequently used destinations into the live docs IA.

  • Install + Verify

    Set up credentials, install tooling, and validate your first governed execution.

    Open

  • SDK Tracks

    Language-specific SDK guides with quickstart, sessions, executions, and envelope semantics.

    Open

  • API + CLI

    Programmatic APIs and command-line workflows for deployment and operations.

    Open

  • Policy, Route, Risk

    Execution-path controls, risk evaluation, and governance routing behavior.

    Open

Organization Overview

Navigate organizational context and canonical open-source entry points.

  • Company Overview

    Read organizational positioning, operating model, and enterprise contact pathways.

    Open

  • GitHub Organization

    Browse canonical DriftGate public repositories for SDK, CLI, and distribution channels.

    Open

Public SDK/CLI Repositories

Verified public repository inventory for SDK packages, CLI workflows, examples, and distribution channels.

  • driftgate-sdk

    SDK · @driftgate/sdk

    Primary SDK surface with shared contracts and workflow compiler artifacts used across language integrations.

    Open

  • driftgate-cli

    CLI · @driftgate/cli

    Operational CLI for governed execution workflows, deployment automation, and runtime control-plane actions.

    Open

  • driftgate-examples

    Examples · Reference implementations

    Production-oriented integration examples that demonstrate execution-path governance patterns in real workloads.

    Open

  • sdk-go

    Package · github.com/driftgate/sdk-go

    Standalone Go SDK module for teams deploying governed agent workflows in Go services.

    Open

  • sdk-php

    Package · driftgate/sdk-php

    Standalone PHP SDK package for session and execution flows using DriftGate response-envelope semantics.

    Open

  • homebrew-tap

    Distribution · Homebrew formulae

    Homebrew distribution channel for CLI installation and controlled version rollout on macOS developer environments.

    Open

Platform

Architecture and governance primitives that define the execution path.

  • Platform OverviewOpen
  • Sessions and ExecutionsOpen
  • Policy, Route, and RiskOpen

SDK Tracks

Language-specific guidance with quickstart, sessions, executions, and envelope handling.

  • SDK OverviewOpen
  • TypeScript QuickstartOpen

API + CLI

Programmatic and operational interfaces for governed execution workflows.

Reference + Compatibility

Canonical envelope semantics, error contracts, and compatibility expectations.

  • Response EnvelopeOpen
  • Error CodesOpen
  • Compatibility MatrixOpen
TypeScript Quickstart Preview
import { DriftGateClient } from "@driftgate/sdk"

const client = new DriftGateClient({
  baseUrl: "https://api.driftgate.ai",
  sessionToken: process.env.DRIFTGATE_SESSION_TOKEN,
})

const session = await client.session.start({ agent: "refund-agent" })
const result = await session.execute({ input: { orderId: "ord_123" } })

if (result.error) throw new Error(result.error.code)
console.log(result.meta.requestId)

Continue with the full multi-language docs and API reference in the external documentation portal.