Documentation / Version 0.17

Integration without magic

This concise public guide shows the client contract and operational sequence. Complete admin runbooks ship with the on-premise package.

API quickstartPilot docs

Core concepts

A client does not choose a physical provider directly. It sends a model alias resolved through the active tenant policy.

  • 01
    Provider

    OpenAI-compatible upstream endpoint, public/private class and encrypted credential.

  • 02
    Model alias

    A stable client identifier mapped to an upstream model ID.

  • 03
    Policy version

    Model allowlist, limits, DLP, Guard and sensitive route.

  • 04
    Security event

    Decision metadata without storing prompt or response content.

Request from an application

Create a service account and gateway API key with the required scope in Control Center. The secret is shown only once at creation.

curl / OpenAI-compatible requestHTTPS
curl https://gateway.cyberpass.kz/v1/chat/completions \
  -H "Authorization: Bearer cpsk_..." \
  -H "Content-Type: application/json" \
  -d '{
    "model": "public-general",
    "messages": [
      {"role": "user", "content": "Reply with pilot-ready"}
    ]
  }'
Use synthetic test text only. Do not paste production secrets into the initial test.

Request from an endpoint

After enrollment, Windows Connector starts a local OpenAI-compatible proxy. The application uses the loopback base URL and any non-empty placeholder key.

local client base URLWindows beta
Base URL: http://127.0.0.1:8765/v1
API key:  local-placeholder
Model:    public-general

Browser extension

The extension talks only to Connector. It inspects text prompts on supported sites but does not intercept arbitrary TLS traffic or analyze files.

MCP through Firewall

An administrator registers the Streamable HTTP server and tool-pattern rules in Control Center. The IDE or agent uses a local Connector URL; the device token remains hidden from the client.

IDE MCP URLtools/list · tools/call
http://127.0.0.1:8765/mcp/internal-tools

A call with action require_approval returns an approval ID. After the analyst decides, the client repeats the same call with params._meta["io.cyberpass/approvalId"]. Approval is bound to the server, tool and argument SHA-256 and can be used once.

On-premise deployment

A production-like pilot uses a Linux host, Docker Compose, customer ingress and customer PKI.

pilot lifecycleoperator
./deploy/pilot/init-env.sh
./deploy/pilot/preflight.sh
./deploy/pilot/install.sh

# later, pinned upgrade
./deploy/pilot/upgrade.sh origin/main <40-char-sha>

An upgrade creates a backup and runs acceptance checks. If the Alembic revision changed, the database is not downgraded automatically.

Events and SIEM

Gateway stores request ID, decision, policy/model route, detector IDs, risk score and timing. Prompt and response content are absent from the event schema.

A SIEM destination supports CEF over Syslog UDP/TCP. The asynchronous queue uses bounded retries and a DLQ; the customer network must permit delivery.

Current limitations

LLM protocolsOpenAI-compatibleOther protocols are on the reusable-adapter roadmap.
ContentTextFiles, OCR and multimodal content are separate.
Human identityBaselineLocal auth, OIDC and LDAP/AD; specific claims/schema and MFA policy are validated with the customer.
AvailabilityPilot topologySingle-node PostgreSQL/Redis in Compose.

Need the full pilot runbook?

It is tailored to your PKI, DNS, model endpoints and acceptance checklist.

Request a pilot →