Package Exports
- @1claw/openapi-spec/openapi.json
- @1claw/openapi-spec/openapi.yaml
Readme
@1claw/openapi-spec
OpenAPI 3.1.0 specification for the 1Claw Vault API. Use this package to generate API clients in any language.
Install
npm install @1claw/openapi-specUsage
Generate a TypeScript client
npx openapi-typescript node_modules/@1claw/openapi-spec/openapi.yaml -o src/1claw-types.tsGenerate a Python client
openapi-generator generate \
-i node_modules/@1claw/openapi-spec/openapi.yaml \
-g python \
-o ./1claw-clientGenerate a Go client
openapi-generator generate \
-i node_modules/@1claw/openapi-spec/openapi.yaml \
-g go \
-o ./1claw-clientUse in code
import spec from "@1claw/openapi-spec/openapi.json";What's in the spec (v0.12.0)
- Vaults — CRUD, CMEK enable/disable, key rotation with job tracking
- Secrets — CRUD, versioning, CMEK-encrypted flag
- Agents — CRUD with
auth_method(api_key, mtls, oidc_client_credentials), auto-generated SSH keypairs,token_ttl_seconds,vault_ids, Intents API, transaction guardrails - Policies — Glob-based access control
- Sharing — Links, user/agent shares, accept/decline
- Billing — Subscriptions, credits, x402
- Audit — Hash-chained event log
- Chains — Supported blockchain registry
- Auth — JWT, API keys, agent tokens, MFA, device flow, Google OAuth
Included files
openapi.yaml— The canonical YAML specificationopenapi.json— JSON version for tooling that prefers JSON
License
PolyForm Noncommercial 1.0.0