@1claw/openapi-spec 0.43.2 → 0.43.4

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 +204 -3
  2. package/openapi.yaml +147 -2
  3. package/package.json +1 -1
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.31.0",
5
+ "version": "2.32.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. Automations (workflow_spec,\nwebhook tokens, event triggers, Assist), cloud runtimes with\ninteractive shell sessions, agent memory, and discovery.\n\nAll endpoints require JWT Bearer authentication unless marked with\n`security: []`.\n",
7
7
  "contact": {
8
8
  "email": "ops@1claw.xyz"
@@ -10825,6 +10825,80 @@
10825
10825
  }
10826
10826
  }
10827
10827
  },
10828
+ "/v1/automations/{automationId}/runs/{runId}/cancel": {
10829
+ "post": {
10830
+ "tags": [
10831
+ "Automations"
10832
+ ],
10833
+ "summary": "Cancel a running automation run",
10834
+ "operationId": "cancelAutomationRun",
10835
+ "description": "Cancel a run that is currently in `running` or `awaiting_approval` status.\nReturns the updated run with status `cancelled`.\n",
10836
+ "parameters": [
10837
+ {
10838
+ "name": "automationId",
10839
+ "in": "path",
10840
+ "required": true,
10841
+ "schema": {
10842
+ "type": "string",
10843
+ "format": "uuid"
10844
+ }
10845
+ },
10846
+ {
10847
+ "name": "runId",
10848
+ "in": "path",
10849
+ "required": true,
10850
+ "schema": {
10851
+ "type": "string",
10852
+ "format": "uuid"
10853
+ }
10854
+ }
10855
+ ],
10856
+ "responses": {
10857
+ "200": {
10858
+ "description": "Run cancelled",
10859
+ "content": {
10860
+ "application/json": {
10861
+ "schema": {
10862
+ "$ref": "#/components/schemas/AutomationRunResponse"
10863
+ }
10864
+ }
10865
+ }
10866
+ },
10867
+ "400": {
10868
+ "$ref": "#/components/responses/BadRequest"
10869
+ },
10870
+ "401": {
10871
+ "$ref": "#/components/responses/Unauthorized"
10872
+ },
10873
+ "404": {
10874
+ "$ref": "#/components/responses/NotFound"
10875
+ }
10876
+ }
10877
+ }
10878
+ },
10879
+ "/v1/automations/presets": {
10880
+ "get": {
10881
+ "tags": [
10882
+ "Automations"
10883
+ ],
10884
+ "summary": "List automation presets",
10885
+ "operationId": "listAutomationPresets",
10886
+ "security": [],
10887
+ "description": "Public preset gallery of ready-to-use automation templates.",
10888
+ "responses": {
10889
+ "200": {
10890
+ "description": "Automation preset list",
10891
+ "content": {
10892
+ "application/json": {
10893
+ "schema": {
10894
+ "$ref": "#/components/schemas/AutomationPresetsResponse"
10895
+ }
10896
+ }
10897
+ }
10898
+ }
10899
+ }
10900
+ }
10901
+ },
10828
10902
  "/v1/runtimes": {
10829
10903
  "post": {
10830
10904
  "tags": [
@@ -11281,6 +11355,67 @@
11281
11355
  }
11282
11356
  }
11283
11357
  },
11358
+ "/v1/runtimes/{runtimeId}/chat": {
11359
+ "post": {
11360
+ "tags": [
11361
+ "Runtimes"
11362
+ ],
11363
+ "summary": "Chat with a running runtime agent",
11364
+ "description": "Human-only. Proxies to the runtime container's OpenAI-compatible\n`POST /v1/chat/completions` (hermes / openclaw / openclaude chat bridge).\nStarts the runtime if stopped. Streams SSE when `Accept: text/event-stream`\nor `stream: true`. Conversation history is ephemeral (pass `messages`).\nRequires a public URL (shell access, Shroud sidecar, or HTTP hosting).\n",
11365
+ "operationId": "runtimeChat",
11366
+ "parameters": [
11367
+ {
11368
+ "name": "runtimeId",
11369
+ "in": "path",
11370
+ "required": true,
11371
+ "schema": {
11372
+ "type": "string",
11373
+ "format": "uuid"
11374
+ }
11375
+ }
11376
+ ],
11377
+ "requestBody": {
11378
+ "required": true,
11379
+ "content": {
11380
+ "application/json": {
11381
+ "schema": {
11382
+ "$ref": "#/components/schemas/RuntimeChatRequest"
11383
+ }
11384
+ }
11385
+ }
11386
+ },
11387
+ "responses": {
11388
+ "200": {
11389
+ "description": "Chat completion (JSON) or SSE stream",
11390
+ "content": {
11391
+ "application/json": {
11392
+ "schema": {
11393
+ "type": "object",
11394
+ "additionalProperties": true
11395
+ }
11396
+ },
11397
+ "text/event-stream": {
11398
+ "schema": {
11399
+ "type": "string"
11400
+ }
11401
+ }
11402
+ }
11403
+ },
11404
+ "400": {
11405
+ "$ref": "#/components/responses/BadRequest"
11406
+ },
11407
+ "401": {
11408
+ "$ref": "#/components/responses/Unauthorized"
11409
+ },
11410
+ "403": {
11411
+ "$ref": "#/components/responses/Forbidden"
11412
+ },
11413
+ "404": {
11414
+ "$ref": "#/components/responses/NotFound"
11415
+ }
11416
+ }
11417
+ }
11418
+ },
11284
11419
  "/v1/agents/{agent_id}/memory": {
11285
11420
  "get": {
11286
11421
  "tags": [
@@ -20263,7 +20398,7 @@
20263
20398
  "nullable": true
20264
20399
  },
20265
20400
  "workflow_spec": {
20266
- "description": "Workflow steps. Accepts a bare array `[...]` or\n`{ \"steps\": [...] }` (dashboard / preset shape).\n",
20401
+ "description": "Workflow steps. Accepts a bare array `[...]` or\n`{ \"steps\": [...] }` (dashboard / preset shape).\nSupported step types: get_secret, put_secret, http_request,\nrotate_secret, notify_human, ai_generate, memory_get,\nmemory_put, memory_search, notify, approval_request,\ncondition, execute_binding.\n",
20267
20402
  "oneOf": [
20268
20403
  {
20269
20404
  "type": "array",
@@ -20533,7 +20668,9 @@
20533
20668
  "running",
20534
20669
  "completed",
20535
20670
  "failed",
20536
- "denied"
20671
+ "denied",
20672
+ "cancelled",
20673
+ "awaiting_approval"
20537
20674
  ]
20538
20675
  },
20539
20676
  "step_results": {
@@ -20578,6 +20715,42 @@
20578
20715
  }
20579
20716
  }
20580
20717
  },
20718
+ "AutomationPresetsResponse": {
20719
+ "type": "object",
20720
+ "required": [
20721
+ "presets"
20722
+ ],
20723
+ "properties": {
20724
+ "presets": {
20725
+ "type": "array",
20726
+ "items": {
20727
+ "type": "object",
20728
+ "properties": {
20729
+ "id": {
20730
+ "type": "string"
20731
+ },
20732
+ "name": {
20733
+ "type": "string"
20734
+ },
20735
+ "description": {
20736
+ "type": "string"
20737
+ },
20738
+ "trigger_type": {
20739
+ "type": "string"
20740
+ },
20741
+ "cron_expr": {
20742
+ "type": "string",
20743
+ "nullable": true
20744
+ },
20745
+ "workflow_spec": {
20746
+ "type": "object",
20747
+ "additionalProperties": true
20748
+ }
20749
+ }
20750
+ }
20751
+ }
20752
+ }
20753
+ },
20581
20754
  "CreateRuntimeRequest": {
20582
20755
  "type": "object",
20583
20756
  "required": [
@@ -20884,6 +21057,34 @@
20884
21057
  }
20885
21058
  }
20886
21059
  },
21060
+ "RuntimeChatRequest": {
21061
+ "type": "object",
21062
+ "description": "Chat with the agent inside a runtime. Provide `message` and/or\na full OpenAI-style `messages` array (ephemeral history).\n",
21063
+ "properties": {
21064
+ "message": {
21065
+ "type": "string",
21066
+ "description": "Latest user message"
21067
+ },
21068
+ "messages": {
21069
+ "type": "array",
21070
+ "items": {
21071
+ "type": "object",
21072
+ "additionalProperties": true
21073
+ },
21074
+ "description": "OpenAI chat messages (optional history)"
21075
+ },
21076
+ "model": {
21077
+ "type": "string"
21078
+ },
21079
+ "provider": {
21080
+ "type": "string"
21081
+ },
21082
+ "stream": {
21083
+ "type": "boolean",
21084
+ "description": "Request SSE streaming (default true when Accept is text/event-stream)"
21085
+ }
21086
+ }
21087
+ },
20887
21088
  "MemoryEntry": {
20888
21089
  "type": "object",
20889
21090
  "required": [
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.31.0
5
+ version: 2.32.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,
@@ -6892,6 +6892,56 @@ paths:
6892
6892
  "404":
6893
6893
  $ref: "#/components/responses/NotFound"
6894
6894
 
6895
+ /v1/automations/{automationId}/runs/{runId}/cancel:
6896
+ post:
6897
+ tags: [Automations]
6898
+ summary: Cancel a running automation run
6899
+ operationId: cancelAutomationRun
6900
+ description: |
6901
+ Cancel a run that is currently in `running` or `awaiting_approval` status.
6902
+ Returns the updated run with status `cancelled`.
6903
+ parameters:
6904
+ - name: automationId
6905
+ in: path
6906
+ required: true
6907
+ schema:
6908
+ type: string
6909
+ format: uuid
6910
+ - name: runId
6911
+ in: path
6912
+ required: true
6913
+ schema:
6914
+ type: string
6915
+ format: uuid
6916
+ responses:
6917
+ "200":
6918
+ description: Run cancelled
6919
+ content:
6920
+ application/json:
6921
+ schema:
6922
+ $ref: "#/components/schemas/AutomationRunResponse"
6923
+ "400":
6924
+ $ref: "#/components/responses/BadRequest"
6925
+ "401":
6926
+ $ref: "#/components/responses/Unauthorized"
6927
+ "404":
6928
+ $ref: "#/components/responses/NotFound"
6929
+
6930
+ /v1/automations/presets:
6931
+ get:
6932
+ tags: [Automations]
6933
+ summary: List automation presets
6934
+ operationId: listAutomationPresets
6935
+ security: []
6936
+ description: Public preset gallery of ready-to-use automation templates.
6937
+ responses:
6938
+ "200":
6939
+ description: Automation preset list
6940
+ content:
6941
+ application/json:
6942
+ schema:
6943
+ $ref: "#/components/schemas/AutomationPresetsResponse"
6944
+
6895
6945
  # ---------------------------------------------------------------------------
6896
6946
  # Runtimes
6897
6947
  # ---------------------------------------------------------------------------
@@ -7190,6 +7240,50 @@ paths:
7190
7240
  "404":
7191
7241
  $ref: "#/components/responses/NotFound"
7192
7242
 
7243
+ /v1/runtimes/{runtimeId}/chat:
7244
+ post:
7245
+ tags: [Runtimes]
7246
+ summary: Chat with a running runtime agent
7247
+ description: |
7248
+ Human-only. Proxies to the runtime container's OpenAI-compatible
7249
+ `POST /v1/chat/completions` (hermes / openclaw / openclaude chat bridge).
7250
+ Starts the runtime if stopped. Streams SSE when `Accept: text/event-stream`
7251
+ or `stream: true`. Conversation history is ephemeral (pass `messages`).
7252
+ Requires a public URL (shell access, Shroud sidecar, or HTTP hosting).
7253
+ operationId: runtimeChat
7254
+ parameters:
7255
+ - name: runtimeId
7256
+ in: path
7257
+ required: true
7258
+ schema:
7259
+ type: string
7260
+ format: uuid
7261
+ requestBody:
7262
+ required: true
7263
+ content:
7264
+ application/json:
7265
+ schema:
7266
+ $ref: "#/components/schemas/RuntimeChatRequest"
7267
+ responses:
7268
+ "200":
7269
+ description: Chat completion (JSON) or SSE stream
7270
+ content:
7271
+ application/json:
7272
+ schema:
7273
+ type: object
7274
+ additionalProperties: true
7275
+ text/event-stream:
7276
+ schema:
7277
+ type: string
7278
+ "400":
7279
+ $ref: "#/components/responses/BadRequest"
7280
+ "401":
7281
+ $ref: "#/components/responses/Unauthorized"
7282
+ "403":
7283
+ $ref: "#/components/responses/Forbidden"
7284
+ "404":
7285
+ $ref: "#/components/responses/NotFound"
7286
+
7193
7287
  # ---------------------------------------------------------------------------
7194
7288
  # Agent Memory
7195
7289
  # ---------------------------------------------------------------------------
@@ -13337,6 +13431,10 @@ components:
13337
13431
  description: |
13338
13432
  Workflow steps. Accepts a bare array `[...]` or
13339
13433
  `{ "steps": [...] }` (dashboard / preset shape).
13434
+ Supported step types: get_secret, put_secret, http_request,
13435
+ rotate_secret, notify_human, ai_generate, memory_get,
13436
+ memory_put, memory_search, notify, approval_request,
13437
+ condition, execute_binding.
13340
13438
  oneOf:
13341
13439
  - type: array
13342
13440
  items:
@@ -13496,7 +13594,7 @@ components:
13496
13594
  format: uuid
13497
13595
  status:
13498
13596
  type: string
13499
- enum: [pending, running, completed, failed, denied]
13597
+ enum: [pending, running, completed, failed, denied, cancelled, awaiting_approval]
13500
13598
  step_results:
13501
13599
  nullable: true
13502
13600
  error:
@@ -13526,6 +13624,30 @@ components:
13526
13624
  items:
13527
13625
  $ref: "#/components/schemas/AutomationRunResponse"
13528
13626
 
13627
+ AutomationPresetsResponse:
13628
+ type: object
13629
+ required: [presets]
13630
+ properties:
13631
+ presets:
13632
+ type: array
13633
+ items:
13634
+ type: object
13635
+ properties:
13636
+ id:
13637
+ type: string
13638
+ name:
13639
+ type: string
13640
+ description:
13641
+ type: string
13642
+ trigger_type:
13643
+ type: string
13644
+ cron_expr:
13645
+ type: string
13646
+ nullable: true
13647
+ workflow_spec:
13648
+ type: object
13649
+ additionalProperties: true
13650
+
13529
13651
  # --- Runtimes ---
13530
13652
 
13531
13653
  CreateRuntimeRequest:
@@ -13724,6 +13846,29 @@ components:
13724
13846
  max_session_minutes:
13725
13847
  type: integer
13726
13848
 
13849
+ RuntimeChatRequest:
13850
+ type: object
13851
+ description: |
13852
+ Chat with the agent inside a runtime. Provide `message` and/or
13853
+ a full OpenAI-style `messages` array (ephemeral history).
13854
+ properties:
13855
+ message:
13856
+ type: string
13857
+ description: Latest user message
13858
+ messages:
13859
+ type: array
13860
+ items:
13861
+ type: object
13862
+ additionalProperties: true
13863
+ description: OpenAI chat messages (optional history)
13864
+ model:
13865
+ type: string
13866
+ provider:
13867
+ type: string
13868
+ stream:
13869
+ type: boolean
13870
+ description: Request SSE streaming (default true when Accept is text/event-stream)
13871
+
13727
13872
  # --- Agent Memory ---
13728
13873
 
13729
13874
  MemoryEntry:
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@1claw/openapi-spec",
3
- "version": "0.43.2",
3
+ "version": "0.43.4",
4
4
  "description": "OpenAPI 3.1.0 specification for the 1Claw Vault API \u2014 generate clients in any language",
5
5
  "license": "MIT",
6
6
  "repository": {