@1claw/openapi-spec 0.58.2 → 0.59.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.
Files changed (3) hide show
  1. package/openapi.json +290 -7
  2. package/openapi.yaml +192 -4
  3. package/package.json +1 -1
package/openapi.json CHANGED
@@ -10331,9 +10331,17 @@
10331
10331
  "content": {
10332
10332
  "application/json": {
10333
10333
  "schema": {
10334
- "type": "array",
10335
- "items": {
10336
- "$ref": "#/components/schemas/PlatformConnectedUserResponse"
10334
+ "type": "object",
10335
+ "required": [
10336
+ "users"
10337
+ ],
10338
+ "properties": {
10339
+ "users": {
10340
+ "type": "array",
10341
+ "items": {
10342
+ "$ref": "#/components/schemas/PlatformConnectedUserResponse"
10343
+ }
10344
+ }
10337
10345
  }
10338
10346
  }
10339
10347
  }
@@ -11921,6 +11929,150 @@
11921
11929
  }
11922
11930
  }
11923
11931
  },
11932
+ "/v1/platform/connections/{connectionId}/runtimes/{runtimeId}": {
11933
+ "get": {
11934
+ "tags": [
11935
+ "Platform"
11936
+ ],
11937
+ "summary": "Get a connection runtime (plt_ scoped)",
11938
+ "description": "Returns a runtime provisioned on this connection. Use instead of\n`GET /v1/runtimes/{id}` with a plt_ key (which resolves to the platform org).\n",
11939
+ "operationId": "getConnectionRuntime",
11940
+ "security": [
11941
+ {
11942
+ "BearerAuth": []
11943
+ }
11944
+ ],
11945
+ "parameters": [
11946
+ {
11947
+ "in": "path",
11948
+ "name": "connectionId",
11949
+ "required": true,
11950
+ "schema": {
11951
+ "type": "string",
11952
+ "format": "uuid"
11953
+ }
11954
+ },
11955
+ {
11956
+ "in": "path",
11957
+ "name": "runtimeId",
11958
+ "required": true,
11959
+ "schema": {
11960
+ "type": "string",
11961
+ "format": "uuid"
11962
+ }
11963
+ }
11964
+ ],
11965
+ "responses": {
11966
+ "200": {
11967
+ "description": "Runtime details",
11968
+ "content": {
11969
+ "application/json": {
11970
+ "schema": {
11971
+ "$ref": "#/components/schemas/RuntimeResponse"
11972
+ }
11973
+ }
11974
+ }
11975
+ },
11976
+ "404": {
11977
+ "$ref": "#/components/responses/NotFound"
11978
+ }
11979
+ }
11980
+ }
11981
+ },
11982
+ "/v1/platform/connections/{connectionId}/passkeys/enroll/begin": {
11983
+ "post": {
11984
+ "tags": [
11985
+ "Platform"
11986
+ ],
11987
+ "summary": "Begin passkey enrollment for a connected user",
11988
+ "description": "Starts WebAuthn registration for the end-user on this connection.\nPlatform apps use this instead of `POST /v1/auth/passkeys/register/begin` (user JWT only).\n",
11989
+ "operationId": "connectionPasskeyEnrollBegin",
11990
+ "security": [
11991
+ {
11992
+ "BearerAuth": []
11993
+ }
11994
+ ],
11995
+ "parameters": [
11996
+ {
11997
+ "in": "path",
11998
+ "name": "connectionId",
11999
+ "required": true,
12000
+ "schema": {
12001
+ "type": "string",
12002
+ "format": "uuid"
12003
+ }
12004
+ }
12005
+ ],
12006
+ "responses": {
12007
+ "200": {
12008
+ "description": "WebAuthn registration ceremony options",
12009
+ "content": {
12010
+ "application/json": {
12011
+ "schema": {
12012
+ "$ref": "#/components/schemas/PasskeyRegisterBeginResponse"
12013
+ }
12014
+ }
12015
+ }
12016
+ },
12017
+ "404": {
12018
+ "$ref": "#/components/responses/NotFound"
12019
+ }
12020
+ }
12021
+ }
12022
+ },
12023
+ "/v1/platform/connections/{connectionId}/passkeys/enroll/complete": {
12024
+ "post": {
12025
+ "tags": [
12026
+ "Platform"
12027
+ ],
12028
+ "summary": "Complete passkey enrollment for a connected user",
12029
+ "operationId": "connectionPasskeyEnrollComplete",
12030
+ "security": [
12031
+ {
12032
+ "BearerAuth": []
12033
+ }
12034
+ ],
12035
+ "parameters": [
12036
+ {
12037
+ "in": "path",
12038
+ "name": "connectionId",
12039
+ "required": true,
12040
+ "schema": {
12041
+ "type": "string",
12042
+ "format": "uuid"
12043
+ }
12044
+ }
12045
+ ],
12046
+ "requestBody": {
12047
+ "required": true,
12048
+ "content": {
12049
+ "application/json": {
12050
+ "schema": {
12051
+ "$ref": "#/components/schemas/PasskeyRegisterCompleteRequest"
12052
+ }
12053
+ }
12054
+ }
12055
+ },
12056
+ "responses": {
12057
+ "201": {
12058
+ "description": "Passkey registered",
12059
+ "content": {
12060
+ "application/json": {
12061
+ "schema": {
12062
+ "$ref": "#/components/schemas/PasskeyRegisterCompleteResponse"
12063
+ }
12064
+ }
12065
+ }
12066
+ },
12067
+ "400": {
12068
+ "$ref": "#/components/responses/BadRequest"
12069
+ },
12070
+ "404": {
12071
+ "$ref": "#/components/responses/NotFound"
12072
+ }
12073
+ }
12074
+ }
12075
+ },
11924
12076
  "/v1/platform/connections/{connectionId}/agents/{agentId}/chat": {
11925
12077
  "post": {
11926
12078
  "tags": [
@@ -11968,6 +12120,9 @@
11968
12120
  "200": {
11969
12121
  "description": "Message sent (JSON or SSE stream)"
11970
12122
  },
12123
+ "402": {
12124
+ "description": "Payment required (LLM billing / inference allowance)"
12125
+ },
11971
12126
  "403": {
11972
12127
  "$ref": "#/components/responses/Forbidden"
11973
12128
  },
@@ -20545,6 +20700,10 @@
20545
20700
  "shroud_config": {
20546
20701
  "$ref": "#/components/schemas/ShroudConfig"
20547
20702
  },
20703
+ "system_prompt": {
20704
+ "type": "string",
20705
+ "description": "Default system prompt for agent chat when requests do not override it."
20706
+ },
20548
20707
  "execution_intents_enabled": {
20549
20708
  "type": "boolean",
20550
20709
  "default": false,
@@ -20811,6 +20970,11 @@
20811
20970
  "shroud_config": {
20812
20971
  "$ref": "#/components/schemas/ShroudConfig"
20813
20972
  },
20973
+ "system_prompt": {
20974
+ "type": "string",
20975
+ "nullable": true,
20976
+ "description": "Default system prompt for agent chat (null clears)."
20977
+ },
20814
20978
  "execution_intents_enabled": {
20815
20979
  "type": "boolean",
20816
20980
  "description": "Enable/disable Execution Intents for this agent"
@@ -21154,6 +21318,10 @@
21154
21318
  "shroud_config": {
21155
21319
  "$ref": "#/components/schemas/ShroudConfig"
21156
21320
  },
21321
+ "system_prompt": {
21322
+ "type": "string",
21323
+ "description": "Default system prompt for agent chat when requests do not override it."
21324
+ },
21157
21325
  "execution_intents_enabled": {
21158
21326
  "type": "boolean",
21159
21327
  "description": "Whether Execution Intents (bindings and execute endpoint) are enabled for this agent"
@@ -27256,6 +27424,11 @@
27256
27424
  "entitlement_status": {
27257
27425
  "type": "string"
27258
27426
  },
27427
+ "provisioned_tier": {
27428
+ "type": "string",
27429
+ "nullable": true,
27430
+ "description": "Billing tier granted to the end-user org when billing_model is platform_pays\n(from template plan at bootstrap). Null when not provisioned.\n"
27431
+ },
27259
27432
  "wallet_address": {
27260
27433
  "type": "string",
27261
27434
  "nullable": true
@@ -27664,6 +27837,84 @@
27664
27837
  }
27665
27838
  }
27666
27839
  },
27840
+ "PasskeyRegisterBeginResponse": {
27841
+ "type": "object",
27842
+ "properties": {
27843
+ "challenge": {
27844
+ "type": "string"
27845
+ },
27846
+ "rp_id": {
27847
+ "type": "string"
27848
+ },
27849
+ "rp_name": {
27850
+ "type": "string"
27851
+ },
27852
+ "user_id": {
27853
+ "type": "string"
27854
+ },
27855
+ "user_name": {
27856
+ "type": "string"
27857
+ },
27858
+ "user_display_name": {
27859
+ "type": "string"
27860
+ },
27861
+ "attestation": {
27862
+ "type": "string"
27863
+ },
27864
+ "authenticator_selection": {
27865
+ "type": "object"
27866
+ },
27867
+ "pub_key_cred_params": {
27868
+ "type": "array",
27869
+ "items": {
27870
+ "type": "object"
27871
+ }
27872
+ }
27873
+ }
27874
+ },
27875
+ "PasskeyRegisterCompleteRequest": {
27876
+ "type": "object",
27877
+ "required": [
27878
+ "credential_id",
27879
+ "attestation_object",
27880
+ "client_data_json"
27881
+ ],
27882
+ "properties": {
27883
+ "credential_id": {
27884
+ "type": "string"
27885
+ },
27886
+ "attestation_object": {
27887
+ "type": "string"
27888
+ },
27889
+ "client_data_json": {
27890
+ "type": "string"
27891
+ },
27892
+ "transports": {
27893
+ "type": "array",
27894
+ "items": {
27895
+ "type": "string"
27896
+ }
27897
+ },
27898
+ "name": {
27899
+ "type": "string"
27900
+ }
27901
+ }
27902
+ },
27903
+ "PasskeyRegisterCompleteResponse": {
27904
+ "type": "object",
27905
+ "properties": {
27906
+ "passkey_id": {
27907
+ "type": "string",
27908
+ "format": "uuid"
27909
+ },
27910
+ "credential_id": {
27911
+ "type": "string"
27912
+ },
27913
+ "name": {
27914
+ "type": "string"
27915
+ }
27916
+ }
27917
+ },
27667
27918
  "PasskeyTxAssertBeginRequest": {
27668
27919
  "type": "object",
27669
27920
  "required": [
@@ -29758,12 +30009,10 @@
29758
30009
  },
29759
30010
  "SendChatMessageRequest": {
29760
30011
  "type": "object",
29761
- "required": [
29762
- "message"
29763
- ],
29764
30012
  "properties": {
29765
30013
  "message": {
29766
- "type": "string"
30014
+ "type": "string",
30015
+ "description": "User message text. Optional when `messages` includes a user turn."
29767
30016
  },
29768
30017
  "conversation_id": {
29769
30018
  "type": "string",
@@ -29779,6 +30028,40 @@
29779
30028
  "type": "string"
29780
30029
  },
29781
30030
  "system_prompt": {
30031
+ "type": "string",
30032
+ "description": "Stored on new conversations when `conversation_id` is omitted."
30033
+ },
30034
+ "system": {
30035
+ "type": "string",
30036
+ "description": "Per-request system prompt alias (same precedence as `system_prompt_override`)."
30037
+ },
30038
+ "system_prompt_override": {
30039
+ "type": "string",
30040
+ "description": "Per-request override; highest precedence except inline `messages` system role."
30041
+ },
30042
+ "messages": {
30043
+ "type": "array",
30044
+ "description": "Optional OpenAI-shaped history. When set, used for LLM context instead of DB history.",
30045
+ "items": {
30046
+ "type": "object",
30047
+ "required": [
30048
+ "role",
30049
+ "content"
30050
+ ],
30051
+ "properties": {
30052
+ "role": {
30053
+ "type": "string"
30054
+ },
30055
+ "content": {
30056
+ "type": "string"
30057
+ }
30058
+ }
30059
+ }
30060
+ },
30061
+ "llm_api_key_vault_id": {
30062
+ "type": "string"
30063
+ },
30064
+ "llm_api_key_path": {
29782
30065
  "type": "string"
29783
30066
  }
29784
30067
  }
package/openapi.yaml CHANGED
@@ -6641,9 +6641,13 @@ paths:
6641
6641
  content:
6642
6642
  application/json:
6643
6643
  schema:
6644
- type: array
6645
- items:
6646
- $ref: "#/components/schemas/PlatformConnectedUserResponse"
6644
+ type: object
6645
+ required: [users]
6646
+ properties:
6647
+ users:
6648
+ type: array
6649
+ items:
6650
+ $ref: "#/components/schemas/PlatformConnectedUserResponse"
6647
6651
 
6648
6652
  /v1/platform/connections/{connectionId}/bootstrap:
6649
6653
  post:
@@ -7646,6 +7650,98 @@ paths:
7646
7650
  "404":
7647
7651
  $ref: "#/components/responses/NotFound"
7648
7652
 
7653
+ /v1/platform/connections/{connectionId}/runtimes/{runtimeId}:
7654
+ get:
7655
+ tags: [Platform]
7656
+ summary: Get a connection runtime (plt_ scoped)
7657
+ description: |
7658
+ Returns a runtime provisioned on this connection. Use instead of
7659
+ `GET /v1/runtimes/{id}` with a plt_ key (which resolves to the platform org).
7660
+ operationId: getConnectionRuntime
7661
+ security:
7662
+ - BearerAuth: []
7663
+ parameters:
7664
+ - in: path
7665
+ name: connectionId
7666
+ required: true
7667
+ schema:
7668
+ type: string
7669
+ format: uuid
7670
+ - in: path
7671
+ name: runtimeId
7672
+ required: true
7673
+ schema:
7674
+ type: string
7675
+ format: uuid
7676
+ responses:
7677
+ "200":
7678
+ description: Runtime details
7679
+ content:
7680
+ application/json:
7681
+ schema:
7682
+ $ref: "#/components/schemas/RuntimeResponse"
7683
+ "404":
7684
+ $ref: "#/components/responses/NotFound"
7685
+
7686
+ /v1/platform/connections/{connectionId}/passkeys/enroll/begin:
7687
+ post:
7688
+ tags: [Platform]
7689
+ summary: Begin passkey enrollment for a connected user
7690
+ description: |
7691
+ Starts WebAuthn registration for the end-user on this connection.
7692
+ Platform apps use this instead of `POST /v1/auth/passkeys/register/begin` (user JWT only).
7693
+ operationId: connectionPasskeyEnrollBegin
7694
+ security:
7695
+ - BearerAuth: []
7696
+ parameters:
7697
+ - in: path
7698
+ name: connectionId
7699
+ required: true
7700
+ schema:
7701
+ type: string
7702
+ format: uuid
7703
+ responses:
7704
+ "200":
7705
+ description: WebAuthn registration ceremony options
7706
+ content:
7707
+ application/json:
7708
+ schema:
7709
+ $ref: "#/components/schemas/PasskeyRegisterBeginResponse"
7710
+ "404":
7711
+ $ref: "#/components/responses/NotFound"
7712
+
7713
+ /v1/platform/connections/{connectionId}/passkeys/enroll/complete:
7714
+ post:
7715
+ tags: [Platform]
7716
+ summary: Complete passkey enrollment for a connected user
7717
+ operationId: connectionPasskeyEnrollComplete
7718
+ security:
7719
+ - BearerAuth: []
7720
+ parameters:
7721
+ - in: path
7722
+ name: connectionId
7723
+ required: true
7724
+ schema:
7725
+ type: string
7726
+ format: uuid
7727
+ requestBody:
7728
+ required: true
7729
+ content:
7730
+ application/json:
7731
+ schema:
7732
+ $ref: "#/components/schemas/PasskeyRegisterCompleteRequest"
7733
+ responses:
7734
+ "201":
7735
+ description: Passkey registered
7736
+ content:
7737
+ application/json:
7738
+ schema:
7739
+ $ref: "#/components/schemas/PasskeyRegisterCompleteResponse"
7740
+ "400":
7741
+ $ref: "#/components/responses/BadRequest"
7742
+ "404":
7743
+ $ref: "#/components/responses/NotFound"
7744
+
7649
7745
  /v1/platform/connections/{connectionId}/agents/{agentId}/chat:
7650
7746
  post:
7651
7747
  tags: [Platform]
@@ -7678,6 +7774,8 @@ paths:
7678
7774
  responses:
7679
7775
  "200":
7680
7776
  description: Message sent (JSON or SSE stream)
7777
+ "402":
7778
+ description: Payment required (LLM billing / inference allowance)
7681
7779
  "403":
7682
7780
  $ref: "#/components/responses/Forbidden"
7683
7781
  "404":
@@ -13218,6 +13316,9 @@ components:
13218
13316
  description: Enable Shroud LLM Proxy for this agent
13219
13317
  shroud_config:
13220
13318
  $ref: "#/components/schemas/ShroudConfig"
13319
+ system_prompt:
13320
+ type: string
13321
+ description: Default system prompt for agent chat when requests do not override it.
13221
13322
  execution_intents_enabled:
13222
13323
  type: boolean
13223
13324
  default: false
@@ -13421,6 +13522,10 @@ components:
13421
13522
  description: Enable/disable Shroud LLM Proxy
13422
13523
  shroud_config:
13423
13524
  $ref: "#/components/schemas/ShroudConfig"
13525
+ system_prompt:
13526
+ type: string
13527
+ nullable: true
13528
+ description: Default system prompt for agent chat (null clears).
13424
13529
  execution_intents_enabled:
13425
13530
  type: boolean
13426
13531
  description: Enable/disable Execution Intents for this agent
@@ -13691,6 +13796,9 @@ components:
13691
13796
  description: Whether this agent routes LLM traffic through the Shroud TEE proxy
13692
13797
  shroud_config:
13693
13798
  $ref: "#/components/schemas/ShroudConfig"
13799
+ system_prompt:
13800
+ type: string
13801
+ description: Default system prompt for agent chat when requests do not override it.
13694
13802
  execution_intents_enabled:
13695
13803
  type: boolean
13696
13804
  description: Whether Execution Intents (bindings and execute endpoint) are enabled for this agent
@@ -17947,6 +18055,12 @@ components:
17947
18055
  type: string
17948
18056
  entitlement_status:
17949
18057
  type: string
18058
+ provisioned_tier:
18059
+ type: string
18060
+ nullable: true
18061
+ description: |
18062
+ Billing tier granted to the end-user org when billing_model is platform_pays
18063
+ (from template plan at bootstrap). Null when not provisioned.
17950
18064
  wallet_address:
17951
18065
  type: string
17952
18066
  nullable: true
@@ -18210,6 +18324,58 @@ components:
18210
18324
  minimum: 0
18211
18325
  description: Number of WebAuthn passkeys registered for the calling user.
18212
18326
 
18327
+ PasskeyRegisterBeginResponse:
18328
+ type: object
18329
+ properties:
18330
+ challenge:
18331
+ type: string
18332
+ rp_id:
18333
+ type: string
18334
+ rp_name:
18335
+ type: string
18336
+ user_id:
18337
+ type: string
18338
+ user_name:
18339
+ type: string
18340
+ user_display_name:
18341
+ type: string
18342
+ attestation:
18343
+ type: string
18344
+ authenticator_selection:
18345
+ type: object
18346
+ pub_key_cred_params:
18347
+ type: array
18348
+ items:
18349
+ type: object
18350
+
18351
+ PasskeyRegisterCompleteRequest:
18352
+ type: object
18353
+ required: [credential_id, attestation_object, client_data_json]
18354
+ properties:
18355
+ credential_id:
18356
+ type: string
18357
+ attestation_object:
18358
+ type: string
18359
+ client_data_json:
18360
+ type: string
18361
+ transports:
18362
+ type: array
18363
+ items:
18364
+ type: string
18365
+ name:
18366
+ type: string
18367
+
18368
+ PasskeyRegisterCompleteResponse:
18369
+ type: object
18370
+ properties:
18371
+ passkey_id:
18372
+ type: string
18373
+ format: uuid
18374
+ credential_id:
18375
+ type: string
18376
+ name:
18377
+ type: string
18378
+
18213
18379
  PasskeyTxAssertBeginRequest:
18214
18380
  type: object
18215
18381
  required: [tx_digest]
@@ -19558,10 +19724,10 @@ components:
19558
19724
 
19559
19725
  SendChatMessageRequest:
19560
19726
  type: object
19561
- required: [message]
19562
19727
  properties:
19563
19728
  message:
19564
19729
  type: string
19730
+ description: User message text. Optional when `messages` includes a user turn.
19565
19731
  conversation_id:
19566
19732
  type: string
19567
19733
  format: uuid
@@ -19573,6 +19739,28 @@ components:
19573
19739
  type: string
19574
19740
  system_prompt:
19575
19741
  type: string
19742
+ description: Stored on new conversations when `conversation_id` is omitted.
19743
+ system:
19744
+ type: string
19745
+ description: Per-request system prompt alias (same precedence as `system_prompt_override`).
19746
+ system_prompt_override:
19747
+ type: string
19748
+ description: Per-request override; highest precedence except inline `messages` system role.
19749
+ messages:
19750
+ type: array
19751
+ description: Optional OpenAI-shaped history. When set, used for LLM context instead of DB history.
19752
+ items:
19753
+ type: object
19754
+ required: [role, content]
19755
+ properties:
19756
+ role:
19757
+ type: string
19758
+ content:
19759
+ type: string
19760
+ llm_api_key_vault_id:
19761
+ type: string
19762
+ llm_api_key_path:
19763
+ type: string
19576
19764
 
19577
19765
  ChatMessageResponse:
19578
19766
  type: object
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@1claw/openapi-spec",
3
- "version": "0.58.2",
3
+ "version": "0.59.0",
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": {