@1claw/openapi-spec 0.7.0 → 0.9.0

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.
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.2.0",
5
+ "version": "2.4.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"
@@ -22,6 +22,9 @@
22
22
  "description": "Shroud TEE Proxy (Intents API + LLM proxy)"
23
23
  }
24
24
  ],
25
+ "x-agentcash-guidance": {
26
+ "llmsTxtUrl": "https://1claw.xyz/llms.txt"
27
+ },
25
28
  "security": [
26
29
  {
27
30
  "BearerAuth": []
@@ -1152,6 +1155,16 @@
1152
1155
  ],
1153
1156
  "summary": "Store or update a secret",
1154
1157
  "operationId": "putSecret",
1158
+ "x-agentcash-auth": {
1159
+ "mode": "paid"
1160
+ },
1161
+ "x-payment-info": {
1162
+ "protocols": [
1163
+ "x402"
1164
+ ],
1165
+ "pricingMode": "fixed",
1166
+ "price": "0.0075"
1167
+ },
1155
1168
  "parameters": [
1156
1169
  {
1157
1170
  "$ref": "#/components/parameters/VaultId"
@@ -1183,6 +1196,9 @@
1183
1196
  },
1184
1197
  "400": {
1185
1198
  "$ref": "#/components/responses/BadRequest"
1199
+ },
1200
+ "402": {
1201
+ "$ref": "#/components/responses/PaymentRequired"
1186
1202
  }
1187
1203
  }
1188
1204
  },
@@ -1192,6 +1208,16 @@
1192
1208
  ],
1193
1209
  "summary": "Retrieve a decrypted secret",
1194
1210
  "operationId": "getSecret",
1211
+ "x-agentcash-auth": {
1212
+ "mode": "paid"
1213
+ },
1214
+ "x-payment-info": {
1215
+ "protocols": [
1216
+ "x402"
1217
+ ],
1218
+ "pricingMode": "fixed",
1219
+ "price": "0.0015"
1220
+ },
1195
1221
  "parameters": [
1196
1222
  {
1197
1223
  "$ref": "#/components/parameters/VaultId"
@@ -1637,6 +1663,15 @@
1637
1663
  "Transactions"
1638
1664
  ],
1639
1665
  "summary": "Submit a transaction for signing",
1666
+ "x-agentcash-auth": {
1667
+ "mode": "paid"
1668
+ },
1669
+ "x-payment-info": {
1670
+ "protocols": [
1671
+ "x402"
1672
+ ],
1673
+ "pricingMode": "quote"
1674
+ },
1640
1675
  "description": "Replay protection: send an optional **Idempotency-Key** header (e.g. UUID or opaque string).\nDuplicate requests with the same key within 24 hours return the cached transaction response\n(no second sign/broadcast). Omit the header for non-idempotent submissions.\n",
1641
1676
  "operationId": "submitTransaction",
1642
1677
  "parameters": [
@@ -1684,6 +1719,9 @@
1684
1719
  }
1685
1720
  }
1686
1721
  },
1722
+ "402": {
1723
+ "$ref": "#/components/responses/PaymentRequired"
1724
+ },
1687
1725
  "403": {
1688
1726
  "$ref": "#/components/responses/Forbidden"
1689
1727
  },
@@ -1785,6 +1823,16 @@
1785
1823
  ],
1786
1824
  "summary": "Simulate a transaction via Tenderly",
1787
1825
  "operationId": "simulateTransaction",
1826
+ "x-agentcash-auth": {
1827
+ "mode": "paid"
1828
+ },
1829
+ "x-payment-info": {
1830
+ "protocols": [
1831
+ "x402"
1832
+ ],
1833
+ "pricingMode": "fixed",
1834
+ "price": "0.075"
1835
+ },
1788
1836
  "parameters": [
1789
1837
  {
1790
1838
  "$ref": "#/components/parameters/AgentId"
@@ -1814,6 +1862,9 @@
1814
1862
  "400": {
1815
1863
  "$ref": "#/components/responses/BadRequest"
1816
1864
  },
1865
+ "402": {
1866
+ "$ref": "#/components/responses/PaymentRequired"
1867
+ },
1817
1868
  "403": {
1818
1869
  "$ref": "#/components/responses/Forbidden"
1819
1870
  }
@@ -1827,6 +1878,16 @@
1827
1878
  ],
1828
1879
  "summary": "Simulate a bundle of transactions",
1829
1880
  "operationId": "simulateBundle",
1881
+ "x-agentcash-auth": {
1882
+ "mode": "paid"
1883
+ },
1884
+ "x-payment-info": {
1885
+ "protocols": [
1886
+ "x402"
1887
+ ],
1888
+ "pricingMode": "fixed",
1889
+ "price": "0.075"
1890
+ },
1830
1891
  "parameters": [
1831
1892
  {
1832
1893
  "$ref": "#/components/parameters/AgentId"
@@ -1855,6 +1916,9 @@
1855
1916
  },
1856
1917
  "400": {
1857
1918
  "$ref": "#/components/responses/BadRequest"
1919
+ },
1920
+ "402": {
1921
+ "$ref": "#/components/responses/PaymentRequired"
1858
1922
  }
1859
1923
  }
1860
1924
  }
@@ -2039,6 +2103,16 @@
2039
2103
  ],
2040
2104
  "summary": "Create a share link for a secret",
2041
2105
  "operationId": "createShare",
2106
+ "x-agentcash-auth": {
2107
+ "mode": "paid"
2108
+ },
2109
+ "x-payment-info": {
2110
+ "protocols": [
2111
+ "x402"
2112
+ ],
2113
+ "pricingMode": "fixed",
2114
+ "price": "0.003"
2115
+ },
2042
2116
  "parameters": [
2043
2117
  {
2044
2118
  "name": "secret_id",
@@ -2071,6 +2145,9 @@
2071
2145
  }
2072
2146
  }
2073
2147
  },
2148
+ "402": {
2149
+ "$ref": "#/components/responses/PaymentRequired"
2150
+ },
2074
2151
  "404": {
2075
2152
  "$ref": "#/components/responses/NotFound"
2076
2153
  }
@@ -2085,6 +2162,16 @@
2085
2162
  "summary": "Access a shared secret",
2086
2163
  "operationId": "accessShare",
2087
2164
  "security": [],
2165
+ "x-agentcash-auth": {
2166
+ "mode": "paid"
2167
+ },
2168
+ "x-payment-info": {
2169
+ "protocols": [
2170
+ "x402"
2171
+ ],
2172
+ "pricingMode": "fixed",
2173
+ "price": "0.0015"
2174
+ },
2088
2175
  "parameters": [
2089
2176
  {
2090
2177
  "name": "share_id",
@@ -2617,6 +2704,16 @@
2617
2704
  ],
2618
2705
  "summary": "Query audit events",
2619
2706
  "operationId": "queryAuditEvents",
2707
+ "x-agentcash-auth": {
2708
+ "mode": "paid"
2709
+ },
2710
+ "x-payment-info": {
2711
+ "protocols": [
2712
+ "x402"
2713
+ ],
2714
+ "pricingMode": "fixed",
2715
+ "price": "0.0008"
2716
+ },
2620
2717
  "parameters": [
2621
2718
  {
2622
2719
  "name": "resource_id",
@@ -2682,6 +2779,9 @@
2682
2779
  }
2683
2780
  }
2684
2781
  }
2782
+ },
2783
+ "402": {
2784
+ "$ref": "#/components/responses/PaymentRequired"
2685
2785
  }
2686
2786
  }
2687
2787
  }
@@ -3020,7 +3120,7 @@
3020
3120
  ],
3021
3121
  "summary": "Set org billing tier (without Stripe)",
3022
3122
  "operationId": "adminSetBillingTier",
3023
- "description": "Manually set an organization's billing tier to free, pro, or business.\nFor testing and manual upgrades — does not create a Stripe subscription.\nSetting to \"pro\" or \"business\" sets period_end to +1 year.\nSetting to \"free\" clears subscription data.\n",
3123
+ "description": "Manually set an organization's billing tier to free, pro, business, or enterprise.\nFor testing, manual upgrades, and trial grants — does not create a Stripe subscription.\nSetting to \"pro\", \"business\", or \"enterprise\" sets period_end to now + duration_days (default 365).\nSetting to \"free\" clears subscription data. Use duration_days: 90 for a 3-month trial.\n",
3024
3124
  "parameters": [
3025
3125
  {
3026
3126
  "name": "org_id",
@@ -5576,8 +5676,15 @@
5576
5676
  "enum": [
5577
5677
  "free",
5578
5678
  "pro",
5579
- "business"
5679
+ "business",
5680
+ "enterprise"
5580
5681
  ]
5682
+ },
5683
+ "duration_days": {
5684
+ "type": "integer",
5685
+ "description": "How many days the tier lasts (default 365). Use 90 for a 3-month trial.",
5686
+ "minimum": 1,
5687
+ "maximum": 3650
5581
5688
  }
5582
5689
  }
5583
5690
  },
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.2.0
5
+ version: 2.4.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,
@@ -21,6 +21,9 @@ servers:
21
21
  - url: https://shroud.1claw.xyz
22
22
  description: Shroud TEE Proxy (Intents API + LLM proxy)
23
23
 
24
+ x-agentcash-guidance:
25
+ llmsTxtUrl: https://1claw.xyz/llms.txt
26
+
24
27
  security:
25
28
  - BearerAuth: []
26
29
 
@@ -745,6 +748,12 @@ paths:
745
748
  tags: [Secrets]
746
749
  summary: Store or update a secret
747
750
  operationId: putSecret
751
+ x-agentcash-auth:
752
+ mode: paid
753
+ x-payment-info:
754
+ protocols: [x402]
755
+ pricingMode: fixed
756
+ price: "0.0075"
748
757
  parameters:
749
758
  - $ref: "#/components/parameters/VaultId"
750
759
  - $ref: "#/components/parameters/SecretPath"
@@ -763,10 +772,18 @@ paths:
763
772
  $ref: "#/components/schemas/SecretMetadataResponse"
764
773
  "400":
765
774
  $ref: "#/components/responses/BadRequest"
775
+ "402":
776
+ $ref: "#/components/responses/PaymentRequired"
766
777
  get:
767
778
  tags: [Secrets]
768
779
  summary: Retrieve a decrypted secret
769
780
  operationId: getSecret
781
+ x-agentcash-auth:
782
+ mode: paid
783
+ x-payment-info:
784
+ protocols: [x402]
785
+ pricingMode: fixed
786
+ price: "0.0015"
770
787
  parameters:
771
788
  - $ref: "#/components/parameters/VaultId"
772
789
  - $ref: "#/components/parameters/SecretPath"
@@ -1047,6 +1064,11 @@ paths:
1047
1064
  post:
1048
1065
  tags: [Transactions]
1049
1066
  summary: Submit a transaction for signing
1067
+ x-agentcash-auth:
1068
+ mode: paid
1069
+ x-payment-info:
1070
+ protocols: [x402]
1071
+ pricingMode: quote
1050
1072
  description: |
1051
1073
  Replay protection: send an optional **Idempotency-Key** header (e.g. UUID or opaque string).
1052
1074
  Duplicate requests with the same key within 24 hours return the cached transaction response
@@ -1079,6 +1101,8 @@ paths:
1079
1101
  application/json:
1080
1102
  schema:
1081
1103
  $ref: "#/components/schemas/TransactionResponse"
1104
+ "402":
1105
+ $ref: "#/components/responses/PaymentRequired"
1082
1106
  "403":
1083
1107
  $ref: "#/components/responses/Forbidden"
1084
1108
  "409":
@@ -1137,6 +1161,12 @@ paths:
1137
1161
  tags: [Transactions]
1138
1162
  summary: Simulate a transaction via Tenderly
1139
1163
  operationId: simulateTransaction
1164
+ x-agentcash-auth:
1165
+ mode: paid
1166
+ x-payment-info:
1167
+ protocols: [x402]
1168
+ pricingMode: fixed
1169
+ price: "0.075"
1140
1170
  parameters:
1141
1171
  - $ref: "#/components/parameters/AgentId"
1142
1172
  requestBody:
@@ -1156,12 +1186,20 @@ paths:
1156
1186
  $ref: "#/components/responses/BadRequest"
1157
1187
  "403":
1158
1188
  $ref: "#/components/responses/Forbidden"
1189
+ "402":
1190
+ $ref: "#/components/responses/PaymentRequired"
1159
1191
 
1160
1192
  /v1/agents/{agent_id}/transactions/simulate-bundle:
1161
1193
  post:
1162
1194
  tags: [Transactions]
1163
1195
  summary: Simulate a bundle of transactions
1164
1196
  operationId: simulateBundle
1197
+ x-agentcash-auth:
1198
+ mode: paid
1199
+ x-payment-info:
1200
+ protocols: [x402]
1201
+ pricingMode: fixed
1202
+ price: "0.075"
1165
1203
  parameters:
1166
1204
  - $ref: "#/components/parameters/AgentId"
1167
1205
  requestBody:
@@ -1179,6 +1217,8 @@ paths:
1179
1217
  $ref: "#/components/schemas/BundleSimulationResponse"
1180
1218
  "400":
1181
1219
  $ref: "#/components/responses/BadRequest"
1220
+ "402":
1221
+ $ref: "#/components/responses/PaymentRequired"
1182
1222
 
1183
1223
  # ---------------------------------------------------------------------------
1184
1224
  # Chains
@@ -1300,6 +1340,12 @@ paths:
1300
1340
  tags: [Sharing]
1301
1341
  summary: Create a share link for a secret
1302
1342
  operationId: createShare
1343
+ x-agentcash-auth:
1344
+ mode: paid
1345
+ x-payment-info:
1346
+ protocols: [x402]
1347
+ pricingMode: fixed
1348
+ price: "0.003"
1303
1349
  parameters:
1304
1350
  - name: secret_id
1305
1351
  in: path
@@ -1320,6 +1366,8 @@ paths:
1320
1366
  application/json:
1321
1367
  schema:
1322
1368
  $ref: "#/components/schemas/ShareResponse"
1369
+ "402":
1370
+ $ref: "#/components/responses/PaymentRequired"
1323
1371
  "404":
1324
1372
  $ref: "#/components/responses/NotFound"
1325
1373
 
@@ -1329,6 +1377,12 @@ paths:
1329
1377
  summary: Access a shared secret
1330
1378
  operationId: accessShare
1331
1379
  security: []
1380
+ x-agentcash-auth:
1381
+ mode: paid
1382
+ x-payment-info:
1383
+ protocols: [x402]
1384
+ pricingMode: fixed
1385
+ price: "0.0015"
1332
1386
  parameters:
1333
1387
  - name: share_id
1334
1388
  in: path
@@ -1671,6 +1725,12 @@ paths:
1671
1725
  tags: [Audit]
1672
1726
  summary: Query audit events
1673
1727
  operationId: queryAuditEvents
1728
+ x-agentcash-auth:
1729
+ mode: paid
1730
+ x-payment-info:
1731
+ protocols: [x402]
1732
+ pricingMode: fixed
1733
+ price: "0.0008"
1674
1734
  parameters:
1675
1735
  - name: resource_id
1676
1736
  in: query
@@ -1711,6 +1771,8 @@ paths:
1711
1771
  application/json:
1712
1772
  schema:
1713
1773
  $ref: "#/components/schemas/AuditEventsResponse"
1774
+ "402":
1775
+ $ref: "#/components/responses/PaymentRequired"
1714
1776
 
1715
1777
  # ---------------------------------------------------------------------------
1716
1778
  # Security (IP Rules)
@@ -1926,10 +1988,10 @@ paths:
1926
1988
  summary: Set org billing tier (without Stripe)
1927
1989
  operationId: adminSetBillingTier
1928
1990
  description: |
1929
- Manually set an organization's billing tier to free, pro, or business.
1930
- For testing and manual upgrades — does not create a Stripe subscription.
1931
- Setting to "pro" or "business" sets period_end to +1 year.
1932
- Setting to "free" clears subscription data.
1991
+ Manually set an organization's billing tier to free, pro, business, or enterprise.
1992
+ For testing, manual upgrades, and trial grants — does not create a Stripe subscription.
1993
+ Setting to "pro", "business", or "enterprise" sets period_end to now + duration_days (default 365).
1994
+ Setting to "free" clears subscription data. Use duration_days: 90 for a 3-month trial.
1933
1995
  parameters:
1934
1996
  - name: org_id
1935
1997
  in: path
@@ -3695,7 +3757,12 @@ components:
3695
3757
  properties:
3696
3758
  tier:
3697
3759
  type: string
3698
- enum: [free, pro, business]
3760
+ enum: [free, pro, business, enterprise]
3761
+ duration_days:
3762
+ type: integer
3763
+ description: How many days the tier lasts (default 365). Use 90 for a 3-month trial.
3764
+ minimum: 1
3765
+ maximum: 3650
3699
3766
 
3700
3767
  # --- x402 ---
3701
3768
 
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@1claw/openapi-spec",
3
- "version": "0.7.0",
3
+ "version": "0.9.0",
4
4
  "description": "OpenAPI 3.1.0 specification for the 1Claw Vault API — generate clients in any language",
5
5
  "license": "PolyForm-Noncommercial-1.0.0",
6
6
  "repository": {