Docs - Contract & operators
Documentation
Start from the OpenAPI contract, try engines in the dashboard explorer, then dive into operator runbooks for self-hosted production.
Guides & answers
On-site explanations for Workflow Gate, Meter, AI deploy gates, XFlow, and verify-self — written for operators and search.
- Structured pages under /learn with TechArticle schema
- Links back to OpenAPI and feature references
- Complements repo docs/ for long-form runbooks
API reference
The machine-readable contract for every v1 engine — import, codegen, and diff in CI.
- GET /api/v1/openapi — full OpenAPI 3 document (JSON)
- Drop into Postman, Insomnia, or your OpenAPI-driven SDK pipeline
- Same paths and envelopes the dashboard and playground call
Dashboard explorer
Built-in OpenAPI explorer against your deployment — session-authenticated, ideal for quick contract checks.
- Sign in, then open /dashboard/docs for the native explorer wired to your cookies
- Review parameters, responses, and schemas with real workspace context — not a public mock
- Complements (does not replace) the public OpenAPI contract
Operators & runbooks
Bootstrap, hardening, and policy depth for anyone self-hosting Verixet on their own stack.
- docs/ in the repo — bootstrap, production-hardening, Stripe, webhooks
- Environment matrices and logging hygiene for production
- Keep marketing /docs and repo docs in mind together when onboarding
Implementation examples
CI, SDK, backend proxy, and smoke-test examples for the fastest path from docs to first successful gate.
- Map each integration pattern to a repo proof file
- Use firstGate helpers or jq against safe_to_deploy
- Keep API keys server-side and request_id in logs
Repo docs/ vs this page
This hub is your on-site entry map. Long-form bootstrap, production hardening, and Stripe live in the docs/ directory of the repository — clone the repo or open your deployment bundle to read them alongside these links.
Related
Product overview, developer wiring, and live service status.