Developers - v1 contract
Developers
Wire agents, services, and CI to the same engines the dashboard uses - OpenAPI first, typed clients second, pipeline gates last.
OpenAPI contract
One source of truth for paths, schemas, and the global success/error envelope every engine shares.
- GET /api/v1/openapi — import into Postman, Insomnia, or codegen
- Every response carries request_id for tracing and support
- Error codes are fixed enums — no surprise strings in production
SDKs & packages
First-party clients so you stop hand-rolling fetch wrappers around the same payloads.
- TypeScript — packages/verixet-ts (see repo README for install)
- Python — packages/verixet-python with pytest-backed behavior
- Version alongside the app — bump package.json when you ship
GitHub Actions & CI
Copy-ready workflows under examples/github-actions/ — hard fail or soft warn while you tune.
- Gate on workflow.safe_to_deploy with jq — no custom parsers
- Soft mode for advisory workspaces; strict when policy blocks
- Anchor: /developers#ci for teammates bookmarking this section
Implementation examples
Concrete paths for CI gates, SDK hard gates, backend proxies, and post-deploy smoke.
- First-gate GitHub Actions workflow
- TypeScript and Python safe-to-deploy helpers
- Backend proxy pattern keeps vg_ keys server-side
Idempotent POST
Safe retries from agents, serverless, and flaky runners — without double-charging your OpenAI budget.
- Send Idempotency-Key on POST engines under the protected handler
- Same body → cached 200; different body → VALIDATION_ERROR
- Document keys per integration so queues don't collide
Releases & changelog
Track what landed in the app, dashboard, and client packages in one place.
- Marketing changelog calls out user-visible and contract changes
- package.json / tags in repo remain the install source of truth
- Pair with /docs for operators and /features for product context
Copy-paste: jq gate
Fail the job when safe_to_deploy is not true — works with the JSON body returned from workflow/pre-deploy.
echo "$JSON" | jq -e '.data.workflow.safe_to_deploy == true'
More resources
Human docs, implementation examples, pricing, and the raw OpenAPI download.