@1claw/openapi-spec 0.38.0 → 0.39.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (4) hide show
  1. package/README.md +1 -1
  2. package/openapi.json +70 -11
  3. package/openapi.yaml +55 -9
  4. package/package.json +1 -1
package/README.md CHANGED
@@ -87,7 +87,7 @@ import spec from "@1claw/openapi-spec/openapi.json";
87
87
  - **Smart Accounts** — Per-agent multi-chain Safe accounts: `POST /v1/agents/{id}/smart-accounts`, `GET /v1/agents/{id}` returns `smart_accounts[]`. One EOA signer per agent, Intents API resolves Safe by `chain_id`.
88
88
  - **Vaults** — CRUD, CMEK enable/disable, key rotation with job tracking, MPC enable/disable (`POST /v1/vaults/{id}/mpc`, `DELETE /v1/vaults/{id}/mpc`)
89
89
  - **Secrets** — CRUD, versioning, CMEK-encrypted flag, `client_share` in responses (MPC vaults)
90
- - **Agents** — CRUD with `auth_method` (api_key, mtls, oidc_client_credentials), auto-generated SSH keypairs, `token_ttl_seconds`, `vault_ids`, Intents API, transaction guardrails (`tx_to_allowlist`, `tx_max_value_eth`, `tx_daily_limit_eth`, `tx_allowed_chains`), **OIDC federation knobs** (`federation_enabled`, `federation_audiences`, `federated_token_ttl_seconds`); **`GET /v1/agents/{id}`** includes **`tx_spent_today_eth`** (rolling UTC-day spend from recorded txs) for clients such as **Shroud** that enforce the daily cap alongside per-tx limits
90
+ - **Agents** — CRUD with `auth_method` (api_key, mtls, oidc_client_credentials), auto-generated SSH keypairs, `token_ttl_seconds`, `vault_ids`, Intents API, transaction guardrails (`tx_to_allowlist`, `tx_max_value` (native major units), `tx_daily_limit` (per-chain), `tx_allowed_chains`), **OIDC federation knobs** (`federation_enabled`, `federation_audiences`, `federated_token_ttl_seconds`); **`GET /v1/agents/{id}`** includes **`tx_spent_today`** and **`tx_spent_today_by_chain`** (per-chain daily spend in native units) for clients such as **Shroud** that enforce the daily cap alongside per-tx limits. Deprecated aliases `tx_max_value_eth`, `tx_daily_limit_eth`, `tx_spent_today_eth` are still accepted/returned for backward compatibility.
91
91
  - **Signing Keys** — Multi-chain key management: `POST /v1/agents/{id}/signing-keys` (provision), `GET .../signing-keys` (list), `POST .../signing-keys/{chain}/rotate`, `DELETE .../signing-keys/{chain}` (deactivate). Supports ethereum, bitcoin, solana, xrp, cardano, tron
92
92
  - **Unified Signing** — `POST /v1/agents/{id}/sign` — single endpoint for EIP-191 personal_sign, EIP-712 typed_data, and EIP-2718 transaction types (legacy, EIP-1559, EIP-4844, EIP-7702)
93
93
  - **Policies** — Glob-based access control
package/openapi.json CHANGED
@@ -2,7 +2,7 @@
2
2
  "openapi": "3.1.0",
3
3
  "info": {
4
4
  "title": "1Claw API",
5
- "version": "2.24.0",
5
+ "version": "2.25.0",
6
6
  "description": "Secure secret management for AI agents. Provides vaults, secrets,\npolicy-based access control, agent identity, Intents API,\nsharing, billing, and audit logging.\n\nAll endpoints require JWT Bearer authentication unless marked with\n`security: []`.\n",
7
7
  "contact": {
8
8
  "email": "ops@1claw.xyz"
@@ -1160,6 +1160,15 @@
1160
1160
  "responses": {
1161
1161
  "202": {
1162
1162
  "description": "Approval request created",
1163
+ "headers": {
1164
+ "Location": {
1165
+ "description": "URL to poll for approval status",
1166
+ "schema": {
1167
+ "type": "string",
1168
+ "example": "/v1/approvals/{id}"
1169
+ }
1170
+ }
1171
+ },
1163
1172
  "content": {
1164
1173
  "application/json": {
1165
1174
  "schema": {
@@ -2260,6 +2269,15 @@
2260
2269
  "responses": {
2261
2270
  "202": {
2262
2271
  "description": "Rotation job started",
2272
+ "headers": {
2273
+ "Location": {
2274
+ "description": "URL to poll for rotation job status",
2275
+ "schema": {
2276
+ "type": "string",
2277
+ "example": "/v1/vaults/{vault_id}/cmek-rotate/{job_id}"
2278
+ }
2279
+ }
2280
+ },
2263
2281
  "content": {
2264
2282
  "application/json": {
2265
2283
  "schema": {
@@ -10874,11 +10892,23 @@
10874
10892
  "type": "string"
10875
10893
  }
10876
10894
  },
10895
+ "tx_max_value": {
10896
+ "type": "string",
10897
+ "description": "Maximum value per transaction in native major units for the transacting chain family (ETH on EVM, BTC on Bitcoin, SOL on Solana, XRP, ADA, TRX)."
10898
+ },
10899
+ "tx_daily_limit": {
10900
+ "type": "string",
10901
+ "description": "Rolling daily spend cap in native major units, enforced per chain family at signing time."
10902
+ },
10877
10903
  "tx_max_value_eth": {
10878
- "type": "string"
10904
+ "type": "string",
10905
+ "deprecated": true,
10906
+ "description": "Deprecated alias for tx_max_value. Same unit semantics (native major units, not ETH-only)."
10879
10907
  },
10880
10908
  "tx_daily_limit_eth": {
10881
- "type": "string"
10909
+ "type": "string",
10910
+ "deprecated": true,
10911
+ "description": "Deprecated alias for tx_daily_limit."
10882
10912
  },
10883
10913
  "tx_allowed_chains": {
10884
10914
  "type": "array",
@@ -10941,7 +10971,7 @@
10941
10971
  "per_chain_guardrails": {
10942
10972
  "type": "object",
10943
10973
  "additionalProperties": true,
10944
- "description": "Per-chain guardrail overrides. Keys are chain family names (ethereum, bitcoin, solana, etc.).\nEach value can contain: max_value, daily_limit, to_allowlist, token_allowlist.\nExample: { \"ethereum\": { \"max_value\": \"0.5\", \"to_allowlist\": [\"0x...\"] } }\n"
10974
+ "description": "Per-chain guardrail overrides. Keys are signing chains (ethereum, bitcoin, solana, xrp, cardano, tron).\nEach value may include max_value, daily_limit, to_allowlist, token_allowlist (legacy *_eth keys accepted).\nStrictest of global and per-chain limits wins. Daily limits apply per chain family spend, not cross-chain totals.\n"
10945
10975
  },
10946
10976
  "api_key_expires_at": {
10947
10977
  "type": "string",
@@ -10979,11 +11009,23 @@
10979
11009
  "type": "string"
10980
11010
  }
10981
11011
  },
11012
+ "tx_max_value": {
11013
+ "type": "string",
11014
+ "description": "Maximum value per transaction in native major units for the transacting chain family (ETH on EVM, BTC on Bitcoin, SOL on Solana, XRP, ADA, TRX)."
11015
+ },
11016
+ "tx_daily_limit": {
11017
+ "type": "string",
11018
+ "description": "Rolling daily spend cap in native major units, enforced per chain family at signing time."
11019
+ },
10982
11020
  "tx_max_value_eth": {
10983
- "type": "string"
11021
+ "type": "string",
11022
+ "deprecated": true,
11023
+ "description": "Deprecated alias for tx_max_value. Same unit semantics (native major units, not ETH-only)."
10984
11024
  },
10985
11025
  "tx_daily_limit_eth": {
10986
- "type": "string"
11026
+ "type": "string",
11027
+ "deprecated": true,
11028
+ "description": "Deprecated alias for tx_daily_limit."
10987
11029
  },
10988
11030
  "tx_allowed_chains": {
10989
11031
  "type": "array",
@@ -11050,7 +11092,7 @@
11050
11092
  "per_chain_guardrails": {
11051
11093
  "type": "object",
11052
11094
  "additionalProperties": true,
11053
- "description": "Per-chain guardrail overrides. Keys are chain family names (ethereum, bitcoin, solana, etc.).\nEach value can contain: max_value, daily_limit, to_allowlist, token_allowlist.\nExample: { \"ethereum\": { \"max_value\": \"0.5\", \"to_allowlist\": [\"0x...\"] } }\n"
11095
+ "description": "Per-chain guardrail overrides. Keys are signing chains (ethereum, bitcoin, solana, xrp, cardano, tron).\nEach value may include max_value, daily_limit, to_allowlist, token_allowlist (legacy *_eth keys accepted).\nStrictest of global and per-chain limits wins. Daily limits apply per chain family spend, not cross-chain totals.\n"
11054
11096
  },
11055
11097
  "api_key_expires_at": {
11056
11098
  "type": "string",
@@ -11108,15 +11150,32 @@
11108
11150
  "type": "string"
11109
11151
  }
11110
11152
  },
11153
+ "tx_max_value": {
11154
+ "type": "string",
11155
+ "description": "Maximum value per transaction in native major units for the transacting chain family (ETH on EVM, BTC on Bitcoin, SOL on Solana, XRP, ADA, TRX)."
11156
+ },
11157
+ "tx_daily_limit": {
11158
+ "type": "string",
11159
+ "description": "Rolling daily spend cap in native major units, enforced per chain family at signing time."
11160
+ },
11111
11161
  "tx_max_value_eth": {
11112
- "type": "string"
11162
+ "type": "string",
11163
+ "deprecated": true,
11164
+ "description": "Deprecated alias for tx_max_value. Same unit semantics (native major units, not ETH-only)."
11113
11165
  },
11114
11166
  "tx_daily_limit_eth": {
11115
- "type": "string"
11167
+ "type": "string",
11168
+ "deprecated": true,
11169
+ "description": "Deprecated alias for tx_daily_limit."
11170
+ },
11171
+ "tx_spent_today": {
11172
+ "type": "string",
11173
+ "description": "Sum of today's spend across all chain families in major units. Prefer tx_spent_today_by_chain."
11116
11174
  },
11117
11175
  "tx_spent_today_eth": {
11118
11176
  "type": "string",
11119
- "description": "ETH value already spent today (UTC) from recorded transactions; used with daily limit guardrails"
11177
+ "deprecated": true,
11178
+ "description": "Deprecated alias for tx_spent_today."
11120
11179
  },
11121
11180
  "tx_allowed_chains": {
11122
11181
  "type": "array",
@@ -11237,7 +11296,7 @@
11237
11296
  "additionalProperties": {
11238
11297
  "type": "string"
11239
11298
  },
11240
- "description": "Per-chain-family daily spend in major units (e.g. {\"ethereum\": \"0.5\", \"solana\": \"2.1\"})."
11299
+ "description": "Per-chain-family daily spend in native major units (keys: evm, bitcoin, solana, xrp, cardano, tron)."
11241
11300
  },
11242
11301
  "api_key_expires_at": {
11243
11302
  "type": "string",
package/openapi.yaml CHANGED
@@ -2,7 +2,7 @@ openapi: 3.1.0
2
2
 
3
3
  info:
4
4
  title: 1Claw API
5
- version: 2.24.0
5
+ version: 2.25.0
6
6
  description: |
7
7
  Secure secret management for AI agents. Provides vaults, secrets,
8
8
  policy-based access control, agent identity, Intents API,
@@ -779,6 +779,12 @@ paths:
779
779
  responses:
780
780
  "202":
781
781
  description: Approval request created
782
+ headers:
783
+ Location:
784
+ description: URL to poll for approval status
785
+ schema:
786
+ type: string
787
+ example: /v1/approvals/{id}
782
788
  content:
783
789
  application/json:
784
790
  schema:
@@ -1508,6 +1514,12 @@ paths:
1508
1514
  responses:
1509
1515
  "202":
1510
1516
  description: Rotation job started
1517
+ headers:
1518
+ Location:
1519
+ description: URL to poll for rotation job status
1520
+ schema:
1521
+ type: string
1522
+ example: /v1/vaults/{vault_id}/cmek-rotate/{job_id}
1511
1523
  content:
1512
1524
  application/json:
1513
1525
  schema:
@@ -7019,10 +7031,20 @@ components:
7019
7031
  type: array
7020
7032
  items:
7021
7033
  type: string
7034
+ tx_max_value:
7035
+ type: string
7036
+ description: Maximum value per transaction in native major units for the transacting chain family (ETH on EVM, BTC on Bitcoin, SOL on Solana, XRP, ADA, TRX).
7037
+ tx_daily_limit:
7038
+ type: string
7039
+ description: Rolling daily spend cap in native major units, enforced per chain family at signing time.
7022
7040
  tx_max_value_eth:
7023
7041
  type: string
7042
+ deprecated: true
7043
+ description: Deprecated alias for tx_max_value. Same unit semantics (native major units, not ETH-only).
7024
7044
  tx_daily_limit_eth:
7025
7045
  type: string
7046
+ deprecated: true
7047
+ description: Deprecated alias for tx_daily_limit.
7026
7048
  tx_allowed_chains:
7027
7049
  type: array
7028
7050
  items:
@@ -7070,9 +7092,9 @@ components:
7070
7092
  type: object
7071
7093
  additionalProperties: true
7072
7094
  description: |
7073
- Per-chain guardrail overrides. Keys are chain family names (ethereum, bitcoin, solana, etc.).
7074
- Each value can contain: max_value, daily_limit, to_allowlist, token_allowlist.
7075
- Example: { "ethereum": { "max_value": "0.5", "to_allowlist": ["0x..."] } }
7095
+ Per-chain guardrail overrides. Keys are signing chains (ethereum, bitcoin, solana, xrp, cardano, tron).
7096
+ Each value may include max_value, daily_limit, to_allowlist, token_allowlist (legacy *_eth keys accepted).
7097
+ Strictest of global and per-chain limits wins. Daily limits apply per chain family spend, not cross-chain totals.
7076
7098
  api_key_expires_at:
7077
7099
  type: string
7078
7100
  format: date-time
@@ -7099,10 +7121,20 @@ components:
7099
7121
  type: array
7100
7122
  items:
7101
7123
  type: string
7124
+ tx_max_value:
7125
+ type: string
7126
+ description: Maximum value per transaction in native major units for the transacting chain family (ETH on EVM, BTC on Bitcoin, SOL on Solana, XRP, ADA, TRX).
7127
+ tx_daily_limit:
7128
+ type: string
7129
+ description: Rolling daily spend cap in native major units, enforced per chain family at signing time.
7102
7130
  tx_max_value_eth:
7103
7131
  type: string
7132
+ deprecated: true
7133
+ description: Deprecated alias for tx_max_value. Same unit semantics (native major units, not ETH-only).
7104
7134
  tx_daily_limit_eth:
7105
7135
  type: string
7136
+ deprecated: true
7137
+ description: Deprecated alias for tx_daily_limit.
7106
7138
  tx_allowed_chains:
7107
7139
  type: array
7108
7140
  items:
@@ -7162,9 +7194,9 @@ components:
7162
7194
  type: object
7163
7195
  additionalProperties: true
7164
7196
  description: |
7165
- Per-chain guardrail overrides. Keys are chain family names (ethereum, bitcoin, solana, etc.).
7166
- Each value can contain: max_value, daily_limit, to_allowlist, token_allowlist.
7167
- Example: { "ethereum": { "max_value": "0.5", "to_allowlist": ["0x..."] } }
7197
+ Per-chain guardrail overrides. Keys are signing chains (ethereum, bitcoin, solana, xrp, cardano, tron).
7198
+ Each value may include max_value, daily_limit, to_allowlist, token_allowlist (legacy *_eth keys accepted).
7199
+ Strictest of global and per-chain limits wins. Daily limits apply per chain family spend, not cross-chain totals.
7168
7200
  api_key_expires_at:
7169
7201
  type: string
7170
7202
  format: date-time
@@ -7206,13 +7238,27 @@ components:
7206
7238
  type: array
7207
7239
  items:
7208
7240
  type: string
7241
+ tx_max_value:
7242
+ type: string
7243
+ description: Maximum value per transaction in native major units for the transacting chain family (ETH on EVM, BTC on Bitcoin, SOL on Solana, XRP, ADA, TRX).
7244
+ tx_daily_limit:
7245
+ type: string
7246
+ description: Rolling daily spend cap in native major units, enforced per chain family at signing time.
7209
7247
  tx_max_value_eth:
7210
7248
  type: string
7249
+ deprecated: true
7250
+ description: Deprecated alias for tx_max_value. Same unit semantics (native major units, not ETH-only).
7211
7251
  tx_daily_limit_eth:
7212
7252
  type: string
7253
+ deprecated: true
7254
+ description: Deprecated alias for tx_daily_limit.
7255
+ tx_spent_today:
7256
+ type: string
7257
+ description: Sum of today's spend across all chain families in major units. Prefer tx_spent_today_by_chain.
7213
7258
  tx_spent_today_eth:
7214
7259
  type: string
7215
- description: ETH value already spent today (UTC) from recorded transactions; used with daily limit guardrails
7260
+ deprecated: true
7261
+ description: Deprecated alias for tx_spent_today.
7216
7262
  tx_allowed_chains:
7217
7263
  type: array
7218
7264
  items:
@@ -7304,7 +7350,7 @@ components:
7304
7350
  type: object
7305
7351
  additionalProperties:
7306
7352
  type: string
7307
- description: 'Per-chain-family daily spend in major units (e.g. {"ethereum": "0.5", "solana": "2.1"}).'
7353
+ description: 'Per-chain-family daily spend in native major units (keys: evm, bitcoin, solana, xrp, cardano, tron).'
7308
7354
  api_key_expires_at:
7309
7355
  type: string
7310
7356
  format: date-time
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@1claw/openapi-spec",
3
- "version": "0.38.0",
3
+ "version": "0.39.1",
4
4
  "description": "OpenAPI 3.1.0 specification for the 1Claw Vault API — generate clients in any language",
5
5
  "license": "MIT",
6
6
  "repository": {