@1claw/openapi-spec 0.42.0 → 0.43.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.
- package/openapi.json +1262 -167
- package/openapi.yaml +798 -64
- package/package.json +1 -1
package/openapi.json
CHANGED
|
@@ -2,8 +2,8 @@
|
|
|
2
2
|
"openapi": "3.1.0",
|
|
3
3
|
"info": {
|
|
4
4
|
"title": "1Claw API",
|
|
5
|
-
"version": "2.
|
|
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
|
|
5
|
+
"version": "2.30.0",
|
|
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),\ncloud runtimes with interactive shell sessions, agent memory,\nand discovery.\n\nAll endpoints require JWT Bearer authentication unless marked with\n`security: []`.\n",
|
|
7
7
|
"contact": {
|
|
8
8
|
"email": "ops@1claw.xyz"
|
|
9
9
|
}
|
|
@@ -150,6 +150,14 @@
|
|
|
150
150
|
{
|
|
151
151
|
"name": "Discovery",
|
|
152
152
|
"description": "Agent directory and platform marketplace"
|
|
153
|
+
},
|
|
154
|
+
{
|
|
155
|
+
"name": "Agent Chat",
|
|
156
|
+
"description": "Chat with agents via Shroud LLM proxy"
|
|
157
|
+
},
|
|
158
|
+
{
|
|
159
|
+
"name": "Agent Channels",
|
|
160
|
+
"description": "External messaging channels (Telegram, WhatsApp, Discord)"
|
|
153
161
|
}
|
|
154
162
|
],
|
|
155
163
|
"paths": {
|
|
@@ -11000,6 +11008,104 @@
|
|
|
11000
11008
|
}
|
|
11001
11009
|
}
|
|
11002
11010
|
},
|
|
11011
|
+
"/v1/runtimes/{runtimeId}/shell/session": {
|
|
11012
|
+
"post": {
|
|
11013
|
+
"tags": [
|
|
11014
|
+
"Runtimes"
|
|
11015
|
+
],
|
|
11016
|
+
"summary": "Create interactive shell session",
|
|
11017
|
+
"description": "Human-only. Creates a short-lived WebSocket session token for the\nruntime's PTY terminal. Requires step-up auth via `password`,\n`totp_code`, `passkey_credential`, or `reauth_token` (from\n`POST /v1/auth/reauth` with purpose `runtime_shell`).\nRuntime must have `shell_access_enabled` and be running.\nEnabling shell on a running runtime may require stop/start, or\nthe server may auto-reconcile the sidecar on connect.\n",
|
|
11018
|
+
"operationId": "createShellSession",
|
|
11019
|
+
"parameters": [
|
|
11020
|
+
{
|
|
11021
|
+
"name": "runtimeId",
|
|
11022
|
+
"in": "path",
|
|
11023
|
+
"required": true,
|
|
11024
|
+
"schema": {
|
|
11025
|
+
"type": "string",
|
|
11026
|
+
"format": "uuid"
|
|
11027
|
+
}
|
|
11028
|
+
}
|
|
11029
|
+
],
|
|
11030
|
+
"requestBody": {
|
|
11031
|
+
"required": true,
|
|
11032
|
+
"content": {
|
|
11033
|
+
"application/json": {
|
|
11034
|
+
"schema": {
|
|
11035
|
+
"$ref": "#/components/schemas/ShellSessionRequest"
|
|
11036
|
+
}
|
|
11037
|
+
}
|
|
11038
|
+
}
|
|
11039
|
+
},
|
|
11040
|
+
"responses": {
|
|
11041
|
+
"200": {
|
|
11042
|
+
"description": "Shell session created",
|
|
11043
|
+
"content": {
|
|
11044
|
+
"application/json": {
|
|
11045
|
+
"schema": {
|
|
11046
|
+
"$ref": "#/components/schemas/ShellSessionResponse"
|
|
11047
|
+
}
|
|
11048
|
+
}
|
|
11049
|
+
}
|
|
11050
|
+
},
|
|
11051
|
+
"400": {
|
|
11052
|
+
"$ref": "#/components/responses/BadRequest"
|
|
11053
|
+
},
|
|
11054
|
+
"401": {
|
|
11055
|
+
"$ref": "#/components/responses/Unauthorized"
|
|
11056
|
+
},
|
|
11057
|
+
"403": {
|
|
11058
|
+
"$ref": "#/components/responses/Forbidden"
|
|
11059
|
+
},
|
|
11060
|
+
"404": {
|
|
11061
|
+
"$ref": "#/components/responses/NotFound"
|
|
11062
|
+
}
|
|
11063
|
+
}
|
|
11064
|
+
}
|
|
11065
|
+
},
|
|
11066
|
+
"/v1/runtimes/{runtimeId}/shell/passkey/begin": {
|
|
11067
|
+
"post": {
|
|
11068
|
+
"tags": [
|
|
11069
|
+
"Runtimes"
|
|
11070
|
+
],
|
|
11071
|
+
"summary": "Begin shell passkey assertion",
|
|
11072
|
+
"description": "Human-only. Starts a WebAuthn assertion ceremony for shell\nstep-up auth (social/Google users without a password).\n",
|
|
11073
|
+
"operationId": "beginShellPasskey",
|
|
11074
|
+
"parameters": [
|
|
11075
|
+
{
|
|
11076
|
+
"name": "runtimeId",
|
|
11077
|
+
"in": "path",
|
|
11078
|
+
"required": true,
|
|
11079
|
+
"schema": {
|
|
11080
|
+
"type": "string",
|
|
11081
|
+
"format": "uuid"
|
|
11082
|
+
}
|
|
11083
|
+
}
|
|
11084
|
+
],
|
|
11085
|
+
"responses": {
|
|
11086
|
+
"200": {
|
|
11087
|
+
"description": "Passkey challenge for shell session",
|
|
11088
|
+
"content": {
|
|
11089
|
+
"application/json": {
|
|
11090
|
+
"schema": {
|
|
11091
|
+
"type": "object",
|
|
11092
|
+
"additionalProperties": true
|
|
11093
|
+
}
|
|
11094
|
+
}
|
|
11095
|
+
}
|
|
11096
|
+
},
|
|
11097
|
+
"401": {
|
|
11098
|
+
"$ref": "#/components/responses/Unauthorized"
|
|
11099
|
+
},
|
|
11100
|
+
"403": {
|
|
11101
|
+
"$ref": "#/components/responses/Forbidden"
|
|
11102
|
+
},
|
|
11103
|
+
"404": {
|
|
11104
|
+
"$ref": "#/components/responses/NotFound"
|
|
11105
|
+
}
|
|
11106
|
+
}
|
|
11107
|
+
}
|
|
11108
|
+
},
|
|
11003
11109
|
"/v1/agents/{agent_id}/memory": {
|
|
11004
11110
|
"get": {
|
|
11005
11111
|
"tags": [
|
|
@@ -11444,102 +11550,673 @@
|
|
|
11444
11550
|
}
|
|
11445
11551
|
}
|
|
11446
11552
|
}
|
|
11447
|
-
}
|
|
11448
|
-
},
|
|
11449
|
-
"components": {
|
|
11450
|
-
"securitySchemes": {
|
|
11451
|
-
"BearerAuth": {
|
|
11452
|
-
"type": "http",
|
|
11453
|
-
"scheme": "bearer",
|
|
11454
|
-
"bearerFormat": "JWT"
|
|
11455
|
-
},
|
|
11456
|
-
"ApiKeyAuth": {
|
|
11457
|
-
"type": "http",
|
|
11458
|
-
"scheme": "bearer",
|
|
11459
|
-
"description": "1ck_ prefixed API key used as Bearer token"
|
|
11460
|
-
}
|
|
11461
11553
|
},
|
|
11462
|
-
"
|
|
11463
|
-
"
|
|
11464
|
-
"
|
|
11465
|
-
|
|
11466
|
-
|
|
11467
|
-
"
|
|
11468
|
-
|
|
11469
|
-
|
|
11470
|
-
|
|
11471
|
-
|
|
11472
|
-
|
|
11473
|
-
|
|
11474
|
-
|
|
11475
|
-
"
|
|
11476
|
-
|
|
11477
|
-
"
|
|
11554
|
+
"/v1/agents/{agent_id}/chat": {
|
|
11555
|
+
"post": {
|
|
11556
|
+
"tags": [
|
|
11557
|
+
"Agent Chat"
|
|
11558
|
+
],
|
|
11559
|
+
"summary": "Send chat message",
|
|
11560
|
+
"description": "Send a message to an agent and receive a response via Shroud LLM.\nSupports SSE streaming when Accept: text/event-stream is set.\n",
|
|
11561
|
+
"operationId": "sendChatMessage",
|
|
11562
|
+
"parameters": [
|
|
11563
|
+
{
|
|
11564
|
+
"$ref": "#/components/parameters/AgentId"
|
|
11565
|
+
}
|
|
11566
|
+
],
|
|
11567
|
+
"requestBody": {
|
|
11568
|
+
"required": true,
|
|
11569
|
+
"content": {
|
|
11570
|
+
"application/json": {
|
|
11571
|
+
"schema": {
|
|
11572
|
+
"$ref": "#/components/schemas/SendChatMessageRequest"
|
|
11573
|
+
}
|
|
11574
|
+
}
|
|
11575
|
+
}
|
|
11478
11576
|
},
|
|
11479
|
-
"
|
|
11480
|
-
|
|
11481
|
-
|
|
11482
|
-
|
|
11483
|
-
|
|
11484
|
-
|
|
11485
|
-
|
|
11486
|
-
|
|
11487
|
-
|
|
11488
|
-
|
|
11489
|
-
|
|
11490
|
-
|
|
11491
|
-
|
|
11492
|
-
|
|
11493
|
-
|
|
11494
|
-
|
|
11495
|
-
|
|
11496
|
-
"
|
|
11497
|
-
|
|
11498
|
-
|
|
11499
|
-
|
|
11500
|
-
|
|
11501
|
-
|
|
11502
|
-
"required": true,
|
|
11503
|
-
"schema": {
|
|
11504
|
-
"type": "string",
|
|
11505
|
-
"format": "uuid"
|
|
11506
|
-
}
|
|
11507
|
-
},
|
|
11508
|
-
"IncludeSignedTx": {
|
|
11509
|
-
"name": "include_signed_tx",
|
|
11510
|
-
"in": "query",
|
|
11511
|
-
"required": false,
|
|
11512
|
-
"description": "Set to `true` or `1` to include the raw signed transaction hex in the response. Omitted by default to reduce key exfiltration risk. Only the literal values \"true\" or \"1\" enable inclusion; any other value or omission returns responses without signed_tx. Applies to GET /v1/agents/{agent_id}/transactions and GET /v1/agents/{agent_id}/transactions/{tx_id}.\n",
|
|
11513
|
-
"schema": {
|
|
11514
|
-
"type": "boolean",
|
|
11515
|
-
"default": false,
|
|
11516
|
-
"example": false
|
|
11577
|
+
"responses": {
|
|
11578
|
+
"200": {
|
|
11579
|
+
"description": "Chat response",
|
|
11580
|
+
"content": {
|
|
11581
|
+
"application/json": {
|
|
11582
|
+
"schema": {
|
|
11583
|
+
"$ref": "#/components/schemas/SendChatMessageResponse"
|
|
11584
|
+
}
|
|
11585
|
+
},
|
|
11586
|
+
"text/event-stream": {
|
|
11587
|
+
"schema": {
|
|
11588
|
+
"type": "string",
|
|
11589
|
+
"description": "SSE stream of response chunks"
|
|
11590
|
+
}
|
|
11591
|
+
}
|
|
11592
|
+
}
|
|
11593
|
+
},
|
|
11594
|
+
"401": {
|
|
11595
|
+
"$ref": "#/components/responses/Unauthorized"
|
|
11596
|
+
},
|
|
11597
|
+
"403": {
|
|
11598
|
+
"$ref": "#/components/responses/Forbidden"
|
|
11599
|
+
}
|
|
11517
11600
|
}
|
|
11518
11601
|
}
|
|
11519
11602
|
},
|
|
11520
|
-
"
|
|
11521
|
-
"
|
|
11522
|
-
"
|
|
11523
|
-
|
|
11524
|
-
|
|
11525
|
-
|
|
11526
|
-
|
|
11603
|
+
"/v1/agents/{agent_id}/chat/conversations": {
|
|
11604
|
+
"get": {
|
|
11605
|
+
"tags": [
|
|
11606
|
+
"Agent Chat"
|
|
11607
|
+
],
|
|
11608
|
+
"summary": "List conversations",
|
|
11609
|
+
"description": "List all chat conversations for an agent.",
|
|
11610
|
+
"operationId": "listChatConversations",
|
|
11611
|
+
"parameters": [
|
|
11612
|
+
{
|
|
11613
|
+
"$ref": "#/components/parameters/AgentId"
|
|
11614
|
+
}
|
|
11615
|
+
],
|
|
11616
|
+
"responses": {
|
|
11617
|
+
"200": {
|
|
11618
|
+
"description": "Conversation list",
|
|
11619
|
+
"content": {
|
|
11620
|
+
"application/json": {
|
|
11621
|
+
"schema": {
|
|
11622
|
+
"$ref": "#/components/schemas/ChatConversationListResponse"
|
|
11623
|
+
}
|
|
11624
|
+
}
|
|
11527
11625
|
}
|
|
11626
|
+
},
|
|
11627
|
+
"401": {
|
|
11628
|
+
"$ref": "#/components/responses/Unauthorized"
|
|
11528
11629
|
}
|
|
11529
11630
|
}
|
|
11530
|
-
}
|
|
11531
|
-
|
|
11532
|
-
|
|
11533
|
-
|
|
11534
|
-
|
|
11631
|
+
}
|
|
11632
|
+
},
|
|
11633
|
+
"/v1/agents/{agent_id}/chat/conversations/{conversation_id}": {
|
|
11634
|
+
"get": {
|
|
11635
|
+
"tags": [
|
|
11636
|
+
"Agent Chat"
|
|
11637
|
+
],
|
|
11638
|
+
"summary": "Get conversation",
|
|
11639
|
+
"description": "Get a conversation with its full message history.",
|
|
11640
|
+
"operationId": "getChatConversation",
|
|
11641
|
+
"parameters": [
|
|
11642
|
+
{
|
|
11643
|
+
"$ref": "#/components/parameters/AgentId"
|
|
11644
|
+
},
|
|
11645
|
+
{
|
|
11646
|
+
"name": "conversation_id",
|
|
11647
|
+
"in": "path",
|
|
11648
|
+
"required": true,
|
|
11535
11649
|
"schema": {
|
|
11536
|
-
"
|
|
11650
|
+
"type": "string",
|
|
11651
|
+
"format": "uuid"
|
|
11652
|
+
}
|
|
11653
|
+
}
|
|
11654
|
+
],
|
|
11655
|
+
"responses": {
|
|
11656
|
+
"200": {
|
|
11657
|
+
"description": "Conversation detail",
|
|
11658
|
+
"content": {
|
|
11659
|
+
"application/json": {
|
|
11660
|
+
"schema": {
|
|
11661
|
+
"$ref": "#/components/schemas/ConversationDetailResponse"
|
|
11662
|
+
}
|
|
11663
|
+
}
|
|
11537
11664
|
}
|
|
11665
|
+
},
|
|
11666
|
+
"401": {
|
|
11667
|
+
"$ref": "#/components/responses/Unauthorized"
|
|
11668
|
+
},
|
|
11669
|
+
"404": {
|
|
11670
|
+
"$ref": "#/components/responses/NotFound"
|
|
11538
11671
|
}
|
|
11539
11672
|
}
|
|
11540
11673
|
},
|
|
11541
|
-
"
|
|
11542
|
-
"
|
|
11674
|
+
"delete": {
|
|
11675
|
+
"tags": [
|
|
11676
|
+
"Agent Chat"
|
|
11677
|
+
],
|
|
11678
|
+
"summary": "Archive conversation",
|
|
11679
|
+
"description": "Archive (soft-delete) a chat conversation.",
|
|
11680
|
+
"operationId": "deleteChatConversation",
|
|
11681
|
+
"parameters": [
|
|
11682
|
+
{
|
|
11683
|
+
"$ref": "#/components/parameters/AgentId"
|
|
11684
|
+
},
|
|
11685
|
+
{
|
|
11686
|
+
"name": "conversation_id",
|
|
11687
|
+
"in": "path",
|
|
11688
|
+
"required": true,
|
|
11689
|
+
"schema": {
|
|
11690
|
+
"type": "string",
|
|
11691
|
+
"format": "uuid"
|
|
11692
|
+
}
|
|
11693
|
+
}
|
|
11694
|
+
],
|
|
11695
|
+
"responses": {
|
|
11696
|
+
"204": {
|
|
11697
|
+
"description": "Conversation archived"
|
|
11698
|
+
},
|
|
11699
|
+
"401": {
|
|
11700
|
+
"$ref": "#/components/responses/Unauthorized"
|
|
11701
|
+
},
|
|
11702
|
+
"404": {
|
|
11703
|
+
"$ref": "#/components/responses/NotFound"
|
|
11704
|
+
}
|
|
11705
|
+
}
|
|
11706
|
+
}
|
|
11707
|
+
},
|
|
11708
|
+
"/v1/agents/{agent_id}/channels": {
|
|
11709
|
+
"post": {
|
|
11710
|
+
"tags": [
|
|
11711
|
+
"Agent Channels"
|
|
11712
|
+
],
|
|
11713
|
+
"summary": "Register channel",
|
|
11714
|
+
"description": "Register a new external messaging channel (Telegram, WhatsApp, Discord)\nfor an agent. Human-only. Returns the channel with its webhook URL.\n",
|
|
11715
|
+
"operationId": "createChannel",
|
|
11716
|
+
"parameters": [
|
|
11717
|
+
{
|
|
11718
|
+
"$ref": "#/components/parameters/AgentId"
|
|
11719
|
+
}
|
|
11720
|
+
],
|
|
11721
|
+
"requestBody": {
|
|
11722
|
+
"required": true,
|
|
11723
|
+
"content": {
|
|
11724
|
+
"application/json": {
|
|
11725
|
+
"schema": {
|
|
11726
|
+
"$ref": "#/components/schemas/CreateChannelRequest"
|
|
11727
|
+
}
|
|
11728
|
+
}
|
|
11729
|
+
}
|
|
11730
|
+
},
|
|
11731
|
+
"responses": {
|
|
11732
|
+
"201": {
|
|
11733
|
+
"description": "Channel created",
|
|
11734
|
+
"content": {
|
|
11735
|
+
"application/json": {
|
|
11736
|
+
"schema": {
|
|
11737
|
+
"$ref": "#/components/schemas/ChannelResponse"
|
|
11738
|
+
}
|
|
11739
|
+
}
|
|
11740
|
+
}
|
|
11741
|
+
},
|
|
11742
|
+
"400": {
|
|
11743
|
+
"$ref": "#/components/responses/BadRequest"
|
|
11744
|
+
},
|
|
11745
|
+
"401": {
|
|
11746
|
+
"$ref": "#/components/responses/Unauthorized"
|
|
11747
|
+
},
|
|
11748
|
+
"403": {
|
|
11749
|
+
"$ref": "#/components/responses/Forbidden"
|
|
11750
|
+
}
|
|
11751
|
+
}
|
|
11752
|
+
},
|
|
11753
|
+
"get": {
|
|
11754
|
+
"tags": [
|
|
11755
|
+
"Agent Channels"
|
|
11756
|
+
],
|
|
11757
|
+
"summary": "List channels",
|
|
11758
|
+
"description": "List all messaging channels for an agent.",
|
|
11759
|
+
"operationId": "listChannels",
|
|
11760
|
+
"parameters": [
|
|
11761
|
+
{
|
|
11762
|
+
"$ref": "#/components/parameters/AgentId"
|
|
11763
|
+
}
|
|
11764
|
+
],
|
|
11765
|
+
"responses": {
|
|
11766
|
+
"200": {
|
|
11767
|
+
"description": "Channel list",
|
|
11768
|
+
"content": {
|
|
11769
|
+
"application/json": {
|
|
11770
|
+
"schema": {
|
|
11771
|
+
"$ref": "#/components/schemas/ChannelListResponse"
|
|
11772
|
+
}
|
|
11773
|
+
}
|
|
11774
|
+
}
|
|
11775
|
+
},
|
|
11776
|
+
"401": {
|
|
11777
|
+
"$ref": "#/components/responses/Unauthorized"
|
|
11778
|
+
}
|
|
11779
|
+
}
|
|
11780
|
+
}
|
|
11781
|
+
},
|
|
11782
|
+
"/v1/agents/{agent_id}/channels/{channel_id}": {
|
|
11783
|
+
"patch": {
|
|
11784
|
+
"tags": [
|
|
11785
|
+
"Agent Channels"
|
|
11786
|
+
],
|
|
11787
|
+
"summary": "Update channel",
|
|
11788
|
+
"description": "Update a channel's name, active status, or config. Human-only.",
|
|
11789
|
+
"operationId": "updateChannel",
|
|
11790
|
+
"parameters": [
|
|
11791
|
+
{
|
|
11792
|
+
"$ref": "#/components/parameters/AgentId"
|
|
11793
|
+
},
|
|
11794
|
+
{
|
|
11795
|
+
"name": "channel_id",
|
|
11796
|
+
"in": "path",
|
|
11797
|
+
"required": true,
|
|
11798
|
+
"schema": {
|
|
11799
|
+
"type": "string",
|
|
11800
|
+
"format": "uuid"
|
|
11801
|
+
}
|
|
11802
|
+
}
|
|
11803
|
+
],
|
|
11804
|
+
"requestBody": {
|
|
11805
|
+
"required": true,
|
|
11806
|
+
"content": {
|
|
11807
|
+
"application/json": {
|
|
11808
|
+
"schema": {
|
|
11809
|
+
"$ref": "#/components/schemas/UpdateChannelRequest"
|
|
11810
|
+
}
|
|
11811
|
+
}
|
|
11812
|
+
}
|
|
11813
|
+
},
|
|
11814
|
+
"responses": {
|
|
11815
|
+
"200": {
|
|
11816
|
+
"description": "Channel updated",
|
|
11817
|
+
"content": {
|
|
11818
|
+
"application/json": {
|
|
11819
|
+
"schema": {
|
|
11820
|
+
"$ref": "#/components/schemas/ChannelResponse"
|
|
11821
|
+
}
|
|
11822
|
+
}
|
|
11823
|
+
}
|
|
11824
|
+
},
|
|
11825
|
+
"401": {
|
|
11826
|
+
"$ref": "#/components/responses/Unauthorized"
|
|
11827
|
+
},
|
|
11828
|
+
"403": {
|
|
11829
|
+
"$ref": "#/components/responses/Forbidden"
|
|
11830
|
+
},
|
|
11831
|
+
"404": {
|
|
11832
|
+
"$ref": "#/components/responses/NotFound"
|
|
11833
|
+
}
|
|
11834
|
+
}
|
|
11835
|
+
},
|
|
11836
|
+
"delete": {
|
|
11837
|
+
"tags": [
|
|
11838
|
+
"Agent Channels"
|
|
11839
|
+
],
|
|
11840
|
+
"summary": "Delete channel",
|
|
11841
|
+
"description": "Delete a messaging channel. Human-only.",
|
|
11842
|
+
"operationId": "deleteChannel",
|
|
11843
|
+
"parameters": [
|
|
11844
|
+
{
|
|
11845
|
+
"$ref": "#/components/parameters/AgentId"
|
|
11846
|
+
},
|
|
11847
|
+
{
|
|
11848
|
+
"name": "channel_id",
|
|
11849
|
+
"in": "path",
|
|
11850
|
+
"required": true,
|
|
11851
|
+
"schema": {
|
|
11852
|
+
"type": "string",
|
|
11853
|
+
"format": "uuid"
|
|
11854
|
+
}
|
|
11855
|
+
}
|
|
11856
|
+
],
|
|
11857
|
+
"responses": {
|
|
11858
|
+
"204": {
|
|
11859
|
+
"description": "Channel deleted"
|
|
11860
|
+
},
|
|
11861
|
+
"401": {
|
|
11862
|
+
"$ref": "#/components/responses/Unauthorized"
|
|
11863
|
+
},
|
|
11864
|
+
"403": {
|
|
11865
|
+
"$ref": "#/components/responses/Forbidden"
|
|
11866
|
+
},
|
|
11867
|
+
"404": {
|
|
11868
|
+
"$ref": "#/components/responses/NotFound"
|
|
11869
|
+
}
|
|
11870
|
+
}
|
|
11871
|
+
}
|
|
11872
|
+
},
|
|
11873
|
+
"/v1/agents/{agent_id}/channels/{channel_id}/send": {
|
|
11874
|
+
"post": {
|
|
11875
|
+
"tags": [
|
|
11876
|
+
"Agent Channels"
|
|
11877
|
+
],
|
|
11878
|
+
"summary": "Send outbound message",
|
|
11879
|
+
"description": "Send an outbound message via a registered channel.",
|
|
11880
|
+
"operationId": "sendChannelMessage",
|
|
11881
|
+
"parameters": [
|
|
11882
|
+
{
|
|
11883
|
+
"$ref": "#/components/parameters/AgentId"
|
|
11884
|
+
},
|
|
11885
|
+
{
|
|
11886
|
+
"name": "channel_id",
|
|
11887
|
+
"in": "path",
|
|
11888
|
+
"required": true,
|
|
11889
|
+
"schema": {
|
|
11890
|
+
"type": "string",
|
|
11891
|
+
"format": "uuid"
|
|
11892
|
+
}
|
|
11893
|
+
}
|
|
11894
|
+
],
|
|
11895
|
+
"requestBody": {
|
|
11896
|
+
"required": true,
|
|
11897
|
+
"content": {
|
|
11898
|
+
"application/json": {
|
|
11899
|
+
"schema": {
|
|
11900
|
+
"$ref": "#/components/schemas/SendChannelMessageRequest"
|
|
11901
|
+
}
|
|
11902
|
+
}
|
|
11903
|
+
}
|
|
11904
|
+
},
|
|
11905
|
+
"responses": {
|
|
11906
|
+
"200": {
|
|
11907
|
+
"description": "Message sent",
|
|
11908
|
+
"content": {
|
|
11909
|
+
"application/json": {
|
|
11910
|
+
"schema": {
|
|
11911
|
+
"$ref": "#/components/schemas/ChannelMessageResponse"
|
|
11912
|
+
}
|
|
11913
|
+
}
|
|
11914
|
+
}
|
|
11915
|
+
},
|
|
11916
|
+
"401": {
|
|
11917
|
+
"$ref": "#/components/responses/Unauthorized"
|
|
11918
|
+
},
|
|
11919
|
+
"404": {
|
|
11920
|
+
"$ref": "#/components/responses/NotFound"
|
|
11921
|
+
}
|
|
11922
|
+
}
|
|
11923
|
+
}
|
|
11924
|
+
},
|
|
11925
|
+
"/v1/agents/{agent_id}/channels/{channel_id}/messages": {
|
|
11926
|
+
"get": {
|
|
11927
|
+
"tags": [
|
|
11928
|
+
"Agent Channels"
|
|
11929
|
+
],
|
|
11930
|
+
"summary": "Channel message history",
|
|
11931
|
+
"description": "List inbound and outbound messages for a channel.",
|
|
11932
|
+
"operationId": "listChannelMessages",
|
|
11933
|
+
"parameters": [
|
|
11934
|
+
{
|
|
11935
|
+
"$ref": "#/components/parameters/AgentId"
|
|
11936
|
+
},
|
|
11937
|
+
{
|
|
11938
|
+
"name": "channel_id",
|
|
11939
|
+
"in": "path",
|
|
11940
|
+
"required": true,
|
|
11941
|
+
"schema": {
|
|
11942
|
+
"type": "string",
|
|
11943
|
+
"format": "uuid"
|
|
11944
|
+
}
|
|
11945
|
+
},
|
|
11946
|
+
{
|
|
11947
|
+
"name": "limit",
|
|
11948
|
+
"in": "query",
|
|
11949
|
+
"schema": {
|
|
11950
|
+
"type": "integer",
|
|
11951
|
+
"default": 50
|
|
11952
|
+
}
|
|
11953
|
+
}
|
|
11954
|
+
],
|
|
11955
|
+
"responses": {
|
|
11956
|
+
"200": {
|
|
11957
|
+
"description": "Message list",
|
|
11958
|
+
"content": {
|
|
11959
|
+
"application/json": {
|
|
11960
|
+
"schema": {
|
|
11961
|
+
"$ref": "#/components/schemas/ChannelMessageListResponse"
|
|
11962
|
+
}
|
|
11963
|
+
}
|
|
11964
|
+
}
|
|
11965
|
+
},
|
|
11966
|
+
"401": {
|
|
11967
|
+
"$ref": "#/components/responses/Unauthorized"
|
|
11968
|
+
}
|
|
11969
|
+
}
|
|
11970
|
+
}
|
|
11971
|
+
},
|
|
11972
|
+
"/v1/webhooks/telegram/{webhook_path}": {
|
|
11973
|
+
"post": {
|
|
11974
|
+
"tags": [
|
|
11975
|
+
"Agent Channels"
|
|
11976
|
+
],
|
|
11977
|
+
"summary": "Telegram webhook",
|
|
11978
|
+
"description": "Public webhook endpoint for receiving Telegram bot updates.",
|
|
11979
|
+
"operationId": "telegramWebhook",
|
|
11980
|
+
"security": [],
|
|
11981
|
+
"parameters": [
|
|
11982
|
+
{
|
|
11983
|
+
"name": "webhook_path",
|
|
11984
|
+
"in": "path",
|
|
11985
|
+
"required": true,
|
|
11986
|
+
"schema": {
|
|
11987
|
+
"type": "string"
|
|
11988
|
+
}
|
|
11989
|
+
}
|
|
11990
|
+
],
|
|
11991
|
+
"requestBody": {
|
|
11992
|
+
"required": true,
|
|
11993
|
+
"content": {
|
|
11994
|
+
"application/json": {
|
|
11995
|
+
"schema": {
|
|
11996
|
+
"type": "object"
|
|
11997
|
+
}
|
|
11998
|
+
}
|
|
11999
|
+
}
|
|
12000
|
+
},
|
|
12001
|
+
"responses": {
|
|
12002
|
+
"200": {
|
|
12003
|
+
"description": "Webhook processed"
|
|
12004
|
+
}
|
|
12005
|
+
}
|
|
12006
|
+
}
|
|
12007
|
+
},
|
|
12008
|
+
"/v1/webhooks/whatsapp/{webhook_path}": {
|
|
12009
|
+
"get": {
|
|
12010
|
+
"tags": [
|
|
12011
|
+
"Agent Channels"
|
|
12012
|
+
],
|
|
12013
|
+
"summary": "WhatsApp webhook verification",
|
|
12014
|
+
"description": "Verification endpoint for WhatsApp Cloud API webhook setup.",
|
|
12015
|
+
"operationId": "whatsappWebhookVerify",
|
|
12016
|
+
"security": [],
|
|
12017
|
+
"parameters": [
|
|
12018
|
+
{
|
|
12019
|
+
"name": "webhook_path",
|
|
12020
|
+
"in": "path",
|
|
12021
|
+
"required": true,
|
|
12022
|
+
"schema": {
|
|
12023
|
+
"type": "string"
|
|
12024
|
+
}
|
|
12025
|
+
},
|
|
12026
|
+
{
|
|
12027
|
+
"name": "hub.mode",
|
|
12028
|
+
"in": "query",
|
|
12029
|
+
"schema": {
|
|
12030
|
+
"type": "string"
|
|
12031
|
+
}
|
|
12032
|
+
},
|
|
12033
|
+
{
|
|
12034
|
+
"name": "hub.verify_token",
|
|
12035
|
+
"in": "query",
|
|
12036
|
+
"schema": {
|
|
12037
|
+
"type": "string"
|
|
12038
|
+
}
|
|
12039
|
+
},
|
|
12040
|
+
{
|
|
12041
|
+
"name": "hub.challenge",
|
|
12042
|
+
"in": "query",
|
|
12043
|
+
"schema": {
|
|
12044
|
+
"type": "string"
|
|
12045
|
+
}
|
|
12046
|
+
}
|
|
12047
|
+
],
|
|
12048
|
+
"responses": {
|
|
12049
|
+
"200": {
|
|
12050
|
+
"description": "Challenge response"
|
|
12051
|
+
}
|
|
12052
|
+
}
|
|
12053
|
+
},
|
|
12054
|
+
"post": {
|
|
12055
|
+
"tags": [
|
|
12056
|
+
"Agent Channels"
|
|
12057
|
+
],
|
|
12058
|
+
"summary": "WhatsApp webhook",
|
|
12059
|
+
"description": "Public webhook endpoint for receiving WhatsApp Cloud API events.",
|
|
12060
|
+
"operationId": "whatsappWebhook",
|
|
12061
|
+
"security": [],
|
|
12062
|
+
"parameters": [
|
|
12063
|
+
{
|
|
12064
|
+
"name": "webhook_path",
|
|
12065
|
+
"in": "path",
|
|
12066
|
+
"required": true,
|
|
12067
|
+
"schema": {
|
|
12068
|
+
"type": "string"
|
|
12069
|
+
}
|
|
12070
|
+
}
|
|
12071
|
+
],
|
|
12072
|
+
"requestBody": {
|
|
12073
|
+
"required": true,
|
|
12074
|
+
"content": {
|
|
12075
|
+
"application/json": {
|
|
12076
|
+
"schema": {
|
|
12077
|
+
"type": "object"
|
|
12078
|
+
}
|
|
12079
|
+
}
|
|
12080
|
+
}
|
|
12081
|
+
},
|
|
12082
|
+
"responses": {
|
|
12083
|
+
"200": {
|
|
12084
|
+
"description": "Webhook processed"
|
|
12085
|
+
}
|
|
12086
|
+
}
|
|
12087
|
+
}
|
|
12088
|
+
},
|
|
12089
|
+
"/v1/webhooks/discord/{webhook_path}": {
|
|
12090
|
+
"post": {
|
|
12091
|
+
"tags": [
|
|
12092
|
+
"Agent Channels"
|
|
12093
|
+
],
|
|
12094
|
+
"summary": "Discord webhook",
|
|
12095
|
+
"description": "Public webhook endpoint for receiving Discord bot interactions.",
|
|
12096
|
+
"operationId": "discordWebhook",
|
|
12097
|
+
"security": [],
|
|
12098
|
+
"parameters": [
|
|
12099
|
+
{
|
|
12100
|
+
"name": "webhook_path",
|
|
12101
|
+
"in": "path",
|
|
12102
|
+
"required": true,
|
|
12103
|
+
"schema": {
|
|
12104
|
+
"type": "string"
|
|
12105
|
+
}
|
|
12106
|
+
}
|
|
12107
|
+
],
|
|
12108
|
+
"requestBody": {
|
|
12109
|
+
"required": true,
|
|
12110
|
+
"content": {
|
|
12111
|
+
"application/json": {
|
|
12112
|
+
"schema": {
|
|
12113
|
+
"type": "object"
|
|
12114
|
+
}
|
|
12115
|
+
}
|
|
12116
|
+
}
|
|
12117
|
+
},
|
|
12118
|
+
"responses": {
|
|
12119
|
+
"200": {
|
|
12120
|
+
"description": "Webhook processed"
|
|
12121
|
+
}
|
|
12122
|
+
}
|
|
12123
|
+
}
|
|
12124
|
+
}
|
|
12125
|
+
},
|
|
12126
|
+
"components": {
|
|
12127
|
+
"securitySchemes": {
|
|
12128
|
+
"BearerAuth": {
|
|
12129
|
+
"type": "http",
|
|
12130
|
+
"scheme": "bearer",
|
|
12131
|
+
"bearerFormat": "JWT"
|
|
12132
|
+
},
|
|
12133
|
+
"ApiKeyAuth": {
|
|
12134
|
+
"type": "http",
|
|
12135
|
+
"scheme": "bearer",
|
|
12136
|
+
"description": "1ck_ prefixed API key used as Bearer token"
|
|
12137
|
+
}
|
|
12138
|
+
},
|
|
12139
|
+
"parameters": {
|
|
12140
|
+
"VaultId": {
|
|
12141
|
+
"name": "vault_id",
|
|
12142
|
+
"in": "path",
|
|
12143
|
+
"required": true,
|
|
12144
|
+
"schema": {
|
|
12145
|
+
"type": "string",
|
|
12146
|
+
"format": "uuid"
|
|
12147
|
+
}
|
|
12148
|
+
},
|
|
12149
|
+
"SecretPath": {
|
|
12150
|
+
"name": "path",
|
|
12151
|
+
"in": "path",
|
|
12152
|
+
"required": true,
|
|
12153
|
+
"schema": {
|
|
12154
|
+
"type": "string"
|
|
12155
|
+
},
|
|
12156
|
+
"description": "Secret path (e.g. \"db/credentials\")"
|
|
12157
|
+
},
|
|
12158
|
+
"AgentId": {
|
|
12159
|
+
"name": "agent_id",
|
|
12160
|
+
"in": "path",
|
|
12161
|
+
"required": true,
|
|
12162
|
+
"schema": {
|
|
12163
|
+
"type": "string",
|
|
12164
|
+
"format": "uuid"
|
|
12165
|
+
}
|
|
12166
|
+
},
|
|
12167
|
+
"PolicyId": {
|
|
12168
|
+
"name": "policy_id",
|
|
12169
|
+
"in": "path",
|
|
12170
|
+
"required": true,
|
|
12171
|
+
"schema": {
|
|
12172
|
+
"type": "string",
|
|
12173
|
+
"format": "uuid"
|
|
12174
|
+
}
|
|
12175
|
+
},
|
|
12176
|
+
"CardId": {
|
|
12177
|
+
"name": "card_id",
|
|
12178
|
+
"in": "path",
|
|
12179
|
+
"required": true,
|
|
12180
|
+
"schema": {
|
|
12181
|
+
"type": "string",
|
|
12182
|
+
"format": "uuid"
|
|
12183
|
+
}
|
|
12184
|
+
},
|
|
12185
|
+
"IncludeSignedTx": {
|
|
12186
|
+
"name": "include_signed_tx",
|
|
12187
|
+
"in": "query",
|
|
12188
|
+
"required": false,
|
|
12189
|
+
"description": "Set to `true` or `1` to include the raw signed transaction hex in the response. Omitted by default to reduce key exfiltration risk. Only the literal values \"true\" or \"1\" enable inclusion; any other value or omission returns responses without signed_tx. Applies to GET /v1/agents/{agent_id}/transactions and GET /v1/agents/{agent_id}/transactions/{tx_id}.\n",
|
|
12190
|
+
"schema": {
|
|
12191
|
+
"type": "boolean",
|
|
12192
|
+
"default": false,
|
|
12193
|
+
"example": false
|
|
12194
|
+
}
|
|
12195
|
+
}
|
|
12196
|
+
},
|
|
12197
|
+
"responses": {
|
|
12198
|
+
"BadRequest": {
|
|
12199
|
+
"description": "Invalid request",
|
|
12200
|
+
"content": {
|
|
12201
|
+
"application/json": {
|
|
12202
|
+
"schema": {
|
|
12203
|
+
"$ref": "#/components/schemas/ProblemDetails"
|
|
12204
|
+
}
|
|
12205
|
+
}
|
|
12206
|
+
}
|
|
12207
|
+
},
|
|
12208
|
+
"Unauthorized": {
|
|
12209
|
+
"description": "Authentication required or invalid",
|
|
12210
|
+
"content": {
|
|
12211
|
+
"application/json": {
|
|
12212
|
+
"schema": {
|
|
12213
|
+
"$ref": "#/components/schemas/ProblemDetails"
|
|
12214
|
+
}
|
|
12215
|
+
}
|
|
12216
|
+
}
|
|
12217
|
+
},
|
|
12218
|
+
"Forbidden": {
|
|
12219
|
+
"description": "Insufficient permissions",
|
|
11543
12220
|
"content": {
|
|
11544
12221
|
"application/json": {
|
|
11545
12222
|
"schema": {
|
|
@@ -19370,42 +20047,61 @@
|
|
|
19370
20047
|
"CreateAutomationRequest": {
|
|
19371
20048
|
"type": "object",
|
|
19372
20049
|
"required": [
|
|
19373
|
-
"name"
|
|
20050
|
+
"name",
|
|
20051
|
+
"agent_id",
|
|
20052
|
+
"trigger_type",
|
|
20053
|
+
"workflow_spec"
|
|
19374
20054
|
],
|
|
20055
|
+
"description": "Create an automation. `workflow_spec` is required and must be either\na JSON array of steps or `{ \"steps\": [...] }`. Dashboard `schedule`\ntrigger_type is accepted and normalized to `cron`. For cron triggers,\n`cron_expr` is required.\n",
|
|
19375
20056
|
"properties": {
|
|
19376
20057
|
"name": {
|
|
19377
20058
|
"type": "string"
|
|
19378
20059
|
},
|
|
19379
|
-
"description": {
|
|
19380
|
-
"type": "string"
|
|
19381
|
-
},
|
|
19382
20060
|
"agent_id": {
|
|
19383
20061
|
"type": "string",
|
|
19384
20062
|
"format": "uuid"
|
|
19385
20063
|
},
|
|
19386
20064
|
"trigger_type": {
|
|
19387
20065
|
"type": "string",
|
|
20066
|
+
"description": "cron | event | webhook | manual (alias schedule → cron)",
|
|
19388
20067
|
"enum": [
|
|
19389
|
-
"
|
|
19390
|
-
"webhook",
|
|
20068
|
+
"cron",
|
|
19391
20069
|
"event",
|
|
19392
|
-
"
|
|
20070
|
+
"webhook",
|
|
20071
|
+
"manual",
|
|
20072
|
+
"schedule"
|
|
19393
20073
|
]
|
|
19394
20074
|
},
|
|
19395
|
-
"
|
|
19396
|
-
"type": "
|
|
19397
|
-
"
|
|
20075
|
+
"cron_expr": {
|
|
20076
|
+
"type": "string",
|
|
20077
|
+
"description": "Required when trigger_type is cron (or schedule)",
|
|
20078
|
+
"example": "0 */6 * * *"
|
|
19398
20079
|
},
|
|
19399
|
-
"
|
|
19400
|
-
"type": "string"
|
|
20080
|
+
"timezone": {
|
|
20081
|
+
"type": "string",
|
|
20082
|
+
"default": "UTC",
|
|
20083
|
+
"example": "UTC"
|
|
19401
20084
|
},
|
|
19402
|
-
"
|
|
20085
|
+
"event_filter": {
|
|
19403
20086
|
"type": "object",
|
|
19404
|
-
"additionalProperties": true
|
|
20087
|
+
"additionalProperties": true,
|
|
20088
|
+
"nullable": true
|
|
19405
20089
|
},
|
|
19406
|
-
"
|
|
19407
|
-
"
|
|
19408
|
-
"
|
|
20090
|
+
"workflow_spec": {
|
|
20091
|
+
"description": "Workflow steps. Accepts a bare array `[...]` or\n`{ \"steps\": [...] }` (dashboard / preset shape).\n",
|
|
20092
|
+
"oneOf": [
|
|
20093
|
+
{
|
|
20094
|
+
"type": "array",
|
|
20095
|
+
"items": {
|
|
20096
|
+
"type": "object",
|
|
20097
|
+
"additionalProperties": true
|
|
20098
|
+
}
|
|
20099
|
+
},
|
|
20100
|
+
{
|
|
20101
|
+
"type": "object",
|
|
20102
|
+
"additionalProperties": true
|
|
20103
|
+
}
|
|
20104
|
+
]
|
|
19409
20105
|
}
|
|
19410
20106
|
}
|
|
19411
20107
|
},
|
|
@@ -19415,32 +20111,32 @@
|
|
|
19415
20111
|
"name": {
|
|
19416
20112
|
"type": "string"
|
|
19417
20113
|
},
|
|
19418
|
-
"
|
|
19419
|
-
"type": "string"
|
|
19420
|
-
},
|
|
19421
|
-
"agent_id": {
|
|
19422
|
-
"type": "string",
|
|
19423
|
-
"format": "uuid"
|
|
19424
|
-
},
|
|
19425
|
-
"trigger_type": {
|
|
20114
|
+
"cron_expr": {
|
|
19426
20115
|
"type": "string",
|
|
19427
|
-
"
|
|
19428
|
-
"schedule",
|
|
19429
|
-
"webhook",
|
|
19430
|
-
"event",
|
|
19431
|
-
"manual"
|
|
19432
|
-
]
|
|
19433
|
-
},
|
|
19434
|
-
"trigger_config": {
|
|
19435
|
-
"type": "object",
|
|
19436
|
-
"additionalProperties": true
|
|
20116
|
+
"nullable": true
|
|
19437
20117
|
},
|
|
19438
|
-
"
|
|
20118
|
+
"timezone": {
|
|
19439
20119
|
"type": "string"
|
|
19440
20120
|
},
|
|
19441
|
-
"
|
|
20121
|
+
"event_filter": {
|
|
19442
20122
|
"type": "object",
|
|
19443
|
-
"additionalProperties": true
|
|
20123
|
+
"additionalProperties": true,
|
|
20124
|
+
"nullable": true
|
|
20125
|
+
},
|
|
20126
|
+
"workflow_spec": {
|
|
20127
|
+
"oneOf": [
|
|
20128
|
+
{
|
|
20129
|
+
"type": "array",
|
|
20130
|
+
"items": {
|
|
20131
|
+
"type": "object",
|
|
20132
|
+
"additionalProperties": true
|
|
20133
|
+
}
|
|
20134
|
+
},
|
|
20135
|
+
{
|
|
20136
|
+
"type": "object",
|
|
20137
|
+
"additionalProperties": true
|
|
20138
|
+
}
|
|
20139
|
+
]
|
|
19444
20140
|
},
|
|
19445
20141
|
"is_active": {
|
|
19446
20142
|
"type": "boolean"
|
|
@@ -19451,8 +20147,11 @@
|
|
|
19451
20147
|
"type": "object",
|
|
19452
20148
|
"required": [
|
|
19453
20149
|
"id",
|
|
20150
|
+
"agent_id",
|
|
19454
20151
|
"name",
|
|
19455
20152
|
"trigger_type",
|
|
20153
|
+
"timezone",
|
|
20154
|
+
"workflow_spec",
|
|
19456
20155
|
"is_active",
|
|
19457
20156
|
"created_at",
|
|
19458
20157
|
"updated_at"
|
|
@@ -19462,58 +20161,58 @@
|
|
|
19462
20161
|
"type": "string",
|
|
19463
20162
|
"format": "uuid"
|
|
19464
20163
|
},
|
|
19465
|
-
"name": {
|
|
19466
|
-
"type": "string"
|
|
19467
|
-
},
|
|
19468
|
-
"description": {
|
|
19469
|
-
"type": "string",
|
|
19470
|
-
"nullable": true
|
|
19471
|
-
},
|
|
19472
20164
|
"agent_id": {
|
|
19473
20165
|
"type": "string",
|
|
19474
|
-
"format": "uuid"
|
|
19475
|
-
|
|
20166
|
+
"format": "uuid"
|
|
20167
|
+
},
|
|
20168
|
+
"name": {
|
|
20169
|
+
"type": "string"
|
|
19476
20170
|
},
|
|
19477
20171
|
"trigger_type": {
|
|
19478
20172
|
"type": "string",
|
|
19479
20173
|
"enum": [
|
|
19480
|
-
"
|
|
19481
|
-
"webhook",
|
|
20174
|
+
"cron",
|
|
19482
20175
|
"event",
|
|
20176
|
+
"webhook",
|
|
19483
20177
|
"manual"
|
|
19484
20178
|
]
|
|
19485
20179
|
},
|
|
19486
|
-
"
|
|
19487
|
-
"type": "object",
|
|
19488
|
-
"additionalProperties": true,
|
|
19489
|
-
"nullable": true
|
|
19490
|
-
},
|
|
19491
|
-
"action_type": {
|
|
20180
|
+
"cron_expr": {
|
|
19492
20181
|
"type": "string",
|
|
19493
20182
|
"nullable": true
|
|
19494
20183
|
},
|
|
19495
|
-
"
|
|
20184
|
+
"timezone": {
|
|
20185
|
+
"type": "string"
|
|
20186
|
+
},
|
|
20187
|
+
"event_filter": {
|
|
19496
20188
|
"type": "object",
|
|
19497
20189
|
"additionalProperties": true,
|
|
19498
20190
|
"nullable": true
|
|
19499
20191
|
},
|
|
20192
|
+
"workflow_spec": {
|
|
20193
|
+
"oneOf": [
|
|
20194
|
+
{
|
|
20195
|
+
"type": "array",
|
|
20196
|
+
"items": {
|
|
20197
|
+
"type": "object",
|
|
20198
|
+
"additionalProperties": true
|
|
20199
|
+
}
|
|
20200
|
+
},
|
|
20201
|
+
{
|
|
20202
|
+
"type": "object",
|
|
20203
|
+
"additionalProperties": true
|
|
20204
|
+
}
|
|
20205
|
+
]
|
|
20206
|
+
},
|
|
19500
20207
|
"is_active": {
|
|
19501
20208
|
"type": "boolean"
|
|
19502
20209
|
},
|
|
19503
|
-
"
|
|
19504
|
-
"type": "string",
|
|
19505
|
-
"nullable": true
|
|
19506
|
-
},
|
|
19507
|
-
"schedule_expression": {
|
|
19508
|
-
"type": "string",
|
|
19509
|
-
"nullable": true
|
|
19510
|
-
},
|
|
19511
|
-
"next_run_at": {
|
|
20210
|
+
"last_run_at": {
|
|
19512
20211
|
"type": "string",
|
|
19513
20212
|
"format": "date-time",
|
|
19514
20213
|
"nullable": true
|
|
19515
20214
|
},
|
|
19516
|
-
"
|
|
20215
|
+
"next_run_at": {
|
|
19517
20216
|
"type": "string",
|
|
19518
20217
|
"format": "date-time",
|
|
19519
20218
|
"nullable": true
|
|
@@ -19547,8 +20246,11 @@
|
|
|
19547
20246
|
"required": [
|
|
19548
20247
|
"id",
|
|
19549
20248
|
"automation_id",
|
|
20249
|
+
"agent_id",
|
|
19550
20250
|
"status",
|
|
19551
|
-
"started_at"
|
|
20251
|
+
"started_at",
|
|
20252
|
+
"tokens_used",
|
|
20253
|
+
"cost_cents"
|
|
19552
20254
|
],
|
|
19553
20255
|
"properties": {
|
|
19554
20256
|
"id": {
|
|
@@ -19559,32 +20261,45 @@
|
|
|
19559
20261
|
"type": "string",
|
|
19560
20262
|
"format": "uuid"
|
|
19561
20263
|
},
|
|
20264
|
+
"agent_id": {
|
|
20265
|
+
"type": "string",
|
|
20266
|
+
"format": "uuid"
|
|
20267
|
+
},
|
|
19562
20268
|
"status": {
|
|
19563
20269
|
"type": "string",
|
|
19564
20270
|
"enum": [
|
|
19565
20271
|
"pending",
|
|
19566
20272
|
"running",
|
|
19567
20273
|
"completed",
|
|
19568
|
-
"failed"
|
|
20274
|
+
"failed",
|
|
20275
|
+
"denied"
|
|
19569
20276
|
]
|
|
19570
20277
|
},
|
|
20278
|
+
"step_results": {
|
|
20279
|
+
"nullable": true
|
|
20280
|
+
},
|
|
20281
|
+
"error": {
|
|
20282
|
+
"type": "string",
|
|
20283
|
+
"nullable": true
|
|
20284
|
+
},
|
|
20285
|
+
"trigger_source": {
|
|
20286
|
+
"type": "string",
|
|
20287
|
+
"nullable": true
|
|
20288
|
+
},
|
|
19571
20289
|
"started_at": {
|
|
19572
20290
|
"type": "string",
|
|
19573
20291
|
"format": "date-time"
|
|
19574
20292
|
},
|
|
19575
|
-
"
|
|
20293
|
+
"finished_at": {
|
|
19576
20294
|
"type": "string",
|
|
19577
20295
|
"format": "date-time",
|
|
19578
20296
|
"nullable": true
|
|
19579
20297
|
},
|
|
19580
|
-
"
|
|
19581
|
-
"type": "
|
|
19582
|
-
"additionalProperties": true,
|
|
19583
|
-
"nullable": true
|
|
20298
|
+
"tokens_used": {
|
|
20299
|
+
"type": "integer"
|
|
19584
20300
|
},
|
|
19585
|
-
"
|
|
19586
|
-
"type": "
|
|
19587
|
-
"nullable": true
|
|
20301
|
+
"cost_cents": {
|
|
20302
|
+
"type": "integer"
|
|
19588
20303
|
}
|
|
19589
20304
|
}
|
|
19590
20305
|
},
|
|
@@ -19651,6 +20366,17 @@
|
|
|
19651
20366
|
"jwt",
|
|
19652
20367
|
"public"
|
|
19653
20368
|
]
|
|
20369
|
+
},
|
|
20370
|
+
"shell_access_enabled": {
|
|
20371
|
+
"type": "boolean",
|
|
20372
|
+
"default": false
|
|
20373
|
+
},
|
|
20374
|
+
"shell_auth_policy": {
|
|
20375
|
+
"type": "string",
|
|
20376
|
+
"description": "Step-up auth policy for shell (e.g. password, passkey, totp)"
|
|
20377
|
+
},
|
|
20378
|
+
"shell_max_session_minutes": {
|
|
20379
|
+
"type": "integer"
|
|
19654
20380
|
}
|
|
19655
20381
|
}
|
|
19656
20382
|
},
|
|
@@ -19694,6 +20420,15 @@
|
|
|
19694
20420
|
"jwt",
|
|
19695
20421
|
"public"
|
|
19696
20422
|
]
|
|
20423
|
+
},
|
|
20424
|
+
"shell_access_enabled": {
|
|
20425
|
+
"type": "boolean"
|
|
20426
|
+
},
|
|
20427
|
+
"shell_auth_policy": {
|
|
20428
|
+
"type": "string"
|
|
20429
|
+
},
|
|
20430
|
+
"shell_max_session_minutes": {
|
|
20431
|
+
"type": "integer"
|
|
19697
20432
|
}
|
|
19698
20433
|
}
|
|
19699
20434
|
},
|
|
@@ -19782,6 +20517,15 @@
|
|
|
19782
20517
|
],
|
|
19783
20518
|
"nullable": true
|
|
19784
20519
|
},
|
|
20520
|
+
"shell_access_enabled": {
|
|
20521
|
+
"type": "boolean"
|
|
20522
|
+
},
|
|
20523
|
+
"shell_auth_policy": {
|
|
20524
|
+
"type": "string"
|
|
20525
|
+
},
|
|
20526
|
+
"shell_max_session_minutes": {
|
|
20527
|
+
"type": "integer"
|
|
20528
|
+
},
|
|
19785
20529
|
"monthly_hours_used": {
|
|
19786
20530
|
"type": "number",
|
|
19787
20531
|
"nullable": true
|
|
@@ -19817,15 +20561,65 @@
|
|
|
19817
20561
|
"slug"
|
|
19818
20562
|
],
|
|
19819
20563
|
"properties": {
|
|
19820
|
-
"available": {
|
|
19821
|
-
"type": "boolean"
|
|
19822
|
-
},
|
|
19823
|
-
"slug": {
|
|
20564
|
+
"available": {
|
|
20565
|
+
"type": "boolean"
|
|
20566
|
+
},
|
|
20567
|
+
"slug": {
|
|
20568
|
+
"type": "string"
|
|
20569
|
+
},
|
|
20570
|
+
"reason": {
|
|
20571
|
+
"type": "string",
|
|
20572
|
+
"nullable": true
|
|
20573
|
+
}
|
|
20574
|
+
}
|
|
20575
|
+
},
|
|
20576
|
+
"ShellSessionRequest": {
|
|
20577
|
+
"type": "object",
|
|
20578
|
+
"description": "Step-up credentials for an interactive shell session.\nProvide one of password, totp_code, passkey_credential, or reauth_token.\n",
|
|
20579
|
+
"properties": {
|
|
20580
|
+
"password": {
|
|
20581
|
+
"type": "string"
|
|
20582
|
+
},
|
|
20583
|
+
"totp_code": {
|
|
20584
|
+
"type": "string"
|
|
20585
|
+
},
|
|
20586
|
+
"passkey_credential": {
|
|
20587
|
+
"type": "object",
|
|
20588
|
+
"additionalProperties": true
|
|
20589
|
+
},
|
|
20590
|
+
"reauth_token": {
|
|
20591
|
+
"type": "string",
|
|
20592
|
+
"description": "Single-use `rat_` token from POST /v1/auth/reauth (purpose runtime_shell)"
|
|
20593
|
+
}
|
|
20594
|
+
}
|
|
20595
|
+
},
|
|
20596
|
+
"ShellSessionResponse": {
|
|
20597
|
+
"type": "object",
|
|
20598
|
+
"required": [
|
|
20599
|
+
"session_token",
|
|
20600
|
+
"ws_url",
|
|
20601
|
+
"expires_in",
|
|
20602
|
+
"runtime_id",
|
|
20603
|
+
"max_session_minutes"
|
|
20604
|
+
],
|
|
20605
|
+
"properties": {
|
|
20606
|
+
"session_token": {
|
|
19824
20607
|
"type": "string"
|
|
19825
20608
|
},
|
|
19826
|
-
"
|
|
20609
|
+
"ws_url": {
|
|
19827
20610
|
"type": "string",
|
|
19828
|
-
"
|
|
20611
|
+
"description": "WebSocket URL for the PTY terminal"
|
|
20612
|
+
},
|
|
20613
|
+
"expires_in": {
|
|
20614
|
+
"type": "integer",
|
|
20615
|
+
"format": "int64"
|
|
20616
|
+
},
|
|
20617
|
+
"runtime_id": {
|
|
20618
|
+
"type": "string",
|
|
20619
|
+
"format": "uuid"
|
|
20620
|
+
},
|
|
20621
|
+
"max_session_minutes": {
|
|
20622
|
+
"type": "integer"
|
|
19829
20623
|
}
|
|
19830
20624
|
}
|
|
19831
20625
|
},
|
|
@@ -20089,6 +20883,307 @@
|
|
|
20089
20883
|
}
|
|
20090
20884
|
}
|
|
20091
20885
|
}
|
|
20886
|
+
},
|
|
20887
|
+
"SendChatMessageRequest": {
|
|
20888
|
+
"type": "object",
|
|
20889
|
+
"required": [
|
|
20890
|
+
"message"
|
|
20891
|
+
],
|
|
20892
|
+
"properties": {
|
|
20893
|
+
"message": {
|
|
20894
|
+
"type": "string"
|
|
20895
|
+
},
|
|
20896
|
+
"conversation_id": {
|
|
20897
|
+
"type": "string",
|
|
20898
|
+
"format": "uuid"
|
|
20899
|
+
},
|
|
20900
|
+
"mode": {
|
|
20901
|
+
"type": "string"
|
|
20902
|
+
},
|
|
20903
|
+
"model": {
|
|
20904
|
+
"type": "string"
|
|
20905
|
+
},
|
|
20906
|
+
"provider": {
|
|
20907
|
+
"type": "string"
|
|
20908
|
+
},
|
|
20909
|
+
"system_prompt": {
|
|
20910
|
+
"type": "string"
|
|
20911
|
+
}
|
|
20912
|
+
}
|
|
20913
|
+
},
|
|
20914
|
+
"ChatMessageResponse": {
|
|
20915
|
+
"type": "object",
|
|
20916
|
+
"properties": {
|
|
20917
|
+
"id": {
|
|
20918
|
+
"type": "string",
|
|
20919
|
+
"format": "uuid"
|
|
20920
|
+
},
|
|
20921
|
+
"conversation_id": {
|
|
20922
|
+
"type": "string",
|
|
20923
|
+
"format": "uuid"
|
|
20924
|
+
},
|
|
20925
|
+
"role": {
|
|
20926
|
+
"type": "string"
|
|
20927
|
+
},
|
|
20928
|
+
"content": {
|
|
20929
|
+
"type": "string"
|
|
20930
|
+
},
|
|
20931
|
+
"tool_calls": {},
|
|
20932
|
+
"tool_results": {},
|
|
20933
|
+
"tokens_prompt": {
|
|
20934
|
+
"type": "integer"
|
|
20935
|
+
},
|
|
20936
|
+
"tokens_completion": {
|
|
20937
|
+
"type": "integer"
|
|
20938
|
+
},
|
|
20939
|
+
"model": {
|
|
20940
|
+
"type": "string"
|
|
20941
|
+
},
|
|
20942
|
+
"created_at": {
|
|
20943
|
+
"type": "string",
|
|
20944
|
+
"format": "date-time"
|
|
20945
|
+
}
|
|
20946
|
+
}
|
|
20947
|
+
},
|
|
20948
|
+
"ChatConversationResponse": {
|
|
20949
|
+
"type": "object",
|
|
20950
|
+
"properties": {
|
|
20951
|
+
"id": {
|
|
20952
|
+
"type": "string",
|
|
20953
|
+
"format": "uuid"
|
|
20954
|
+
},
|
|
20955
|
+
"agent_id": {
|
|
20956
|
+
"type": "string",
|
|
20957
|
+
"format": "uuid"
|
|
20958
|
+
},
|
|
20959
|
+
"title": {
|
|
20960
|
+
"type": "string"
|
|
20961
|
+
},
|
|
20962
|
+
"mode": {
|
|
20963
|
+
"type": "string"
|
|
20964
|
+
},
|
|
20965
|
+
"model": {
|
|
20966
|
+
"type": "string"
|
|
20967
|
+
},
|
|
20968
|
+
"provider": {
|
|
20969
|
+
"type": "string"
|
|
20970
|
+
},
|
|
20971
|
+
"created_at": {
|
|
20972
|
+
"type": "string",
|
|
20973
|
+
"format": "date-time"
|
|
20974
|
+
},
|
|
20975
|
+
"updated_at": {
|
|
20976
|
+
"type": "string",
|
|
20977
|
+
"format": "date-time"
|
|
20978
|
+
}
|
|
20979
|
+
}
|
|
20980
|
+
},
|
|
20981
|
+
"ChatConversationListResponse": {
|
|
20982
|
+
"type": "object",
|
|
20983
|
+
"properties": {
|
|
20984
|
+
"conversations": {
|
|
20985
|
+
"type": "array",
|
|
20986
|
+
"items": {
|
|
20987
|
+
"$ref": "#/components/schemas/ChatConversationResponse"
|
|
20988
|
+
}
|
|
20989
|
+
}
|
|
20990
|
+
}
|
|
20991
|
+
},
|
|
20992
|
+
"ConversationDetailResponse": {
|
|
20993
|
+
"type": "object",
|
|
20994
|
+
"properties": {
|
|
20995
|
+
"conversation": {
|
|
20996
|
+
"$ref": "#/components/schemas/ChatConversationResponse"
|
|
20997
|
+
},
|
|
20998
|
+
"messages": {
|
|
20999
|
+
"type": "array",
|
|
21000
|
+
"items": {
|
|
21001
|
+
"$ref": "#/components/schemas/ChatMessageResponse"
|
|
21002
|
+
}
|
|
21003
|
+
}
|
|
21004
|
+
}
|
|
21005
|
+
},
|
|
21006
|
+
"SendChatMessageResponse": {
|
|
21007
|
+
"type": "object",
|
|
21008
|
+
"properties": {
|
|
21009
|
+
"conversation_id": {
|
|
21010
|
+
"type": "string",
|
|
21011
|
+
"format": "uuid"
|
|
21012
|
+
},
|
|
21013
|
+
"message": {
|
|
21014
|
+
"$ref": "#/components/schemas/ChatMessageResponse"
|
|
21015
|
+
}
|
|
21016
|
+
}
|
|
21017
|
+
},
|
|
21018
|
+
"CreateChannelRequest": {
|
|
21019
|
+
"type": "object",
|
|
21020
|
+
"required": [
|
|
21021
|
+
"channel_type",
|
|
21022
|
+
"config"
|
|
21023
|
+
],
|
|
21024
|
+
"properties": {
|
|
21025
|
+
"channel_type": {
|
|
21026
|
+
"type": "string",
|
|
21027
|
+
"enum": [
|
|
21028
|
+
"telegram",
|
|
21029
|
+
"whatsapp",
|
|
21030
|
+
"discord"
|
|
21031
|
+
]
|
|
21032
|
+
},
|
|
21033
|
+
"channel_name": {
|
|
21034
|
+
"type": "string"
|
|
21035
|
+
},
|
|
21036
|
+
"config": {
|
|
21037
|
+
"type": "object",
|
|
21038
|
+
"additionalProperties": {
|
|
21039
|
+
"type": "string"
|
|
21040
|
+
},
|
|
21041
|
+
"description": "Platform-specific config.\nTelegram: { bot_token }.\nWhatsApp: { phone_number_id, access_token, verify_token }.\nDiscord: { bot_token, application_id }.\n"
|
|
21042
|
+
}
|
|
21043
|
+
}
|
|
21044
|
+
},
|
|
21045
|
+
"UpdateChannelRequest": {
|
|
21046
|
+
"type": "object",
|
|
21047
|
+
"properties": {
|
|
21048
|
+
"channel_name": {
|
|
21049
|
+
"type": "string"
|
|
21050
|
+
},
|
|
21051
|
+
"is_active": {
|
|
21052
|
+
"type": "boolean"
|
|
21053
|
+
},
|
|
21054
|
+
"config": {
|
|
21055
|
+
"type": "object",
|
|
21056
|
+
"additionalProperties": {
|
|
21057
|
+
"type": "string"
|
|
21058
|
+
}
|
|
21059
|
+
}
|
|
21060
|
+
}
|
|
21061
|
+
},
|
|
21062
|
+
"ChannelResponse": {
|
|
21063
|
+
"type": "object",
|
|
21064
|
+
"properties": {
|
|
21065
|
+
"id": {
|
|
21066
|
+
"type": "string",
|
|
21067
|
+
"format": "uuid"
|
|
21068
|
+
},
|
|
21069
|
+
"org_id": {
|
|
21070
|
+
"type": "string",
|
|
21071
|
+
"format": "uuid"
|
|
21072
|
+
},
|
|
21073
|
+
"agent_id": {
|
|
21074
|
+
"type": "string",
|
|
21075
|
+
"format": "uuid"
|
|
21076
|
+
},
|
|
21077
|
+
"channel_type": {
|
|
21078
|
+
"type": "string",
|
|
21079
|
+
"enum": [
|
|
21080
|
+
"telegram",
|
|
21081
|
+
"whatsapp",
|
|
21082
|
+
"discord"
|
|
21083
|
+
]
|
|
21084
|
+
},
|
|
21085
|
+
"channel_name": {
|
|
21086
|
+
"type": "string"
|
|
21087
|
+
},
|
|
21088
|
+
"webhook_path": {
|
|
21089
|
+
"type": "string"
|
|
21090
|
+
},
|
|
21091
|
+
"webhook_url": {
|
|
21092
|
+
"type": "string"
|
|
21093
|
+
},
|
|
21094
|
+
"is_active": {
|
|
21095
|
+
"type": "boolean"
|
|
21096
|
+
},
|
|
21097
|
+
"created_at": {
|
|
21098
|
+
"type": "string",
|
|
21099
|
+
"format": "date-time"
|
|
21100
|
+
},
|
|
21101
|
+
"updated_at": {
|
|
21102
|
+
"type": "string",
|
|
21103
|
+
"format": "date-time"
|
|
21104
|
+
}
|
|
21105
|
+
}
|
|
21106
|
+
},
|
|
21107
|
+
"ChannelListResponse": {
|
|
21108
|
+
"type": "object",
|
|
21109
|
+
"properties": {
|
|
21110
|
+
"channels": {
|
|
21111
|
+
"type": "array",
|
|
21112
|
+
"items": {
|
|
21113
|
+
"$ref": "#/components/schemas/ChannelResponse"
|
|
21114
|
+
}
|
|
21115
|
+
}
|
|
21116
|
+
}
|
|
21117
|
+
},
|
|
21118
|
+
"SendChannelMessageRequest": {
|
|
21119
|
+
"type": "object",
|
|
21120
|
+
"required": [
|
|
21121
|
+
"external_chat_id",
|
|
21122
|
+
"content"
|
|
21123
|
+
],
|
|
21124
|
+
"properties": {
|
|
21125
|
+
"external_chat_id": {
|
|
21126
|
+
"type": "string",
|
|
21127
|
+
"description": "External platform chat/user ID"
|
|
21128
|
+
},
|
|
21129
|
+
"content": {
|
|
21130
|
+
"type": "string"
|
|
21131
|
+
},
|
|
21132
|
+
"reply_to": {
|
|
21133
|
+
"type": "string",
|
|
21134
|
+
"description": "External message ID to reply to"
|
|
21135
|
+
}
|
|
21136
|
+
}
|
|
21137
|
+
},
|
|
21138
|
+
"ChannelMessageResponse": {
|
|
21139
|
+
"type": "object",
|
|
21140
|
+
"properties": {
|
|
21141
|
+
"id": {
|
|
21142
|
+
"type": "string",
|
|
21143
|
+
"format": "uuid"
|
|
21144
|
+
},
|
|
21145
|
+
"channel_id": {
|
|
21146
|
+
"type": "string",
|
|
21147
|
+
"format": "uuid"
|
|
21148
|
+
},
|
|
21149
|
+
"direction": {
|
|
21150
|
+
"type": "string",
|
|
21151
|
+
"enum": [
|
|
21152
|
+
"inbound",
|
|
21153
|
+
"outbound"
|
|
21154
|
+
]
|
|
21155
|
+
},
|
|
21156
|
+
"external_chat_id": {
|
|
21157
|
+
"type": "string"
|
|
21158
|
+
},
|
|
21159
|
+
"external_message_id": {
|
|
21160
|
+
"type": "string"
|
|
21161
|
+
},
|
|
21162
|
+
"sender_name": {
|
|
21163
|
+
"type": "string"
|
|
21164
|
+
},
|
|
21165
|
+
"content": {
|
|
21166
|
+
"type": "string"
|
|
21167
|
+
},
|
|
21168
|
+
"media_url": {
|
|
21169
|
+
"type": "string"
|
|
21170
|
+
},
|
|
21171
|
+
"created_at": {
|
|
21172
|
+
"type": "string",
|
|
21173
|
+
"format": "date-time"
|
|
21174
|
+
}
|
|
21175
|
+
}
|
|
21176
|
+
},
|
|
21177
|
+
"ChannelMessageListResponse": {
|
|
21178
|
+
"type": "object",
|
|
21179
|
+
"properties": {
|
|
21180
|
+
"messages": {
|
|
21181
|
+
"type": "array",
|
|
21182
|
+
"items": {
|
|
21183
|
+
"$ref": "#/components/schemas/ChannelMessageResponse"
|
|
21184
|
+
}
|
|
21185
|
+
}
|
|
21186
|
+
}
|
|
20092
21187
|
}
|
|
20093
21188
|
}
|
|
20094
21189
|
}
|