@1claw/openapi-spec 0.43.4 → 0.44.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 +443 -4
- package/openapi.yaml +291 -2
- 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.
|
|
5
|
+
"version": "2.33.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"
|
|
@@ -7792,6 +7792,122 @@
|
|
|
7792
7792
|
}
|
|
7793
7793
|
}
|
|
7794
7794
|
},
|
|
7795
|
+
"/v1/platform/apps/{appId}/templates/{template_id}": {
|
|
7796
|
+
"patch": {
|
|
7797
|
+
"tags": [
|
|
7798
|
+
"Platform"
|
|
7799
|
+
],
|
|
7800
|
+
"summary": "Update a bootstrap template",
|
|
7801
|
+
"description": "Update an existing template's name, description, spec, or active status.",
|
|
7802
|
+
"operationId": "updatePlatformTemplate",
|
|
7803
|
+
"security": [
|
|
7804
|
+
{
|
|
7805
|
+
"BearerAuth": []
|
|
7806
|
+
}
|
|
7807
|
+
],
|
|
7808
|
+
"parameters": [
|
|
7809
|
+
{
|
|
7810
|
+
"in": "path",
|
|
7811
|
+
"name": "appId",
|
|
7812
|
+
"required": true,
|
|
7813
|
+
"schema": {
|
|
7814
|
+
"type": "string",
|
|
7815
|
+
"format": "uuid"
|
|
7816
|
+
}
|
|
7817
|
+
},
|
|
7818
|
+
{
|
|
7819
|
+
"in": "path",
|
|
7820
|
+
"name": "template_id",
|
|
7821
|
+
"required": true,
|
|
7822
|
+
"schema": {
|
|
7823
|
+
"type": "string",
|
|
7824
|
+
"format": "uuid"
|
|
7825
|
+
}
|
|
7826
|
+
}
|
|
7827
|
+
],
|
|
7828
|
+
"requestBody": {
|
|
7829
|
+
"required": true,
|
|
7830
|
+
"content": {
|
|
7831
|
+
"application/json": {
|
|
7832
|
+
"schema": {
|
|
7833
|
+
"type": "object",
|
|
7834
|
+
"properties": {
|
|
7835
|
+
"name": {
|
|
7836
|
+
"type": "string"
|
|
7837
|
+
},
|
|
7838
|
+
"description": {
|
|
7839
|
+
"type": "string",
|
|
7840
|
+
"nullable": true
|
|
7841
|
+
},
|
|
7842
|
+
"spec": {
|
|
7843
|
+
"type": "object",
|
|
7844
|
+
"additionalProperties": true
|
|
7845
|
+
},
|
|
7846
|
+
"is_active": {
|
|
7847
|
+
"type": "boolean"
|
|
7848
|
+
}
|
|
7849
|
+
}
|
|
7850
|
+
}
|
|
7851
|
+
}
|
|
7852
|
+
}
|
|
7853
|
+
},
|
|
7854
|
+
"responses": {
|
|
7855
|
+
"200": {
|
|
7856
|
+
"description": "Template updated",
|
|
7857
|
+
"content": {
|
|
7858
|
+
"application/json": {
|
|
7859
|
+
"schema": {
|
|
7860
|
+
"$ref": "#/components/schemas/PlatformTemplateResponse"
|
|
7861
|
+
}
|
|
7862
|
+
}
|
|
7863
|
+
}
|
|
7864
|
+
},
|
|
7865
|
+
"404": {
|
|
7866
|
+
"$ref": "#/components/responses/NotFound"
|
|
7867
|
+
}
|
|
7868
|
+
}
|
|
7869
|
+
},
|
|
7870
|
+
"delete": {
|
|
7871
|
+
"tags": [
|
|
7872
|
+
"Platform"
|
|
7873
|
+
],
|
|
7874
|
+
"summary": "Delete a bootstrap template",
|
|
7875
|
+
"operationId": "deletePlatformTemplate",
|
|
7876
|
+
"security": [
|
|
7877
|
+
{
|
|
7878
|
+
"BearerAuth": []
|
|
7879
|
+
}
|
|
7880
|
+
],
|
|
7881
|
+
"parameters": [
|
|
7882
|
+
{
|
|
7883
|
+
"in": "path",
|
|
7884
|
+
"name": "appId",
|
|
7885
|
+
"required": true,
|
|
7886
|
+
"schema": {
|
|
7887
|
+
"type": "string",
|
|
7888
|
+
"format": "uuid"
|
|
7889
|
+
}
|
|
7890
|
+
},
|
|
7891
|
+
{
|
|
7892
|
+
"in": "path",
|
|
7893
|
+
"name": "template_id",
|
|
7894
|
+
"required": true,
|
|
7895
|
+
"schema": {
|
|
7896
|
+
"type": "string",
|
|
7897
|
+
"format": "uuid"
|
|
7898
|
+
}
|
|
7899
|
+
}
|
|
7900
|
+
],
|
|
7901
|
+
"responses": {
|
|
7902
|
+
"204": {
|
|
7903
|
+
"description": "Template deleted"
|
|
7904
|
+
},
|
|
7905
|
+
"404": {
|
|
7906
|
+
"$ref": "#/components/responses/NotFound"
|
|
7907
|
+
}
|
|
7908
|
+
}
|
|
7909
|
+
}
|
|
7910
|
+
},
|
|
7795
7911
|
"/v1/platform/users/upsert": {
|
|
7796
7912
|
"post": {
|
|
7797
7913
|
"tags": [
|
|
@@ -8106,6 +8222,82 @@
|
|
|
8106
8222
|
}
|
|
8107
8223
|
},
|
|
8108
8224
|
"/v1/platform/connected-apps/{connectionId}": {
|
|
8225
|
+
"patch": {
|
|
8226
|
+
"tags": [
|
|
8227
|
+
"Platform"
|
|
8228
|
+
],
|
|
8229
|
+
"summary": "Update connection delegation",
|
|
8230
|
+
"description": "Toggle delegation and update delegation scopes for a connected platform app. User-only.",
|
|
8231
|
+
"operationId": "updateConnectionDelegation",
|
|
8232
|
+
"security": [
|
|
8233
|
+
{
|
|
8234
|
+
"BearerAuth": []
|
|
8235
|
+
}
|
|
8236
|
+
],
|
|
8237
|
+
"parameters": [
|
|
8238
|
+
{
|
|
8239
|
+
"in": "path",
|
|
8240
|
+
"name": "connectionId",
|
|
8241
|
+
"required": true,
|
|
8242
|
+
"schema": {
|
|
8243
|
+
"type": "string",
|
|
8244
|
+
"format": "uuid"
|
|
8245
|
+
}
|
|
8246
|
+
}
|
|
8247
|
+
],
|
|
8248
|
+
"requestBody": {
|
|
8249
|
+
"required": true,
|
|
8250
|
+
"content": {
|
|
8251
|
+
"application/json": {
|
|
8252
|
+
"schema": {
|
|
8253
|
+
"type": "object",
|
|
8254
|
+
"properties": {
|
|
8255
|
+
"delegation_enabled": {
|
|
8256
|
+
"type": "boolean"
|
|
8257
|
+
},
|
|
8258
|
+
"delegation_scopes": {
|
|
8259
|
+
"type": "array",
|
|
8260
|
+
"items": {
|
|
8261
|
+
"type": "string"
|
|
8262
|
+
},
|
|
8263
|
+
"description": "Scopes: vaults:read, vaults:write, agents:read, agents:write, secrets:read, secrets:write, automations:*, runtimes:*"
|
|
8264
|
+
}
|
|
8265
|
+
}
|
|
8266
|
+
}
|
|
8267
|
+
}
|
|
8268
|
+
}
|
|
8269
|
+
},
|
|
8270
|
+
"responses": {
|
|
8271
|
+
"200": {
|
|
8272
|
+
"description": "Delegation settings updated",
|
|
8273
|
+
"content": {
|
|
8274
|
+
"application/json": {
|
|
8275
|
+
"schema": {
|
|
8276
|
+
"type": "object",
|
|
8277
|
+
"properties": {
|
|
8278
|
+
"connection_id": {
|
|
8279
|
+
"type": "string",
|
|
8280
|
+
"format": "uuid"
|
|
8281
|
+
},
|
|
8282
|
+
"delegation_enabled": {
|
|
8283
|
+
"type": "boolean"
|
|
8284
|
+
},
|
|
8285
|
+
"delegation_scopes": {
|
|
8286
|
+
"type": "array",
|
|
8287
|
+
"items": {
|
|
8288
|
+
"type": "string"
|
|
8289
|
+
}
|
|
8290
|
+
}
|
|
8291
|
+
}
|
|
8292
|
+
}
|
|
8293
|
+
}
|
|
8294
|
+
}
|
|
8295
|
+
},
|
|
8296
|
+
"404": {
|
|
8297
|
+
"$ref": "#/components/responses/NotFound"
|
|
8298
|
+
}
|
|
8299
|
+
}
|
|
8300
|
+
},
|
|
8109
8301
|
"delete": {
|
|
8110
8302
|
"tags": [
|
|
8111
8303
|
"Platform"
|
|
@@ -8138,6 +8330,79 @@
|
|
|
8138
8330
|
}
|
|
8139
8331
|
}
|
|
8140
8332
|
},
|
|
8333
|
+
"/v1/platform/connections/{connectionId}/delegation-log": {
|
|
8334
|
+
"get": {
|
|
8335
|
+
"tags": [
|
|
8336
|
+
"Platform"
|
|
8337
|
+
],
|
|
8338
|
+
"summary": "Delegation audit log",
|
|
8339
|
+
"description": "List delegated actions performed by a platform app on behalf of this user.",
|
|
8340
|
+
"operationId": "getDelegationLog",
|
|
8341
|
+
"security": [
|
|
8342
|
+
{
|
|
8343
|
+
"BearerAuth": []
|
|
8344
|
+
}
|
|
8345
|
+
],
|
|
8346
|
+
"parameters": [
|
|
8347
|
+
{
|
|
8348
|
+
"in": "path",
|
|
8349
|
+
"name": "connectionId",
|
|
8350
|
+
"required": true,
|
|
8351
|
+
"schema": {
|
|
8352
|
+
"type": "string",
|
|
8353
|
+
"format": "uuid"
|
|
8354
|
+
}
|
|
8355
|
+
}
|
|
8356
|
+
],
|
|
8357
|
+
"responses": {
|
|
8358
|
+
"200": {
|
|
8359
|
+
"description": "Delegation log entries",
|
|
8360
|
+
"content": {
|
|
8361
|
+
"application/json": {
|
|
8362
|
+
"schema": {
|
|
8363
|
+
"type": "object",
|
|
8364
|
+
"properties": {
|
|
8365
|
+
"entries": {
|
|
8366
|
+
"type": "array",
|
|
8367
|
+
"items": {
|
|
8368
|
+
"type": "object",
|
|
8369
|
+
"properties": {
|
|
8370
|
+
"action": {
|
|
8371
|
+
"type": "string"
|
|
8372
|
+
},
|
|
8373
|
+
"scope": {
|
|
8374
|
+
"type": "string"
|
|
8375
|
+
},
|
|
8376
|
+
"resource_type": {
|
|
8377
|
+
"type": "string"
|
|
8378
|
+
},
|
|
8379
|
+
"resource_id": {
|
|
8380
|
+
"type": "string",
|
|
8381
|
+
"format": "uuid"
|
|
8382
|
+
},
|
|
8383
|
+
"timestamp": {
|
|
8384
|
+
"type": "string",
|
|
8385
|
+
"format": "date-time"
|
|
8386
|
+
},
|
|
8387
|
+
"details": {
|
|
8388
|
+
"type": "object",
|
|
8389
|
+
"additionalProperties": true,
|
|
8390
|
+
"nullable": true
|
|
8391
|
+
}
|
|
8392
|
+
}
|
|
8393
|
+
}
|
|
8394
|
+
}
|
|
8395
|
+
}
|
|
8396
|
+
}
|
|
8397
|
+
}
|
|
8398
|
+
}
|
|
8399
|
+
},
|
|
8400
|
+
"404": {
|
|
8401
|
+
"$ref": "#/components/responses/NotFound"
|
|
8402
|
+
}
|
|
8403
|
+
}
|
|
8404
|
+
}
|
|
8405
|
+
},
|
|
8141
8406
|
"/v1/platform/connections/{connectionId}/grant": {
|
|
8142
8407
|
"post": {
|
|
8143
8408
|
"tags": [
|
|
@@ -10648,6 +10913,54 @@
|
|
|
10648
10913
|
}
|
|
10649
10914
|
}
|
|
10650
10915
|
},
|
|
10916
|
+
"/v1/automations/{automationId}/runs/{runId}": {
|
|
10917
|
+
"get": {
|
|
10918
|
+
"tags": [
|
|
10919
|
+
"Automations"
|
|
10920
|
+
],
|
|
10921
|
+
"summary": "Get automation run",
|
|
10922
|
+
"operationId": "getAutomationRun",
|
|
10923
|
+
"description": "Get details of a single automation run including step results and context.",
|
|
10924
|
+
"parameters": [
|
|
10925
|
+
{
|
|
10926
|
+
"name": "automationId",
|
|
10927
|
+
"in": "path",
|
|
10928
|
+
"required": true,
|
|
10929
|
+
"schema": {
|
|
10930
|
+
"type": "string",
|
|
10931
|
+
"format": "uuid"
|
|
10932
|
+
}
|
|
10933
|
+
},
|
|
10934
|
+
{
|
|
10935
|
+
"name": "runId",
|
|
10936
|
+
"in": "path",
|
|
10937
|
+
"required": true,
|
|
10938
|
+
"schema": {
|
|
10939
|
+
"type": "string",
|
|
10940
|
+
"format": "uuid"
|
|
10941
|
+
}
|
|
10942
|
+
}
|
|
10943
|
+
],
|
|
10944
|
+
"responses": {
|
|
10945
|
+
"200": {
|
|
10946
|
+
"description": "Automation run detail",
|
|
10947
|
+
"content": {
|
|
10948
|
+
"application/json": {
|
|
10949
|
+
"schema": {
|
|
10950
|
+
"$ref": "#/components/schemas/AutomationRunResponse"
|
|
10951
|
+
}
|
|
10952
|
+
}
|
|
10953
|
+
}
|
|
10954
|
+
},
|
|
10955
|
+
"401": {
|
|
10956
|
+
"$ref": "#/components/responses/Unauthorized"
|
|
10957
|
+
},
|
|
10958
|
+
"404": {
|
|
10959
|
+
"$ref": "#/components/responses/NotFound"
|
|
10960
|
+
}
|
|
10961
|
+
}
|
|
10962
|
+
}
|
|
10963
|
+
},
|
|
10651
10964
|
"/v1/automations/assist/draft": {
|
|
10652
10965
|
"post": {
|
|
10653
10966
|
"tags": [
|
|
@@ -12279,6 +12592,80 @@
|
|
|
12279
12592
|
}
|
|
12280
12593
|
}
|
|
12281
12594
|
},
|
|
12595
|
+
"/v1/agents/{agent_id}/channels/{channel_id}/test": {
|
|
12596
|
+
"post": {
|
|
12597
|
+
"tags": [
|
|
12598
|
+
"Agent Channels"
|
|
12599
|
+
],
|
|
12600
|
+
"summary": "Test channel connectivity",
|
|
12601
|
+
"description": "Send a test message through the channel to verify connectivity and credentials.",
|
|
12602
|
+
"operationId": "testChannel",
|
|
12603
|
+
"parameters": [
|
|
12604
|
+
{
|
|
12605
|
+
"$ref": "#/components/parameters/AgentId"
|
|
12606
|
+
},
|
|
12607
|
+
{
|
|
12608
|
+
"name": "channel_id",
|
|
12609
|
+
"in": "path",
|
|
12610
|
+
"required": true,
|
|
12611
|
+
"schema": {
|
|
12612
|
+
"type": "string",
|
|
12613
|
+
"format": "uuid"
|
|
12614
|
+
}
|
|
12615
|
+
}
|
|
12616
|
+
],
|
|
12617
|
+
"requestBody": {
|
|
12618
|
+
"content": {
|
|
12619
|
+
"application/json": {
|
|
12620
|
+
"schema": {
|
|
12621
|
+
"type": "object",
|
|
12622
|
+
"properties": {
|
|
12623
|
+
"external_chat_id": {
|
|
12624
|
+
"type": "string",
|
|
12625
|
+
"description": "Optional chat ID to send the test message to"
|
|
12626
|
+
},
|
|
12627
|
+
"content": {
|
|
12628
|
+
"type": "string",
|
|
12629
|
+
"description": "Optional custom test message content"
|
|
12630
|
+
}
|
|
12631
|
+
}
|
|
12632
|
+
}
|
|
12633
|
+
}
|
|
12634
|
+
}
|
|
12635
|
+
},
|
|
12636
|
+
"responses": {
|
|
12637
|
+
"200": {
|
|
12638
|
+
"description": "Test result",
|
|
12639
|
+
"content": {
|
|
12640
|
+
"application/json": {
|
|
12641
|
+
"schema": {
|
|
12642
|
+
"type": "object",
|
|
12643
|
+
"properties": {
|
|
12644
|
+
"success": {
|
|
12645
|
+
"type": "boolean"
|
|
12646
|
+
},
|
|
12647
|
+
"message": {
|
|
12648
|
+
"type": "string",
|
|
12649
|
+
"nullable": true
|
|
12650
|
+
},
|
|
12651
|
+
"error": {
|
|
12652
|
+
"type": "string",
|
|
12653
|
+
"nullable": true
|
|
12654
|
+
}
|
|
12655
|
+
}
|
|
12656
|
+
}
|
|
12657
|
+
}
|
|
12658
|
+
}
|
|
12659
|
+
},
|
|
12660
|
+
"401": {
|
|
12661
|
+
"$ref": "#/components/responses/Unauthorized"
|
|
12662
|
+
},
|
|
12663
|
+
"404": {
|
|
12664
|
+
"$ref": "#/components/responses/NotFound"
|
|
12665
|
+
}
|
|
12666
|
+
}
|
|
12667
|
+
}
|
|
12668
|
+
},
|
|
12282
12669
|
"/v1/webhooks/telegram/{webhook_path}": {
|
|
12283
12670
|
"post": {
|
|
12284
12671
|
"tags": [
|
|
@@ -18939,6 +19326,11 @@
|
|
|
18939
19326
|
"nullable": true,
|
|
18940
19327
|
"description": "One-time agent API key (ocv_ prefix). Store securely — not retrievable later."
|
|
18941
19328
|
},
|
|
19329
|
+
"agent_evm_address": {
|
|
19330
|
+
"type": "string",
|
|
19331
|
+
"nullable": true,
|
|
19332
|
+
"description": "EOA address when provision_eoa is true in the template"
|
|
19333
|
+
},
|
|
18942
19334
|
"signing_keys": {
|
|
18943
19335
|
"type": "array",
|
|
18944
19336
|
"description": "Provisioned signing key details (chain, address, public key)",
|
|
@@ -18959,6 +19351,22 @@
|
|
|
18959
19351
|
}
|
|
18960
19352
|
}
|
|
18961
19353
|
}
|
|
19354
|
+
},
|
|
19355
|
+
"runtime_ids": {
|
|
19356
|
+
"type": "array",
|
|
19357
|
+
"items": {
|
|
19358
|
+
"type": "string",
|
|
19359
|
+
"format": "uuid"
|
|
19360
|
+
},
|
|
19361
|
+
"description": "IDs of runtimes provisioned by the template"
|
|
19362
|
+
},
|
|
19363
|
+
"automation_ids": {
|
|
19364
|
+
"type": "array",
|
|
19365
|
+
"items": {
|
|
19366
|
+
"type": "string",
|
|
19367
|
+
"format": "uuid"
|
|
19368
|
+
},
|
|
19369
|
+
"description": "IDs of automations provisioned by the template"
|
|
18962
19370
|
}
|
|
18963
19371
|
}
|
|
18964
19372
|
}
|
|
@@ -20527,6 +20935,26 @@
|
|
|
20527
20935
|
"format": "date-time",
|
|
20528
20936
|
"nullable": true
|
|
20529
20937
|
},
|
|
20938
|
+
"last_run_status": {
|
|
20939
|
+
"type": "string",
|
|
20940
|
+
"nullable": true,
|
|
20941
|
+
"description": "Status of the most recent run (enriched list field)"
|
|
20942
|
+
},
|
|
20943
|
+
"total_runs": {
|
|
20944
|
+
"type": "integer",
|
|
20945
|
+
"nullable": true,
|
|
20946
|
+
"description": "Total runs in the last 30 days (enriched list field)"
|
|
20947
|
+
},
|
|
20948
|
+
"success_rate": {
|
|
20949
|
+
"type": "number",
|
|
20950
|
+
"nullable": true,
|
|
20951
|
+
"description": "Success rate percentage (enriched list field)"
|
|
20952
|
+
},
|
|
20953
|
+
"agent_name": {
|
|
20954
|
+
"type": "string",
|
|
20955
|
+
"nullable": true,
|
|
20956
|
+
"description": "Resolved agent display name (enriched list field)"
|
|
20957
|
+
},
|
|
20530
20958
|
"created_at": {
|
|
20531
20959
|
"type": "string",
|
|
20532
20960
|
"format": "date-time"
|
|
@@ -20664,11 +21092,10 @@
|
|
|
20664
21092
|
"status": {
|
|
20665
21093
|
"type": "string",
|
|
20666
21094
|
"enum": [
|
|
20667
|
-
"pending",
|
|
20668
21095
|
"running",
|
|
20669
|
-
"
|
|
21096
|
+
"success",
|
|
20670
21097
|
"failed",
|
|
20671
|
-
"
|
|
21098
|
+
"timed_out",
|
|
20672
21099
|
"cancelled",
|
|
20673
21100
|
"awaiting_approval"
|
|
20674
21101
|
]
|
|
@@ -20684,6 +21111,12 @@
|
|
|
20684
21111
|
"type": "string",
|
|
20685
21112
|
"nullable": true
|
|
20686
21113
|
},
|
|
21114
|
+
"context": {
|
|
21115
|
+
"type": "object",
|
|
21116
|
+
"additionalProperties": true,
|
|
21117
|
+
"nullable": true,
|
|
21118
|
+
"description": "JSONB context passed between workflow steps"
|
|
21119
|
+
},
|
|
20687
21120
|
"started_at": {
|
|
20688
21121
|
"type": "string",
|
|
20689
21122
|
"format": "date-time"
|
|
@@ -21556,6 +21989,12 @@
|
|
|
21556
21989
|
"is_active": {
|
|
21557
21990
|
"type": "boolean"
|
|
21558
21991
|
},
|
|
21992
|
+
"config": {
|
|
21993
|
+
"type": "object",
|
|
21994
|
+
"additionalProperties": true,
|
|
21995
|
+
"nullable": true,
|
|
21996
|
+
"description": "Channel-specific configuration JSON. May include:\n- sender_allowlist (array of strings): restrict which external senders can trigger the agent\n- auto_respond_enabled (boolean): whether the agent auto-responds to inbound messages\n"
|
|
21997
|
+
},
|
|
21559
21998
|
"created_at": {
|
|
21560
21999
|
"type": "string",
|
|
21561
22000
|
"format": "date-time"
|
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.
|
|
5
|
+
version: 2.33.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,
|
|
@@ -5028,6 +5028,78 @@ paths:
|
|
|
5028
5028
|
items:
|
|
5029
5029
|
$ref: "#/components/schemas/PlatformTemplateResponse"
|
|
5030
5030
|
|
|
5031
|
+
/v1/platform/apps/{appId}/templates/{template_id}:
|
|
5032
|
+
patch:
|
|
5033
|
+
tags: [Platform]
|
|
5034
|
+
summary: Update a bootstrap template
|
|
5035
|
+
description: Update an existing template's name, description, spec, or active status.
|
|
5036
|
+
operationId: updatePlatformTemplate
|
|
5037
|
+
security:
|
|
5038
|
+
- BearerAuth: []
|
|
5039
|
+
parameters:
|
|
5040
|
+
- in: path
|
|
5041
|
+
name: appId
|
|
5042
|
+
required: true
|
|
5043
|
+
schema:
|
|
5044
|
+
type: string
|
|
5045
|
+
format: uuid
|
|
5046
|
+
- in: path
|
|
5047
|
+
name: template_id
|
|
5048
|
+
required: true
|
|
5049
|
+
schema:
|
|
5050
|
+
type: string
|
|
5051
|
+
format: uuid
|
|
5052
|
+
requestBody:
|
|
5053
|
+
required: true
|
|
5054
|
+
content:
|
|
5055
|
+
application/json:
|
|
5056
|
+
schema:
|
|
5057
|
+
type: object
|
|
5058
|
+
properties:
|
|
5059
|
+
name:
|
|
5060
|
+
type: string
|
|
5061
|
+
description:
|
|
5062
|
+
type: string
|
|
5063
|
+
nullable: true
|
|
5064
|
+
spec:
|
|
5065
|
+
type: object
|
|
5066
|
+
additionalProperties: true
|
|
5067
|
+
is_active:
|
|
5068
|
+
type: boolean
|
|
5069
|
+
responses:
|
|
5070
|
+
"200":
|
|
5071
|
+
description: Template updated
|
|
5072
|
+
content:
|
|
5073
|
+
application/json:
|
|
5074
|
+
schema:
|
|
5075
|
+
$ref: "#/components/schemas/PlatformTemplateResponse"
|
|
5076
|
+
"404":
|
|
5077
|
+
$ref: "#/components/responses/NotFound"
|
|
5078
|
+
delete:
|
|
5079
|
+
tags: [Platform]
|
|
5080
|
+
summary: Delete a bootstrap template
|
|
5081
|
+
operationId: deletePlatformTemplate
|
|
5082
|
+
security:
|
|
5083
|
+
- BearerAuth: []
|
|
5084
|
+
parameters:
|
|
5085
|
+
- in: path
|
|
5086
|
+
name: appId
|
|
5087
|
+
required: true
|
|
5088
|
+
schema:
|
|
5089
|
+
type: string
|
|
5090
|
+
format: uuid
|
|
5091
|
+
- in: path
|
|
5092
|
+
name: template_id
|
|
5093
|
+
required: true
|
|
5094
|
+
schema:
|
|
5095
|
+
type: string
|
|
5096
|
+
format: uuid
|
|
5097
|
+
responses:
|
|
5098
|
+
"204":
|
|
5099
|
+
description: Template deleted
|
|
5100
|
+
"404":
|
|
5101
|
+
$ref: "#/components/responses/NotFound"
|
|
5102
|
+
|
|
5031
5103
|
/v1/platform/users/upsert:
|
|
5032
5104
|
post:
|
|
5033
5105
|
tags: [Platform]
|
|
@@ -5218,6 +5290,53 @@ paths:
|
|
|
5218
5290
|
$ref: "#/components/schemas/ConnectedAppResponse"
|
|
5219
5291
|
|
|
5220
5292
|
/v1/platform/connected-apps/{connectionId}:
|
|
5293
|
+
patch:
|
|
5294
|
+
tags: [Platform]
|
|
5295
|
+
summary: Update connection delegation
|
|
5296
|
+
description: Toggle delegation and update delegation scopes for a connected platform app. User-only.
|
|
5297
|
+
operationId: updateConnectionDelegation
|
|
5298
|
+
security:
|
|
5299
|
+
- BearerAuth: []
|
|
5300
|
+
parameters:
|
|
5301
|
+
- in: path
|
|
5302
|
+
name: connectionId
|
|
5303
|
+
required: true
|
|
5304
|
+
schema:
|
|
5305
|
+
type: string
|
|
5306
|
+
format: uuid
|
|
5307
|
+
requestBody:
|
|
5308
|
+
required: true
|
|
5309
|
+
content:
|
|
5310
|
+
application/json:
|
|
5311
|
+
schema:
|
|
5312
|
+
type: object
|
|
5313
|
+
properties:
|
|
5314
|
+
delegation_enabled:
|
|
5315
|
+
type: boolean
|
|
5316
|
+
delegation_scopes:
|
|
5317
|
+
type: array
|
|
5318
|
+
items:
|
|
5319
|
+
type: string
|
|
5320
|
+
description: "Scopes: vaults:read, vaults:write, agents:read, agents:write, secrets:read, secrets:write, automations:*, runtimes:*"
|
|
5321
|
+
responses:
|
|
5322
|
+
"200":
|
|
5323
|
+
description: Delegation settings updated
|
|
5324
|
+
content:
|
|
5325
|
+
application/json:
|
|
5326
|
+
schema:
|
|
5327
|
+
type: object
|
|
5328
|
+
properties:
|
|
5329
|
+
connection_id:
|
|
5330
|
+
type: string
|
|
5331
|
+
format: uuid
|
|
5332
|
+
delegation_enabled:
|
|
5333
|
+
type: boolean
|
|
5334
|
+
delegation_scopes:
|
|
5335
|
+
type: array
|
|
5336
|
+
items:
|
|
5337
|
+
type: string
|
|
5338
|
+
"404":
|
|
5339
|
+
$ref: "#/components/responses/NotFound"
|
|
5221
5340
|
delete:
|
|
5222
5341
|
tags: [Platform]
|
|
5223
5342
|
summary: Disconnect a platform app
|
|
@@ -5237,6 +5356,53 @@ paths:
|
|
|
5237
5356
|
"404":
|
|
5238
5357
|
description: Connection not found
|
|
5239
5358
|
|
|
5359
|
+
/v1/platform/connections/{connectionId}/delegation-log:
|
|
5360
|
+
get:
|
|
5361
|
+
tags: [Platform]
|
|
5362
|
+
summary: Delegation audit log
|
|
5363
|
+
description: List delegated actions performed by a platform app on behalf of this user.
|
|
5364
|
+
operationId: getDelegationLog
|
|
5365
|
+
security:
|
|
5366
|
+
- BearerAuth: []
|
|
5367
|
+
parameters:
|
|
5368
|
+
- in: path
|
|
5369
|
+
name: connectionId
|
|
5370
|
+
required: true
|
|
5371
|
+
schema:
|
|
5372
|
+
type: string
|
|
5373
|
+
format: uuid
|
|
5374
|
+
responses:
|
|
5375
|
+
"200":
|
|
5376
|
+
description: Delegation log entries
|
|
5377
|
+
content:
|
|
5378
|
+
application/json:
|
|
5379
|
+
schema:
|
|
5380
|
+
type: object
|
|
5381
|
+
properties:
|
|
5382
|
+
entries:
|
|
5383
|
+
type: array
|
|
5384
|
+
items:
|
|
5385
|
+
type: object
|
|
5386
|
+
properties:
|
|
5387
|
+
action:
|
|
5388
|
+
type: string
|
|
5389
|
+
scope:
|
|
5390
|
+
type: string
|
|
5391
|
+
resource_type:
|
|
5392
|
+
type: string
|
|
5393
|
+
resource_id:
|
|
5394
|
+
type: string
|
|
5395
|
+
format: uuid
|
|
5396
|
+
timestamp:
|
|
5397
|
+
type: string
|
|
5398
|
+
format: date-time
|
|
5399
|
+
details:
|
|
5400
|
+
type: object
|
|
5401
|
+
additionalProperties: true
|
|
5402
|
+
nullable: true
|
|
5403
|
+
"404":
|
|
5404
|
+
$ref: "#/components/responses/NotFound"
|
|
5405
|
+
|
|
5240
5406
|
/v1/platform/connections/{connectionId}/grant:
|
|
5241
5407
|
post:
|
|
5242
5408
|
tags: [Platform]
|
|
@@ -6781,6 +6947,37 @@ paths:
|
|
|
6781
6947
|
"404":
|
|
6782
6948
|
$ref: "#/components/responses/NotFound"
|
|
6783
6949
|
|
|
6950
|
+
/v1/automations/{automationId}/runs/{runId}:
|
|
6951
|
+
get:
|
|
6952
|
+
tags: [Automations]
|
|
6953
|
+
summary: Get automation run
|
|
6954
|
+
operationId: getAutomationRun
|
|
6955
|
+
description: Get details of a single automation run including step results and context.
|
|
6956
|
+
parameters:
|
|
6957
|
+
- name: automationId
|
|
6958
|
+
in: path
|
|
6959
|
+
required: true
|
|
6960
|
+
schema:
|
|
6961
|
+
type: string
|
|
6962
|
+
format: uuid
|
|
6963
|
+
- name: runId
|
|
6964
|
+
in: path
|
|
6965
|
+
required: true
|
|
6966
|
+
schema:
|
|
6967
|
+
type: string
|
|
6968
|
+
format: uuid
|
|
6969
|
+
responses:
|
|
6970
|
+
"200":
|
|
6971
|
+
description: Automation run detail
|
|
6972
|
+
content:
|
|
6973
|
+
application/json:
|
|
6974
|
+
schema:
|
|
6975
|
+
$ref: "#/components/schemas/AutomationRunResponse"
|
|
6976
|
+
"401":
|
|
6977
|
+
$ref: "#/components/responses/Unauthorized"
|
|
6978
|
+
"404":
|
|
6979
|
+
$ref: "#/components/responses/NotFound"
|
|
6980
|
+
|
|
6784
6981
|
/v1/automations/assist/draft:
|
|
6785
6982
|
post:
|
|
6786
6983
|
tags: [Automations]
|
|
@@ -7829,6 +8026,53 @@ paths:
|
|
|
7829
8026
|
"401":
|
|
7830
8027
|
$ref: "#/components/responses/Unauthorized"
|
|
7831
8028
|
|
|
8029
|
+
/v1/agents/{agent_id}/channels/{channel_id}/test:
|
|
8030
|
+
post:
|
|
8031
|
+
tags: [Agent Channels]
|
|
8032
|
+
summary: Test channel connectivity
|
|
8033
|
+
description: Send a test message through the channel to verify connectivity and credentials.
|
|
8034
|
+
operationId: testChannel
|
|
8035
|
+
parameters:
|
|
8036
|
+
- $ref: "#/components/parameters/AgentId"
|
|
8037
|
+
- name: channel_id
|
|
8038
|
+
in: path
|
|
8039
|
+
required: true
|
|
8040
|
+
schema:
|
|
8041
|
+
type: string
|
|
8042
|
+
format: uuid
|
|
8043
|
+
requestBody:
|
|
8044
|
+
content:
|
|
8045
|
+
application/json:
|
|
8046
|
+
schema:
|
|
8047
|
+
type: object
|
|
8048
|
+
properties:
|
|
8049
|
+
external_chat_id:
|
|
8050
|
+
type: string
|
|
8051
|
+
description: Optional chat ID to send the test message to
|
|
8052
|
+
content:
|
|
8053
|
+
type: string
|
|
8054
|
+
description: Optional custom test message content
|
|
8055
|
+
responses:
|
|
8056
|
+
"200":
|
|
8057
|
+
description: Test result
|
|
8058
|
+
content:
|
|
8059
|
+
application/json:
|
|
8060
|
+
schema:
|
|
8061
|
+
type: object
|
|
8062
|
+
properties:
|
|
8063
|
+
success:
|
|
8064
|
+
type: boolean
|
|
8065
|
+
message:
|
|
8066
|
+
type: string
|
|
8067
|
+
nullable: true
|
|
8068
|
+
error:
|
|
8069
|
+
type: string
|
|
8070
|
+
nullable: true
|
|
8071
|
+
"401":
|
|
8072
|
+
$ref: "#/components/responses/Unauthorized"
|
|
8073
|
+
"404":
|
|
8074
|
+
$ref: "#/components/responses/NotFound"
|
|
8075
|
+
|
|
7832
8076
|
# ---------------------------------------------------------------------------
|
|
7833
8077
|
# Channel Webhooks (Public)
|
|
7834
8078
|
# ---------------------------------------------------------------------------
|
|
@@ -12484,6 +12728,10 @@ components:
|
|
|
12484
12728
|
type: string
|
|
12485
12729
|
nullable: true
|
|
12486
12730
|
description: One-time agent API key (ocv_ prefix). Store securely — not retrievable later.
|
|
12731
|
+
agent_evm_address:
|
|
12732
|
+
type: string
|
|
12733
|
+
nullable: true
|
|
12734
|
+
description: EOA address when provision_eoa is true in the template
|
|
12487
12735
|
signing_keys:
|
|
12488
12736
|
type: array
|
|
12489
12737
|
description: Provisioned signing key details (chain, address, public key)
|
|
@@ -12498,6 +12746,18 @@ components:
|
|
|
12498
12746
|
type: string
|
|
12499
12747
|
address:
|
|
12500
12748
|
type: string
|
|
12749
|
+
runtime_ids:
|
|
12750
|
+
type: array
|
|
12751
|
+
items:
|
|
12752
|
+
type: string
|
|
12753
|
+
format: uuid
|
|
12754
|
+
description: IDs of runtimes provisioned by the template
|
|
12755
|
+
automation_ids:
|
|
12756
|
+
type: array
|
|
12757
|
+
items:
|
|
12758
|
+
type: string
|
|
12759
|
+
format: uuid
|
|
12760
|
+
description: IDs of automations provisioned by the template
|
|
12501
12761
|
|
|
12502
12762
|
ConnectedAppResponse:
|
|
12503
12763
|
type: object
|
|
@@ -13510,6 +13770,22 @@ components:
|
|
|
13510
13770
|
type: string
|
|
13511
13771
|
format: date-time
|
|
13512
13772
|
nullable: true
|
|
13773
|
+
last_run_status:
|
|
13774
|
+
type: string
|
|
13775
|
+
nullable: true
|
|
13776
|
+
description: Status of the most recent run (enriched list field)
|
|
13777
|
+
total_runs:
|
|
13778
|
+
type: integer
|
|
13779
|
+
nullable: true
|
|
13780
|
+
description: Total runs in the last 30 days (enriched list field)
|
|
13781
|
+
success_rate:
|
|
13782
|
+
type: number
|
|
13783
|
+
nullable: true
|
|
13784
|
+
description: Success rate percentage (enriched list field)
|
|
13785
|
+
agent_name:
|
|
13786
|
+
type: string
|
|
13787
|
+
nullable: true
|
|
13788
|
+
description: Resolved agent display name (enriched list field)
|
|
13513
13789
|
created_at:
|
|
13514
13790
|
type: string
|
|
13515
13791
|
format: date-time
|
|
@@ -13594,7 +13870,7 @@ components:
|
|
|
13594
13870
|
format: uuid
|
|
13595
13871
|
status:
|
|
13596
13872
|
type: string
|
|
13597
|
-
enum: [
|
|
13873
|
+
enum: [running, success, failed, timed_out, cancelled, awaiting_approval]
|
|
13598
13874
|
step_results:
|
|
13599
13875
|
nullable: true
|
|
13600
13876
|
error:
|
|
@@ -13603,6 +13879,11 @@ components:
|
|
|
13603
13879
|
trigger_source:
|
|
13604
13880
|
type: string
|
|
13605
13881
|
nullable: true
|
|
13882
|
+
context:
|
|
13883
|
+
type: object
|
|
13884
|
+
additionalProperties: true
|
|
13885
|
+
nullable: true
|
|
13886
|
+
description: JSONB context passed between workflow steps
|
|
13606
13887
|
started_at:
|
|
13607
13888
|
type: string
|
|
13608
13889
|
format: date-time
|
|
@@ -14194,6 +14475,14 @@ components:
|
|
|
14194
14475
|
type: string
|
|
14195
14476
|
is_active:
|
|
14196
14477
|
type: boolean
|
|
14478
|
+
config:
|
|
14479
|
+
type: object
|
|
14480
|
+
additionalProperties: true
|
|
14481
|
+
nullable: true
|
|
14482
|
+
description: |
|
|
14483
|
+
Channel-specific configuration JSON. May include:
|
|
14484
|
+
- sender_allowlist (array of strings): restrict which external senders can trigger the agent
|
|
14485
|
+
- auto_respond_enabled (boolean): whether the agent auto-responds to inbound messages
|
|
14197
14486
|
created_at:
|
|
14198
14487
|
type: string
|
|
14199
14488
|
format: date-time
|