@botpress/api 1.73.3 → 1.73.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.
- package/.eslintrc.js +0 -1
- package/dist/index.js +62 -1035
- package/dist/src/gen/runtime/state.d.ts +8 -468
- package/dist/src/gen/state.d.ts +8 -377
- package/package.json +7 -7
package/dist/index.js
CHANGED
|
@@ -275758,7 +275758,9 @@ var state = {
|
|
|
275758
275758
|
"type": "object",
|
|
275759
275759
|
"properties": {
|
|
275760
275760
|
"currentTaskId": {
|
|
275761
|
-
"type": "string"
|
|
275761
|
+
"type": "string",
|
|
275762
|
+
"deprecated": true,
|
|
275763
|
+
"description": "Unused. This parameter will be ignored if provided and should not be used when updating a conversation."
|
|
275762
275764
|
},
|
|
275763
275765
|
"tags": {
|
|
275764
275766
|
"type": "object",
|
|
@@ -277724,7 +277726,6 @@ var state = {
|
|
|
277724
277726
|
"user",
|
|
277725
277727
|
"bot",
|
|
277726
277728
|
"integration",
|
|
277727
|
-
"task",
|
|
277728
277729
|
"workflow"
|
|
277729
277730
|
]
|
|
277730
277731
|
},
|
|
@@ -277813,7 +277814,6 @@ var state = {
|
|
|
277813
277814
|
"user",
|
|
277814
277815
|
"bot",
|
|
277815
277816
|
"integration",
|
|
277816
|
-
"task",
|
|
277817
277817
|
"workflow"
|
|
277818
277818
|
]
|
|
277819
277819
|
},
|
|
@@ -277895,7 +277895,6 @@ var state = {
|
|
|
277895
277895
|
"user",
|
|
277896
277896
|
"bot",
|
|
277897
277897
|
"integration",
|
|
277898
|
-
"task",
|
|
277899
277898
|
"workflow"
|
|
277900
277899
|
]
|
|
277901
277900
|
},
|
|
@@ -277990,7 +277989,6 @@ var state = {
|
|
|
277990
277989
|
"user",
|
|
277991
277990
|
"bot",
|
|
277992
277991
|
"integration",
|
|
277993
|
-
"task",
|
|
277994
277992
|
"workflow"
|
|
277995
277993
|
]
|
|
277996
277994
|
},
|
|
@@ -278097,7 +278095,6 @@ var state = {
|
|
|
278097
278095
|
"user",
|
|
278098
278096
|
"bot",
|
|
278099
278097
|
"integration",
|
|
278100
|
-
"task",
|
|
278101
278098
|
"workflow"
|
|
278102
278099
|
]
|
|
278103
278100
|
},
|
|
@@ -278327,403 +278324,6 @@ var state = {
|
|
|
278327
278324
|
}
|
|
278328
278325
|
}
|
|
278329
278326
|
},
|
|
278330
|
-
"getTask": {
|
|
278331
|
-
"name": "getTask",
|
|
278332
|
-
"description": "Retrieves the [Task](#schema_task) object for a valid identifier.",
|
|
278333
|
-
"method": "get",
|
|
278334
|
-
"path": "/v1/chat/tasks/{id}",
|
|
278335
|
-
"parameters": {
|
|
278336
|
-
"id": {
|
|
278337
|
-
"in": "path",
|
|
278338
|
-
"type": "string",
|
|
278339
|
-
"description": "Task id"
|
|
278340
|
-
},
|
|
278341
|
-
"x-bot-id": {
|
|
278342
|
-
"in": "header",
|
|
278343
|
-
"description": "Bot id",
|
|
278344
|
-
"type": "string",
|
|
278345
|
-
"required": true
|
|
278346
|
-
},
|
|
278347
|
-
"x-integration-id": {
|
|
278348
|
-
"in": "header",
|
|
278349
|
-
"description": "Integration id",
|
|
278350
|
-
"type": "string",
|
|
278351
|
-
"required": false
|
|
278352
|
-
},
|
|
278353
|
-
"x-integration-alias": {
|
|
278354
|
-
"in": "header",
|
|
278355
|
-
"description": "Integration alias",
|
|
278356
|
-
"type": "string",
|
|
278357
|
-
"required": false
|
|
278358
|
-
}
|
|
278359
|
-
},
|
|
278360
|
-
"section": "task",
|
|
278361
|
-
"response": {
|
|
278362
|
-
"description": "Returns a [Task](#schema_task) object if a valid identifier was provided. Returns an [Error](#errors) otherwise",
|
|
278363
|
-
"schema": {
|
|
278364
|
-
"type": "object",
|
|
278365
|
-
"properties": {
|
|
278366
|
-
"task": {
|
|
278367
|
-
"$ref": "#/components/schemas/Task"
|
|
278368
|
-
}
|
|
278369
|
-
},
|
|
278370
|
-
"required": [
|
|
278371
|
-
"task"
|
|
278372
|
-
],
|
|
278373
|
-
"title": "getTaskResponse",
|
|
278374
|
-
"additionalProperties": false
|
|
278375
|
-
}
|
|
278376
|
-
}
|
|
278377
|
-
},
|
|
278378
|
-
"createTask": {
|
|
278379
|
-
"name": "createTask",
|
|
278380
|
-
"description": "Creates a new [Task](#schema_task). When creating a new [Task](#schema_task), the required tags must be provided. See the specific integration for more details.",
|
|
278381
|
-
"method": "post",
|
|
278382
|
-
"path": "/v1/chat/tasks",
|
|
278383
|
-
"requestBody": {
|
|
278384
|
-
"description": "Task data",
|
|
278385
|
-
"schema": {
|
|
278386
|
-
"type": "object",
|
|
278387
|
-
"properties": {
|
|
278388
|
-
"title": {
|
|
278389
|
-
"type": "string",
|
|
278390
|
-
"maxLength": 2e3,
|
|
278391
|
-
"description": "Title describing the task"
|
|
278392
|
-
},
|
|
278393
|
-
"description": {
|
|
278394
|
-
"type": "string",
|
|
278395
|
-
"maxLength": 2e4,
|
|
278396
|
-
"description": "All the notes related to the execution of the current task"
|
|
278397
|
-
},
|
|
278398
|
-
"type": {
|
|
278399
|
-
"type": "string",
|
|
278400
|
-
"maxLength": 200,
|
|
278401
|
-
"description": "Type of the task"
|
|
278402
|
-
},
|
|
278403
|
-
"data": {
|
|
278404
|
-
"type": "object",
|
|
278405
|
-
"additionalProperties": true,
|
|
278406
|
-
"description": "Content related to the task"
|
|
278407
|
-
},
|
|
278408
|
-
"parentTaskId": {
|
|
278409
|
-
"type": "string",
|
|
278410
|
-
"description": "Parent task id is the parent task that created this task"
|
|
278411
|
-
},
|
|
278412
|
-
"conversationId": {
|
|
278413
|
-
"type": "string",
|
|
278414
|
-
"description": "Conversation id related to this task"
|
|
278415
|
-
},
|
|
278416
|
-
"userId": {
|
|
278417
|
-
"type": "string",
|
|
278418
|
-
"description": "Specific user related to this task"
|
|
278419
|
-
},
|
|
278420
|
-
"timeoutAt": {
|
|
278421
|
-
"type": "string",
|
|
278422
|
-
"format": "date-time",
|
|
278423
|
-
"description": "The timeout date where the task should be failed in the ISO 8601 format"
|
|
278424
|
-
},
|
|
278425
|
-
"tags": {
|
|
278426
|
-
"type": "object",
|
|
278427
|
-
"additionalProperties": {
|
|
278428
|
-
"type": "string",
|
|
278429
|
-
"maxLength": 500
|
|
278430
|
-
},
|
|
278431
|
-
"description": "Tags for the [Task](#schema_task)"
|
|
278432
|
-
}
|
|
278433
|
-
},
|
|
278434
|
-
"required": [
|
|
278435
|
-
"type",
|
|
278436
|
-
"conversationId"
|
|
278437
|
-
],
|
|
278438
|
-
"title": "createTaskBody",
|
|
278439
|
-
"additionalProperties": false
|
|
278440
|
-
}
|
|
278441
|
-
},
|
|
278442
|
-
"section": "task",
|
|
278443
|
-
"response": {
|
|
278444
|
-
"description": "Returns a [Task](#schema_task) object if creation succeeds. Returns an [Error](#errors) otherwise",
|
|
278445
|
-
"status": 201,
|
|
278446
|
-
"schema": {
|
|
278447
|
-
"type": "object",
|
|
278448
|
-
"properties": {
|
|
278449
|
-
"task": {
|
|
278450
|
-
"$ref": "#/components/schemas/Task"
|
|
278451
|
-
}
|
|
278452
|
-
},
|
|
278453
|
-
"required": [
|
|
278454
|
-
"task"
|
|
278455
|
-
],
|
|
278456
|
-
"title": "createTaskResponse",
|
|
278457
|
-
"additionalProperties": false
|
|
278458
|
-
}
|
|
278459
|
-
},
|
|
278460
|
-
"parameters": {
|
|
278461
|
-
"x-bot-id": {
|
|
278462
|
-
"in": "header",
|
|
278463
|
-
"description": "Bot id",
|
|
278464
|
-
"type": "string",
|
|
278465
|
-
"required": true
|
|
278466
|
-
},
|
|
278467
|
-
"x-integration-id": {
|
|
278468
|
-
"in": "header",
|
|
278469
|
-
"description": "Integration id",
|
|
278470
|
-
"type": "string",
|
|
278471
|
-
"required": false
|
|
278472
|
-
},
|
|
278473
|
-
"x-integration-alias": {
|
|
278474
|
-
"in": "header",
|
|
278475
|
-
"description": "Integration alias",
|
|
278476
|
-
"type": "string",
|
|
278477
|
-
"required": false
|
|
278478
|
-
}
|
|
278479
|
-
}
|
|
278480
|
-
},
|
|
278481
|
-
"updateTask": {
|
|
278482
|
-
"name": "updateTask",
|
|
278483
|
-
"description": "Update a [Task](#schema_task) object by setting the values of the parameters passed. Any parameters not provided will be left unchanged.",
|
|
278484
|
-
"method": "put",
|
|
278485
|
-
"path": "/v1/chat/tasks/{id}",
|
|
278486
|
-
"parameters": {
|
|
278487
|
-
"id": {
|
|
278488
|
-
"in": "path",
|
|
278489
|
-
"type": "string",
|
|
278490
|
-
"description": "Task id"
|
|
278491
|
-
},
|
|
278492
|
-
"x-bot-id": {
|
|
278493
|
-
"in": "header",
|
|
278494
|
-
"description": "Bot id",
|
|
278495
|
-
"type": "string",
|
|
278496
|
-
"required": true
|
|
278497
|
-
},
|
|
278498
|
-
"x-integration-id": {
|
|
278499
|
-
"in": "header",
|
|
278500
|
-
"description": "Integration id",
|
|
278501
|
-
"type": "string",
|
|
278502
|
-
"required": false
|
|
278503
|
-
},
|
|
278504
|
-
"x-integration-alias": {
|
|
278505
|
-
"in": "header",
|
|
278506
|
-
"description": "Integration alias",
|
|
278507
|
-
"type": "string",
|
|
278508
|
-
"required": false
|
|
278509
|
-
}
|
|
278510
|
-
},
|
|
278511
|
-
"requestBody": {
|
|
278512
|
-
"description": "Task data",
|
|
278513
|
-
"schema": {
|
|
278514
|
-
"type": "object",
|
|
278515
|
-
"properties": {
|
|
278516
|
-
"title": {
|
|
278517
|
-
"type": "string",
|
|
278518
|
-
"description": "Title describing the task"
|
|
278519
|
-
},
|
|
278520
|
-
"description": {
|
|
278521
|
-
"type": "string",
|
|
278522
|
-
"description": "All the notes related to the execution of the current task"
|
|
278523
|
-
},
|
|
278524
|
-
"data": {
|
|
278525
|
-
"type": "object",
|
|
278526
|
-
"additionalProperties": true,
|
|
278527
|
-
"description": "Content related to the task"
|
|
278528
|
-
},
|
|
278529
|
-
"timeoutAt": {
|
|
278530
|
-
"type": "string",
|
|
278531
|
-
"format": "date-time",
|
|
278532
|
-
"description": "The timeout date where the task should be failed in the ISO 8601 format"
|
|
278533
|
-
},
|
|
278534
|
-
"status": {
|
|
278535
|
-
"type": "string",
|
|
278536
|
-
"enum": [
|
|
278537
|
-
"pending",
|
|
278538
|
-
"in_progress",
|
|
278539
|
-
"failed",
|
|
278540
|
-
"completed",
|
|
278541
|
-
"blocked",
|
|
278542
|
-
"paused",
|
|
278543
|
-
"timeout",
|
|
278544
|
-
"cancelled"
|
|
278545
|
-
],
|
|
278546
|
-
"description": "Status of the task"
|
|
278547
|
-
},
|
|
278548
|
-
"tags": {
|
|
278549
|
-
"type": "object",
|
|
278550
|
-
"additionalProperties": {
|
|
278551
|
-
"type": "string",
|
|
278552
|
-
"maxLength": 500
|
|
278553
|
-
},
|
|
278554
|
-
"description": "Tags for the [Task](#schema_task)"
|
|
278555
|
-
}
|
|
278556
|
-
},
|
|
278557
|
-
"title": "updateTaskBody",
|
|
278558
|
-
"additionalProperties": false
|
|
278559
|
-
}
|
|
278560
|
-
},
|
|
278561
|
-
"section": "task",
|
|
278562
|
-
"response": {
|
|
278563
|
-
"description": "Returns an updated [Task](#schema_task) object if a valid identifier was provided. Returns an [Error](#errors) otherwise",
|
|
278564
|
-
"schema": {
|
|
278565
|
-
"type": "object",
|
|
278566
|
-
"properties": {
|
|
278567
|
-
"task": {
|
|
278568
|
-
"$ref": "#/components/schemas/Task"
|
|
278569
|
-
}
|
|
278570
|
-
},
|
|
278571
|
-
"required": [
|
|
278572
|
-
"task"
|
|
278573
|
-
],
|
|
278574
|
-
"title": "updateTaskResponse",
|
|
278575
|
-
"additionalProperties": false
|
|
278576
|
-
}
|
|
278577
|
-
}
|
|
278578
|
-
},
|
|
278579
|
-
"deleteTask": {
|
|
278580
|
-
"name": "deleteTask",
|
|
278581
|
-
"description": "Permanently deletes a [Task](#schema_task). It cannot be undone.",
|
|
278582
|
-
"method": "delete",
|
|
278583
|
-
"path": "/v1/chat/tasks/{id}",
|
|
278584
|
-
"parameters": {
|
|
278585
|
-
"id": {
|
|
278586
|
-
"in": "path",
|
|
278587
|
-
"type": "string",
|
|
278588
|
-
"description": "Task id"
|
|
278589
|
-
},
|
|
278590
|
-
"x-bot-id": {
|
|
278591
|
-
"in": "header",
|
|
278592
|
-
"description": "Bot id",
|
|
278593
|
-
"type": "string",
|
|
278594
|
-
"required": true
|
|
278595
|
-
},
|
|
278596
|
-
"x-integration-id": {
|
|
278597
|
-
"in": "header",
|
|
278598
|
-
"description": "Integration id",
|
|
278599
|
-
"type": "string",
|
|
278600
|
-
"required": false
|
|
278601
|
-
},
|
|
278602
|
-
"x-integration-alias": {
|
|
278603
|
-
"in": "header",
|
|
278604
|
-
"description": "Integration alias",
|
|
278605
|
-
"type": "string",
|
|
278606
|
-
"required": false
|
|
278607
|
-
}
|
|
278608
|
-
},
|
|
278609
|
-
"section": "task",
|
|
278610
|
-
"response": {
|
|
278611
|
-
"description": "Returns the [Task](#schema_task) object that was deleted",
|
|
278612
|
-
"schema": {
|
|
278613
|
-
"type": "object",
|
|
278614
|
-
"title": "deleteTaskResponse",
|
|
278615
|
-
"additionalProperties": false
|
|
278616
|
-
}
|
|
278617
|
-
}
|
|
278618
|
-
},
|
|
278619
|
-
"listTasks": {
|
|
278620
|
-
"name": "listTasks",
|
|
278621
|
-
"description": "Retrieves a list of [Task](#schema_task) you've previously created. The tasks are returned in sorted order, with the most recent appearing first. The list can be filtered using [Tags](/docs/developers/concepts/tags).",
|
|
278622
|
-
"method": "get",
|
|
278623
|
-
"path": "/v1/chat/tasks",
|
|
278624
|
-
"parameters": {
|
|
278625
|
-
"nextToken": {
|
|
278626
|
-
"in": "query",
|
|
278627
|
-
"description": "Provide the `meta.nextToken` value provided in the last API response to retrieve the next page of results",
|
|
278628
|
-
"type": "string"
|
|
278629
|
-
},
|
|
278630
|
-
"tags": {
|
|
278631
|
-
"in": "query",
|
|
278632
|
-
"type": "object",
|
|
278633
|
-
"schema": {
|
|
278634
|
-
"type": "object",
|
|
278635
|
-
"additionalProperties": {
|
|
278636
|
-
"type": "string"
|
|
278637
|
-
}
|
|
278638
|
-
},
|
|
278639
|
-
"description": "Filter by tags"
|
|
278640
|
-
},
|
|
278641
|
-
"conversationId": {
|
|
278642
|
-
"in": "query",
|
|
278643
|
-
"type": "string",
|
|
278644
|
-
"description": "Conversation id"
|
|
278645
|
-
},
|
|
278646
|
-
"userId": {
|
|
278647
|
-
"in": "query",
|
|
278648
|
-
"type": "string",
|
|
278649
|
-
"description": "User id"
|
|
278650
|
-
},
|
|
278651
|
-
"parentTaskId": {
|
|
278652
|
-
"in": "query",
|
|
278653
|
-
"type": "string",
|
|
278654
|
-
"description": "Parent task id"
|
|
278655
|
-
},
|
|
278656
|
-
"status": {
|
|
278657
|
-
"in": "query",
|
|
278658
|
-
"type": "string[]",
|
|
278659
|
-
"description": "Status",
|
|
278660
|
-
"enum": [
|
|
278661
|
-
"pending",
|
|
278662
|
-
"in_progress",
|
|
278663
|
-
"failed",
|
|
278664
|
-
"completed",
|
|
278665
|
-
"blocked",
|
|
278666
|
-
"paused",
|
|
278667
|
-
"timeout",
|
|
278668
|
-
"cancelled"
|
|
278669
|
-
]
|
|
278670
|
-
},
|
|
278671
|
-
"type": {
|
|
278672
|
-
"in": "query",
|
|
278673
|
-
"type": "string",
|
|
278674
|
-
"description": "Type"
|
|
278675
|
-
},
|
|
278676
|
-
"x-bot-id": {
|
|
278677
|
-
"in": "header",
|
|
278678
|
-
"description": "Bot id",
|
|
278679
|
-
"type": "string",
|
|
278680
|
-
"required": true
|
|
278681
|
-
},
|
|
278682
|
-
"x-integration-id": {
|
|
278683
|
-
"in": "header",
|
|
278684
|
-
"description": "Integration id",
|
|
278685
|
-
"type": "string",
|
|
278686
|
-
"required": false
|
|
278687
|
-
},
|
|
278688
|
-
"x-integration-alias": {
|
|
278689
|
-
"in": "header",
|
|
278690
|
-
"description": "Integration alias",
|
|
278691
|
-
"type": "string",
|
|
278692
|
-
"required": false
|
|
278693
|
-
}
|
|
278694
|
-
},
|
|
278695
|
-
"section": "task",
|
|
278696
|
-
"response": {
|
|
278697
|
-
"description": "Returns a list of [Task](#schema_task) objects",
|
|
278698
|
-
"schema": {
|
|
278699
|
-
"type": "object",
|
|
278700
|
-
"properties": {
|
|
278701
|
-
"tasks": {
|
|
278702
|
-
"type": "array",
|
|
278703
|
-
"items": {
|
|
278704
|
-
"$ref": "#/components/schemas/Task"
|
|
278705
|
-
}
|
|
278706
|
-
},
|
|
278707
|
-
"meta": {
|
|
278708
|
-
"type": "object",
|
|
278709
|
-
"properties": {
|
|
278710
|
-
"nextToken": {
|
|
278711
|
-
"type": "string",
|
|
278712
|
-
"description": "The token to use to retrieve the next page of results, passed as a query string parameter (value should be URL-encoded) to this API endpoint."
|
|
278713
|
-
}
|
|
278714
|
-
},
|
|
278715
|
-
"additionalProperties": false
|
|
278716
|
-
}
|
|
278717
|
-
},
|
|
278718
|
-
"required": [
|
|
278719
|
-
"tasks",
|
|
278720
|
-
"meta"
|
|
278721
|
-
],
|
|
278722
|
-
"title": "listTasksResponse",
|
|
278723
|
-
"additionalProperties": false
|
|
278724
|
-
}
|
|
278725
|
-
}
|
|
278726
|
-
},
|
|
278727
278327
|
"createWorkflow": {
|
|
278728
278328
|
"name": "createWorkflow",
|
|
278729
278329
|
"description": "Creates a new [Workflow](#schema_workflow).",
|
|
@@ -279401,6 +279001,10 @@ var state = {
|
|
|
279401
279001
|
"schema": {
|
|
279402
279002
|
"type": "object",
|
|
279403
279003
|
"properties": {
|
|
279004
|
+
"id": {
|
|
279005
|
+
"type": "string",
|
|
279006
|
+
"description": "Caller-defined identifier for the observation (e.g. llmz context ID). Uniqueness is not enforced nor guaranteed."
|
|
279007
|
+
},
|
|
279404
279008
|
"name": {
|
|
279405
279009
|
"type": "string",
|
|
279406
279010
|
"description": "Name of the observation"
|
|
@@ -279478,7 +279082,7 @@ var state = {
|
|
|
279478
279082
|
"title": "Botpress Runtime API",
|
|
279479
279083
|
"description": "API for Botpress Runtime",
|
|
279480
279084
|
"server": "https://api.botpress.cloud",
|
|
279481
|
-
"version": "1.73.
|
|
279085
|
+
"version": "1.73.4",
|
|
279482
279086
|
"prefix": "v1"
|
|
279483
279087
|
},
|
|
279484
279088
|
"defaultParameters": {
|
|
@@ -279655,8 +279259,6 @@ var state = {
|
|
|
279655
279259
|
"patchStateBody": true,
|
|
279656
279260
|
"callActionBody": true,
|
|
279657
279261
|
"configureIntegrationBody": true,
|
|
279658
|
-
"createTaskBody": true,
|
|
279659
|
-
"updateTaskBody": true,
|
|
279660
279262
|
"createWorkflowBody": true,
|
|
279661
279263
|
"updateWorkflowBody": true,
|
|
279662
279264
|
"getOrCreateWorkflowBody": true,
|
|
@@ -279699,11 +279301,6 @@ var state = {
|
|
|
279699
279301
|
"patchStateResponse": true,
|
|
279700
279302
|
"callActionResponse": true,
|
|
279701
279303
|
"configureIntegrationResponse": true,
|
|
279702
|
-
"getTaskResponse": true,
|
|
279703
|
-
"createTaskResponse": true,
|
|
279704
|
-
"updateTaskResponse": true,
|
|
279705
|
-
"deleteTaskResponse": true,
|
|
279706
|
-
"listTasksResponse": true,
|
|
279707
279304
|
"createWorkflowResponse": true,
|
|
279708
279305
|
"getWorkflowResponse": true,
|
|
279709
279306
|
"updateWorkflowResponse": true,
|
|
@@ -279720,7 +279317,6 @@ var state = {
|
|
|
279720
279317
|
"Event": true,
|
|
279721
279318
|
"Message": true,
|
|
279722
279319
|
"State": true,
|
|
279723
|
-
"Task": true,
|
|
279724
279320
|
"Workflow": true
|
|
279725
279321
|
}
|
|
279726
279322
|
},
|
|
@@ -279797,7 +279393,8 @@ var state = {
|
|
|
279797
279393
|
"type": "string",
|
|
279798
279394
|
"minLength": 28,
|
|
279799
279395
|
"maxLength": 36,
|
|
279800
|
-
"
|
|
279396
|
+
"deprecated": true,
|
|
279397
|
+
"description": "Unused. This field will be removed in the future."
|
|
279801
279398
|
},
|
|
279802
279399
|
"currentWorkflowId": {
|
|
279803
279400
|
"type": "string",
|
|
@@ -280048,11 +279645,10 @@ var state = {
|
|
|
280048
279645
|
"conversation",
|
|
280049
279646
|
"user",
|
|
280050
279647
|
"bot",
|
|
280051
|
-
"task",
|
|
280052
279648
|
"integration",
|
|
280053
279649
|
"workflow"
|
|
280054
279650
|
],
|
|
280055
|
-
"description": "Type of the [State](#schema_state) represents the resource type (`conversation`, `user`, `bot`, `
|
|
279651
|
+
"description": "Type of the [State](#schema_state) represents the resource type (`conversation`, `user`, `bot`, `integration` or `workflow`) that the state is related to"
|
|
280056
279652
|
},
|
|
280057
279653
|
"payload": {
|
|
280058
279654
|
"type": "object",
|
|
@@ -280073,112 +279669,6 @@ var state = {
|
|
|
280073
279669
|
"additionalProperties": false
|
|
280074
279670
|
}
|
|
280075
279671
|
},
|
|
280076
|
-
"Task": {
|
|
280077
|
-
"section": "task",
|
|
280078
|
-
"schema": {
|
|
280079
|
-
"type": "object",
|
|
280080
|
-
"properties": {
|
|
280081
|
-
"id": {
|
|
280082
|
-
"type": "string",
|
|
280083
|
-
"minLength": 28,
|
|
280084
|
-
"maxLength": 36,
|
|
280085
|
-
"description": "Id of the [Task](#schema_task)"
|
|
280086
|
-
},
|
|
280087
|
-
"title": {
|
|
280088
|
-
"type": "string",
|
|
280089
|
-
"maxLength": 64,
|
|
280090
|
-
"description": "Title describing the task"
|
|
280091
|
-
},
|
|
280092
|
-
"description": {
|
|
280093
|
-
"type": "string",
|
|
280094
|
-
"maxLength": 256,
|
|
280095
|
-
"description": "All the notes related to the execution of the current task"
|
|
280096
|
-
},
|
|
280097
|
-
"type": {
|
|
280098
|
-
"type": "string",
|
|
280099
|
-
"description": "Type of the task"
|
|
280100
|
-
},
|
|
280101
|
-
"data": {
|
|
280102
|
-
"type": "object",
|
|
280103
|
-
"additionalProperties": true,
|
|
280104
|
-
"description": "Content related to the task"
|
|
280105
|
-
},
|
|
280106
|
-
"status": {
|
|
280107
|
-
"type": "string",
|
|
280108
|
-
"enum": [
|
|
280109
|
-
"pending",
|
|
280110
|
-
"in_progress",
|
|
280111
|
-
"failed",
|
|
280112
|
-
"completed",
|
|
280113
|
-
"blocked",
|
|
280114
|
-
"paused",
|
|
280115
|
-
"timeout",
|
|
280116
|
-
"cancelled"
|
|
280117
|
-
],
|
|
280118
|
-
"description": "Status of the task"
|
|
280119
|
-
},
|
|
280120
|
-
"parentTaskId": {
|
|
280121
|
-
"type": "string",
|
|
280122
|
-
"minLength": 28,
|
|
280123
|
-
"maxLength": 36,
|
|
280124
|
-
"description": "Parent task id is the parent task that created this task"
|
|
280125
|
-
},
|
|
280126
|
-
"conversationId": {
|
|
280127
|
-
"type": "string",
|
|
280128
|
-
"minLength": 28,
|
|
280129
|
-
"maxLength": 36,
|
|
280130
|
-
"description": "Conversation id related to this task"
|
|
280131
|
-
},
|
|
280132
|
-
"userId": {
|
|
280133
|
-
"type": "string",
|
|
280134
|
-
"minLength": 28,
|
|
280135
|
-
"maxLength": 36,
|
|
280136
|
-
"description": "Specific user related to this task"
|
|
280137
|
-
},
|
|
280138
|
-
"timeoutAt": {
|
|
280139
|
-
"type": "string",
|
|
280140
|
-
"format": "date-time",
|
|
280141
|
-
"description": "The timeout date where the task should be failed in the ISO 8601 format"
|
|
280142
|
-
},
|
|
280143
|
-
"createdAt": {
|
|
280144
|
-
"type": "string",
|
|
280145
|
-
"format": "date-time",
|
|
280146
|
-
"description": "Creation date of the task in ISO 8601 format"
|
|
280147
|
-
},
|
|
280148
|
-
"updatedAt": {
|
|
280149
|
-
"type": "string",
|
|
280150
|
-
"format": "date-time",
|
|
280151
|
-
"description": "Updating date of the task in ISO 8601 format"
|
|
280152
|
-
},
|
|
280153
|
-
"failureReason": {
|
|
280154
|
-
"type": "string",
|
|
280155
|
-
"maxLength": 2e3,
|
|
280156
|
-
"description": "If the task fails this is the reason behind it"
|
|
280157
|
-
},
|
|
280158
|
-
"tags": {
|
|
280159
|
-
"type": "object",
|
|
280160
|
-
"additionalProperties": {
|
|
280161
|
-
"type": "string"
|
|
280162
|
-
},
|
|
280163
|
-
"description": "Set of [Tags](/docs/developers/concepts/tags) that you can attach to a [Task](#schema_task). Individual keys can be unset by posting an empty value to them."
|
|
280164
|
-
}
|
|
280165
|
-
},
|
|
280166
|
-
"required": [
|
|
280167
|
-
"id",
|
|
280168
|
-
"title",
|
|
280169
|
-
"description",
|
|
280170
|
-
"type",
|
|
280171
|
-
"data",
|
|
280172
|
-
"status",
|
|
280173
|
-
"timeoutAt",
|
|
280174
|
-
"createdAt",
|
|
280175
|
-
"updatedAt",
|
|
280176
|
-
"tags"
|
|
280177
|
-
],
|
|
280178
|
-
"description": "Task definition",
|
|
280179
|
-
"additionalProperties": false
|
|
280180
|
-
}
|
|
280181
|
-
},
|
|
280182
279672
|
"Workflow": {
|
|
280183
279673
|
"section": "workflow",
|
|
280184
279674
|
"schema": {
|
|
@@ -280374,19 +279864,6 @@ var state = {
|
|
|
280374
279864
|
"callAction"
|
|
280375
279865
|
]
|
|
280376
279866
|
},
|
|
280377
|
-
{
|
|
280378
|
-
"description": "",
|
|
280379
|
-
"title": "Task",
|
|
280380
|
-
"name": "task",
|
|
280381
|
-
"operations": [
|
|
280382
|
-
"getTask",
|
|
280383
|
-
"createTask",
|
|
280384
|
-
"updateTask",
|
|
280385
|
-
"deleteTask",
|
|
280386
|
-
"listTasks"
|
|
280387
|
-
],
|
|
280388
|
-
"schema": "Task"
|
|
280389
|
-
},
|
|
280390
279867
|
{
|
|
280391
279868
|
"description": "",
|
|
280392
279869
|
"title": "Workflow",
|
|
@@ -282994,10 +282471,9 @@ var state2 = {
|
|
|
282994
282471
|
"enum": [
|
|
282995
282472
|
"conversation",
|
|
282996
282473
|
"user",
|
|
282997
|
-
"bot"
|
|
282998
|
-
"task"
|
|
282474
|
+
"bot"
|
|
282999
282475
|
],
|
|
283000
|
-
"description": "Type of the [State](#schema_state) (`conversation`, `user
|
|
282476
|
+
"description": "Type of the [State](#schema_state) (`conversation`, `user` or `bot`)"
|
|
283001
282477
|
},
|
|
283002
282478
|
"schema": {
|
|
283003
282479
|
"type": "object",
|
|
@@ -283427,10 +282903,9 @@ var state2 = {
|
|
|
283427
282903
|
"enum": [
|
|
283428
282904
|
"conversation",
|
|
283429
282905
|
"user",
|
|
283430
|
-
"bot"
|
|
283431
|
-
"task"
|
|
282906
|
+
"bot"
|
|
283432
282907
|
],
|
|
283433
|
-
"description": "Type of the [State](#schema_state) (`conversation`, `user
|
|
282908
|
+
"description": "Type of the [State](#schema_state) (`conversation`, `user` or `bot`)"
|
|
283434
282909
|
},
|
|
283435
282910
|
"schema": {
|
|
283436
282911
|
"type": "object",
|
|
@@ -283851,10 +283326,9 @@ var state2 = {
|
|
|
283851
283326
|
"enum": [
|
|
283852
283327
|
"conversation",
|
|
283853
283328
|
"user",
|
|
283854
|
-
"bot"
|
|
283855
|
-
"task"
|
|
283329
|
+
"bot"
|
|
283856
283330
|
],
|
|
283857
|
-
"description": "Type of the [State](#schema_state) (`conversation`, `user
|
|
283331
|
+
"description": "Type of the [State](#schema_state) (`conversation`, `user` or `bot`)"
|
|
283858
283332
|
},
|
|
283859
283333
|
"schema": {
|
|
283860
283334
|
"type": "object",
|
|
@@ -284977,10 +284451,9 @@ var state2 = {
|
|
|
284977
284451
|
"enum": [
|
|
284978
284452
|
"conversation",
|
|
284979
284453
|
"user",
|
|
284980
|
-
"bot"
|
|
284981
|
-
"task"
|
|
284454
|
+
"bot"
|
|
284982
284455
|
],
|
|
284983
|
-
"description": "Type of the [State](#schema_state) (`conversation`, `user
|
|
284456
|
+
"description": "Type of the [State](#schema_state) (`conversation`, `user` or `bot`)"
|
|
284984
284457
|
},
|
|
284985
284458
|
"schema": {
|
|
284986
284459
|
"type": "object",
|
|
@@ -285608,10 +285081,9 @@ var state2 = {
|
|
|
285608
285081
|
"enum": [
|
|
285609
285082
|
"conversation",
|
|
285610
285083
|
"user",
|
|
285611
|
-
"bot"
|
|
285612
|
-
"task"
|
|
285084
|
+
"bot"
|
|
285613
285085
|
],
|
|
285614
|
-
"description": "Type of the [State](#schema_state) (`conversation`, `user
|
|
285086
|
+
"description": "Type of the [State](#schema_state) (`conversation`, `user` or `bot`)"
|
|
285615
285087
|
},
|
|
285616
285088
|
"schema": {
|
|
285617
285089
|
"type": "object",
|
|
@@ -294346,10 +293818,9 @@ var state2 = {
|
|
|
294346
293818
|
"enum": [
|
|
294347
293819
|
"conversation",
|
|
294348
293820
|
"user",
|
|
294349
|
-
"bot"
|
|
294350
|
-
"task"
|
|
293821
|
+
"bot"
|
|
294351
293822
|
],
|
|
294352
|
-
"description": "Type of the [State](#schema_state) (`conversation`, `user
|
|
293823
|
+
"description": "Type of the [State](#schema_state) (`conversation`, `user` or `bot`)"
|
|
294353
293824
|
},
|
|
294354
293825
|
"schema": {
|
|
294355
293826
|
"type": "object",
|
|
@@ -294879,10 +294350,9 @@ var state2 = {
|
|
|
294879
294350
|
"enum": [
|
|
294880
294351
|
"conversation",
|
|
294881
294352
|
"user",
|
|
294882
|
-
"bot"
|
|
294883
|
-
"task"
|
|
294353
|
+
"bot"
|
|
294884
294354
|
],
|
|
294885
|
-
"description": "Type of the [State](#schema_state) (`conversation`, `user
|
|
294355
|
+
"description": "Type of the [State](#schema_state) (`conversation`, `user` or `bot`)"
|
|
294886
294356
|
},
|
|
294887
294357
|
"schema": {
|
|
294888
294358
|
"type": "object",
|
|
@@ -296049,7 +295519,7 @@ var state2 = {
|
|
|
296049
295519
|
"title": "Botpress Admin API",
|
|
296050
295520
|
"description": "API for Botpress Cloud Manager",
|
|
296051
295521
|
"server": "https://api.botpress.cloud",
|
|
296052
|
-
"version": "1.73.
|
|
295522
|
+
"version": "1.73.4",
|
|
296053
295523
|
"prefix": "v1"
|
|
296054
295524
|
},
|
|
296055
295525
|
"defaultParameters": {
|
|
@@ -296804,10 +296274,9 @@ var state2 = {
|
|
|
296804
296274
|
"enum": [
|
|
296805
296275
|
"conversation",
|
|
296806
296276
|
"user",
|
|
296807
|
-
"bot"
|
|
296808
|
-
"task"
|
|
296277
|
+
"bot"
|
|
296809
296278
|
],
|
|
296810
|
-
"description": "Type of the [State](#schema_state) (`conversation`, `user
|
|
296279
|
+
"description": "Type of the [State](#schema_state) (`conversation`, `user` or `bot`)"
|
|
296811
296280
|
},
|
|
296812
296281
|
"schema": {
|
|
296813
296282
|
"type": "object",
|
|
@@ -298138,10 +297607,9 @@ var state2 = {
|
|
|
298138
297607
|
"enum": [
|
|
298139
297608
|
"conversation",
|
|
298140
297609
|
"user",
|
|
298141
|
-
"bot"
|
|
298142
|
-
"task"
|
|
297610
|
+
"bot"
|
|
298143
297611
|
],
|
|
298144
|
-
"description": "Type of the [State](#schema_state) (`conversation`, `user
|
|
297612
|
+
"description": "Type of the [State](#schema_state) (`conversation`, `user` or `bot`)"
|
|
298145
297613
|
},
|
|
298146
297614
|
"schema": {
|
|
298147
297615
|
"type": "object",
|
|
@@ -301570,7 +301038,7 @@ var state3 = {
|
|
|
301570
301038
|
"title": "Botpress Files API",
|
|
301571
301039
|
"description": "API for Botpress Files",
|
|
301572
301040
|
"server": "https://api.botpress.cloud",
|
|
301573
|
-
"version": "1.73.
|
|
301041
|
+
"version": "1.73.4",
|
|
301574
301042
|
"prefix": "v1"
|
|
301575
301043
|
},
|
|
301576
301044
|
"defaultParameters": {
|
|
@@ -303866,7 +303334,7 @@ var state4 = {
|
|
|
303866
303334
|
"title": "Botpress Tables API",
|
|
303867
303335
|
"description": "API for Botpress Tables",
|
|
303868
303336
|
"server": "https://api.botpress.cloud",
|
|
303869
|
-
"version": "1.73.
|
|
303337
|
+
"version": "1.73.4",
|
|
303870
303338
|
"prefix": "v1"
|
|
303871
303339
|
},
|
|
303872
303340
|
"defaultParameters": {
|
|
@@ -304831,7 +304299,9 @@ var state5 = {
|
|
|
304831
304299
|
"type": "object",
|
|
304832
304300
|
"properties": {
|
|
304833
304301
|
"currentTaskId": {
|
|
304834
|
-
"type": "string"
|
|
304302
|
+
"type": "string",
|
|
304303
|
+
"deprecated": true,
|
|
304304
|
+
"description": "Unused. This parameter will be ignored if provided and should not be used when updating a conversation."
|
|
304835
304305
|
},
|
|
304836
304306
|
"tags": {
|
|
304837
304307
|
"type": "object",
|
|
@@ -306376,7 +305846,6 @@ var state5 = {
|
|
|
306376
305846
|
"user",
|
|
306377
305847
|
"bot",
|
|
306378
305848
|
"integration",
|
|
306379
|
-
"task",
|
|
306380
305849
|
"workflow"
|
|
306381
305850
|
]
|
|
306382
305851
|
},
|
|
@@ -306447,7 +305916,6 @@ var state5 = {
|
|
|
306447
305916
|
"user",
|
|
306448
305917
|
"bot",
|
|
306449
305918
|
"integration",
|
|
306450
|
-
"task",
|
|
306451
305919
|
"workflow"
|
|
306452
305920
|
]
|
|
306453
305921
|
},
|
|
@@ -306511,7 +305979,6 @@ var state5 = {
|
|
|
306511
305979
|
"user",
|
|
306512
305980
|
"bot",
|
|
306513
305981
|
"integration",
|
|
306514
|
-
"task",
|
|
306515
305982
|
"workflow"
|
|
306516
305983
|
]
|
|
306517
305984
|
},
|
|
@@ -306588,7 +306055,6 @@ var state5 = {
|
|
|
306588
306055
|
"user",
|
|
306589
306056
|
"bot",
|
|
306590
306057
|
"integration",
|
|
306591
|
-
"task",
|
|
306592
306058
|
"workflow"
|
|
306593
306059
|
]
|
|
306594
306060
|
},
|
|
@@ -306677,7 +306143,6 @@ var state5 = {
|
|
|
306677
306143
|
"user",
|
|
306678
306144
|
"bot",
|
|
306679
306145
|
"integration",
|
|
306680
|
-
"task",
|
|
306681
306146
|
"workflow"
|
|
306682
306147
|
]
|
|
306683
306148
|
},
|
|
@@ -306851,312 +306316,6 @@ var state5 = {
|
|
|
306851
306316
|
],
|
|
306852
306317
|
"parameters": {}
|
|
306853
306318
|
},
|
|
306854
|
-
"getTask": {
|
|
306855
|
-
"name": "getTask",
|
|
306856
|
-
"description": "Retrieves the [Task](#schema_task) object for a valid identifier.",
|
|
306857
|
-
"method": "get",
|
|
306858
|
-
"path": "/v1/chat/tasks/{id}",
|
|
306859
|
-
"parameters": {
|
|
306860
|
-
"id": {
|
|
306861
|
-
"in": "path",
|
|
306862
|
-
"type": "string",
|
|
306863
|
-
"description": "Task id"
|
|
306864
|
-
}
|
|
306865
|
-
},
|
|
306866
|
-
"section": "task",
|
|
306867
|
-
"response": {
|
|
306868
|
-
"description": "Returns a [Task](#schema_task) object if a valid identifier was provided. Returns an [Error](#errors) otherwise",
|
|
306869
|
-
"schema": {
|
|
306870
|
-
"type": "object",
|
|
306871
|
-
"properties": {
|
|
306872
|
-
"task": {
|
|
306873
|
-
"$ref": "#/components/schemas/Task"
|
|
306874
|
-
}
|
|
306875
|
-
},
|
|
306876
|
-
"required": [
|
|
306877
|
-
"task"
|
|
306878
|
-
],
|
|
306879
|
-
"title": "getTaskResponse",
|
|
306880
|
-
"additionalProperties": false
|
|
306881
|
-
}
|
|
306882
|
-
}
|
|
306883
|
-
},
|
|
306884
|
-
"createTask": {
|
|
306885
|
-
"name": "createTask",
|
|
306886
|
-
"description": "Creates a new [Task](#schema_task). When creating a new [Task](#schema_task), the required tags must be provided. See the specific integration for more details.",
|
|
306887
|
-
"method": "post",
|
|
306888
|
-
"path": "/v1/chat/tasks",
|
|
306889
|
-
"requestBody": {
|
|
306890
|
-
"description": "Task data",
|
|
306891
|
-
"schema": {
|
|
306892
|
-
"type": "object",
|
|
306893
|
-
"properties": {
|
|
306894
|
-
"title": {
|
|
306895
|
-
"type": "string",
|
|
306896
|
-
"maxLength": 2e3,
|
|
306897
|
-
"description": "Title describing the task"
|
|
306898
|
-
},
|
|
306899
|
-
"description": {
|
|
306900
|
-
"type": "string",
|
|
306901
|
-
"maxLength": 2e4,
|
|
306902
|
-
"description": "All the notes related to the execution of the current task"
|
|
306903
|
-
},
|
|
306904
|
-
"type": {
|
|
306905
|
-
"type": "string",
|
|
306906
|
-
"maxLength": 200,
|
|
306907
|
-
"description": "Type of the task"
|
|
306908
|
-
},
|
|
306909
|
-
"data": {
|
|
306910
|
-
"type": "object",
|
|
306911
|
-
"additionalProperties": true,
|
|
306912
|
-
"description": "Content related to the task"
|
|
306913
|
-
},
|
|
306914
|
-
"parentTaskId": {
|
|
306915
|
-
"type": "string",
|
|
306916
|
-
"description": "Parent task id is the parent task that created this task"
|
|
306917
|
-
},
|
|
306918
|
-
"conversationId": {
|
|
306919
|
-
"type": "string",
|
|
306920
|
-
"description": "Conversation id related to this task"
|
|
306921
|
-
},
|
|
306922
|
-
"userId": {
|
|
306923
|
-
"type": "string",
|
|
306924
|
-
"description": "Specific user related to this task"
|
|
306925
|
-
},
|
|
306926
|
-
"timeoutAt": {
|
|
306927
|
-
"type": "string",
|
|
306928
|
-
"format": "date-time",
|
|
306929
|
-
"description": "The timeout date where the task should be failed in the ISO 8601 format"
|
|
306930
|
-
},
|
|
306931
|
-
"tags": {
|
|
306932
|
-
"type": "object",
|
|
306933
|
-
"additionalProperties": {
|
|
306934
|
-
"type": "string",
|
|
306935
|
-
"maxLength": 500
|
|
306936
|
-
},
|
|
306937
|
-
"description": "Tags for the [Task](#schema_task)"
|
|
306938
|
-
}
|
|
306939
|
-
},
|
|
306940
|
-
"required": [
|
|
306941
|
-
"type",
|
|
306942
|
-
"conversationId"
|
|
306943
|
-
],
|
|
306944
|
-
"title": "createTaskBody",
|
|
306945
|
-
"additionalProperties": false
|
|
306946
|
-
}
|
|
306947
|
-
},
|
|
306948
|
-
"section": "task",
|
|
306949
|
-
"response": {
|
|
306950
|
-
"description": "Returns a [Task](#schema_task) object if creation succeeds. Returns an [Error](#errors) otherwise",
|
|
306951
|
-
"status": 201,
|
|
306952
|
-
"schema": {
|
|
306953
|
-
"type": "object",
|
|
306954
|
-
"properties": {
|
|
306955
|
-
"task": {
|
|
306956
|
-
"$ref": "#/components/schemas/Task"
|
|
306957
|
-
}
|
|
306958
|
-
},
|
|
306959
|
-
"required": [
|
|
306960
|
-
"task"
|
|
306961
|
-
],
|
|
306962
|
-
"title": "createTaskResponse",
|
|
306963
|
-
"additionalProperties": false
|
|
306964
|
-
}
|
|
306965
|
-
},
|
|
306966
|
-
"parameters": {}
|
|
306967
|
-
},
|
|
306968
|
-
"updateTask": {
|
|
306969
|
-
"name": "updateTask",
|
|
306970
|
-
"description": "Update a [Task](#schema_task) object by setting the values of the parameters passed. Any parameters not provided will be left unchanged.",
|
|
306971
|
-
"method": "put",
|
|
306972
|
-
"path": "/v1/chat/tasks/{id}",
|
|
306973
|
-
"parameters": {
|
|
306974
|
-
"id": {
|
|
306975
|
-
"in": "path",
|
|
306976
|
-
"type": "string",
|
|
306977
|
-
"description": "Task id"
|
|
306978
|
-
}
|
|
306979
|
-
},
|
|
306980
|
-
"requestBody": {
|
|
306981
|
-
"description": "Task data",
|
|
306982
|
-
"schema": {
|
|
306983
|
-
"type": "object",
|
|
306984
|
-
"properties": {
|
|
306985
|
-
"title": {
|
|
306986
|
-
"type": "string",
|
|
306987
|
-
"description": "Title describing the task"
|
|
306988
|
-
},
|
|
306989
|
-
"description": {
|
|
306990
|
-
"type": "string",
|
|
306991
|
-
"description": "All the notes related to the execution of the current task"
|
|
306992
|
-
},
|
|
306993
|
-
"data": {
|
|
306994
|
-
"type": "object",
|
|
306995
|
-
"additionalProperties": true,
|
|
306996
|
-
"description": "Content related to the task"
|
|
306997
|
-
},
|
|
306998
|
-
"timeoutAt": {
|
|
306999
|
-
"type": "string",
|
|
307000
|
-
"format": "date-time",
|
|
307001
|
-
"description": "The timeout date where the task should be failed in the ISO 8601 format"
|
|
307002
|
-
},
|
|
307003
|
-
"status": {
|
|
307004
|
-
"type": "string",
|
|
307005
|
-
"enum": [
|
|
307006
|
-
"pending",
|
|
307007
|
-
"in_progress",
|
|
307008
|
-
"failed",
|
|
307009
|
-
"completed",
|
|
307010
|
-
"blocked",
|
|
307011
|
-
"paused",
|
|
307012
|
-
"timeout",
|
|
307013
|
-
"cancelled"
|
|
307014
|
-
],
|
|
307015
|
-
"description": "Status of the task"
|
|
307016
|
-
},
|
|
307017
|
-
"tags": {
|
|
307018
|
-
"type": "object",
|
|
307019
|
-
"additionalProperties": {
|
|
307020
|
-
"type": "string",
|
|
307021
|
-
"maxLength": 500
|
|
307022
|
-
},
|
|
307023
|
-
"description": "Tags for the [Task](#schema_task)"
|
|
307024
|
-
}
|
|
307025
|
-
},
|
|
307026
|
-
"title": "updateTaskBody",
|
|
307027
|
-
"additionalProperties": false
|
|
307028
|
-
}
|
|
307029
|
-
},
|
|
307030
|
-
"section": "task",
|
|
307031
|
-
"response": {
|
|
307032
|
-
"description": "Returns an updated [Task](#schema_task) object if a valid identifier was provided. Returns an [Error](#errors) otherwise",
|
|
307033
|
-
"schema": {
|
|
307034
|
-
"type": "object",
|
|
307035
|
-
"properties": {
|
|
307036
|
-
"task": {
|
|
307037
|
-
"$ref": "#/components/schemas/Task"
|
|
307038
|
-
}
|
|
307039
|
-
},
|
|
307040
|
-
"required": [
|
|
307041
|
-
"task"
|
|
307042
|
-
],
|
|
307043
|
-
"title": "updateTaskResponse",
|
|
307044
|
-
"additionalProperties": false
|
|
307045
|
-
}
|
|
307046
|
-
}
|
|
307047
|
-
},
|
|
307048
|
-
"deleteTask": {
|
|
307049
|
-
"name": "deleteTask",
|
|
307050
|
-
"description": "Permanently deletes a [Task](#schema_task). It cannot be undone.",
|
|
307051
|
-
"method": "delete",
|
|
307052
|
-
"path": "/v1/chat/tasks/{id}",
|
|
307053
|
-
"parameters": {
|
|
307054
|
-
"id": {
|
|
307055
|
-
"in": "path",
|
|
307056
|
-
"type": "string",
|
|
307057
|
-
"description": "Task id"
|
|
307058
|
-
}
|
|
307059
|
-
},
|
|
307060
|
-
"section": "task",
|
|
307061
|
-
"response": {
|
|
307062
|
-
"description": "Returns the [Task](#schema_task) object that was deleted",
|
|
307063
|
-
"schema": {
|
|
307064
|
-
"type": "object",
|
|
307065
|
-
"title": "deleteTaskResponse",
|
|
307066
|
-
"additionalProperties": false
|
|
307067
|
-
}
|
|
307068
|
-
}
|
|
307069
|
-
},
|
|
307070
|
-
"listTasks": {
|
|
307071
|
-
"name": "listTasks",
|
|
307072
|
-
"description": "Retrieves a list of [Task](#schema_task) you've previously created. The tasks are returned in sorted order, with the most recent appearing first. The list can be filtered using [Tags](/docs/developers/concepts/tags).",
|
|
307073
|
-
"method": "get",
|
|
307074
|
-
"path": "/v1/chat/tasks",
|
|
307075
|
-
"parameters": {
|
|
307076
|
-
"nextToken": {
|
|
307077
|
-
"in": "query",
|
|
307078
|
-
"description": "Provide the `meta.nextToken` value provided in the last API response to retrieve the next page of results",
|
|
307079
|
-
"type": "string"
|
|
307080
|
-
},
|
|
307081
|
-
"tags": {
|
|
307082
|
-
"in": "query",
|
|
307083
|
-
"type": "object",
|
|
307084
|
-
"schema": {
|
|
307085
|
-
"type": "object",
|
|
307086
|
-
"additionalProperties": {
|
|
307087
|
-
"type": "string"
|
|
307088
|
-
}
|
|
307089
|
-
},
|
|
307090
|
-
"description": "Filter by tags"
|
|
307091
|
-
},
|
|
307092
|
-
"conversationId": {
|
|
307093
|
-
"in": "query",
|
|
307094
|
-
"type": "string",
|
|
307095
|
-
"description": "Conversation id"
|
|
307096
|
-
},
|
|
307097
|
-
"userId": {
|
|
307098
|
-
"in": "query",
|
|
307099
|
-
"type": "string",
|
|
307100
|
-
"description": "User id"
|
|
307101
|
-
},
|
|
307102
|
-
"parentTaskId": {
|
|
307103
|
-
"in": "query",
|
|
307104
|
-
"type": "string",
|
|
307105
|
-
"description": "Parent task id"
|
|
307106
|
-
},
|
|
307107
|
-
"status": {
|
|
307108
|
-
"in": "query",
|
|
307109
|
-
"type": "string[]",
|
|
307110
|
-
"description": "Status",
|
|
307111
|
-
"enum": [
|
|
307112
|
-
"pending",
|
|
307113
|
-
"in_progress",
|
|
307114
|
-
"failed",
|
|
307115
|
-
"completed",
|
|
307116
|
-
"blocked",
|
|
307117
|
-
"paused",
|
|
307118
|
-
"timeout",
|
|
307119
|
-
"cancelled"
|
|
307120
|
-
]
|
|
307121
|
-
},
|
|
307122
|
-
"type": {
|
|
307123
|
-
"in": "query",
|
|
307124
|
-
"type": "string",
|
|
307125
|
-
"description": "Type"
|
|
307126
|
-
}
|
|
307127
|
-
},
|
|
307128
|
-
"section": "task",
|
|
307129
|
-
"response": {
|
|
307130
|
-
"description": "Returns a list of [Task](#schema_task) objects",
|
|
307131
|
-
"schema": {
|
|
307132
|
-
"type": "object",
|
|
307133
|
-
"properties": {
|
|
307134
|
-
"tasks": {
|
|
307135
|
-
"type": "array",
|
|
307136
|
-
"items": {
|
|
307137
|
-
"$ref": "#/components/schemas/Task"
|
|
307138
|
-
}
|
|
307139
|
-
},
|
|
307140
|
-
"meta": {
|
|
307141
|
-
"type": "object",
|
|
307142
|
-
"properties": {
|
|
307143
|
-
"nextToken": {
|
|
307144
|
-
"type": "string",
|
|
307145
|
-
"description": "The token to use to retrieve the next page of results, passed as a query string parameter (value should be URL-encoded) to this API endpoint."
|
|
307146
|
-
}
|
|
307147
|
-
},
|
|
307148
|
-
"additionalProperties": false
|
|
307149
|
-
}
|
|
307150
|
-
},
|
|
307151
|
-
"required": [
|
|
307152
|
-
"tasks",
|
|
307153
|
-
"meta"
|
|
307154
|
-
],
|
|
307155
|
-
"title": "listTasksResponse",
|
|
307156
|
-
"additionalProperties": false
|
|
307157
|
-
}
|
|
307158
|
-
}
|
|
307159
|
-
},
|
|
307160
306319
|
"createWorkflow": {
|
|
307161
306320
|
"name": "createWorkflow",
|
|
307162
306321
|
"description": "Creates a new [Workflow](#schema_workflow).",
|
|
@@ -307687,6 +306846,10 @@ var state5 = {
|
|
|
307687
306846
|
"schema": {
|
|
307688
306847
|
"type": "object",
|
|
307689
306848
|
"properties": {
|
|
306849
|
+
"id": {
|
|
306850
|
+
"type": "string",
|
|
306851
|
+
"description": "Caller-defined identifier for the observation (e.g. llmz context ID). Uniqueness is not enforced nor guaranteed."
|
|
306852
|
+
},
|
|
307690
306853
|
"name": {
|
|
307691
306854
|
"type": "string",
|
|
307692
306855
|
"description": "Name of the observation"
|
|
@@ -310213,10 +309376,9 @@ var state5 = {
|
|
|
310213
309376
|
"enum": [
|
|
310214
309377
|
"conversation",
|
|
310215
309378
|
"user",
|
|
310216
|
-
"bot"
|
|
310217
|
-
"task"
|
|
309379
|
+
"bot"
|
|
310218
309380
|
],
|
|
310219
|
-
"description": "Type of the [State](#schema_state) (`conversation`, `user
|
|
309381
|
+
"description": "Type of the [State](#schema_state) (`conversation`, `user` or `bot`)"
|
|
310220
309382
|
},
|
|
310221
309383
|
"schema": {
|
|
310222
309384
|
"type": "object",
|
|
@@ -310640,10 +309802,9 @@ var state5 = {
|
|
|
310640
309802
|
"enum": [
|
|
310641
309803
|
"conversation",
|
|
310642
309804
|
"user",
|
|
310643
|
-
"bot"
|
|
310644
|
-
"task"
|
|
309805
|
+
"bot"
|
|
310645
309806
|
],
|
|
310646
|
-
"description": "Type of the [State](#schema_state) (`conversation`, `user
|
|
309807
|
+
"description": "Type of the [State](#schema_state) (`conversation`, `user` or `bot`)"
|
|
310647
309808
|
},
|
|
310648
309809
|
"schema": {
|
|
310649
309810
|
"type": "object",
|
|
@@ -311058,10 +310219,9 @@ var state5 = {
|
|
|
311058
310219
|
"enum": [
|
|
311059
310220
|
"conversation",
|
|
311060
310221
|
"user",
|
|
311061
|
-
"bot"
|
|
311062
|
-
"task"
|
|
310222
|
+
"bot"
|
|
311063
310223
|
],
|
|
311064
|
-
"description": "Type of the [State](#schema_state) (`conversation`, `user
|
|
310224
|
+
"description": "Type of the [State](#schema_state) (`conversation`, `user` or `bot`)"
|
|
311065
310225
|
},
|
|
311066
310226
|
"schema": {
|
|
311067
310227
|
"type": "object",
|
|
@@ -312160,10 +311320,9 @@ var state5 = {
|
|
|
312160
311320
|
"enum": [
|
|
312161
311321
|
"conversation",
|
|
312162
311322
|
"user",
|
|
312163
|
-
"bot"
|
|
312164
|
-
"task"
|
|
311323
|
+
"bot"
|
|
312165
311324
|
],
|
|
312166
|
-
"description": "Type of the [State](#schema_state) (`conversation`, `user
|
|
311325
|
+
"description": "Type of the [State](#schema_state) (`conversation`, `user` or `bot`)"
|
|
312167
311326
|
},
|
|
312168
311327
|
"schema": {
|
|
312169
311328
|
"type": "object",
|
|
@@ -312766,10 +311925,9 @@ var state5 = {
|
|
|
312766
311925
|
"enum": [
|
|
312767
311926
|
"conversation",
|
|
312768
311927
|
"user",
|
|
312769
|
-
"bot"
|
|
312770
|
-
"task"
|
|
311928
|
+
"bot"
|
|
312771
311929
|
],
|
|
312772
|
-
"description": "Type of the [State](#schema_state) (`conversation`, `user
|
|
311930
|
+
"description": "Type of the [State](#schema_state) (`conversation`, `user` or `bot`)"
|
|
312773
311931
|
},
|
|
312774
311932
|
"schema": {
|
|
312775
311933
|
"type": "object",
|
|
@@ -320731,10 +319889,9 @@ var state5 = {
|
|
|
320731
319889
|
"enum": [
|
|
320732
319890
|
"conversation",
|
|
320733
319891
|
"user",
|
|
320734
|
-
"bot"
|
|
320735
|
-
"task"
|
|
319892
|
+
"bot"
|
|
320736
319893
|
],
|
|
320737
|
-
"description": "Type of the [State](#schema_state) (`conversation`, `user
|
|
319894
|
+
"description": "Type of the [State](#schema_state) (`conversation`, `user` or `bot`)"
|
|
320738
319895
|
},
|
|
320739
319896
|
"schema": {
|
|
320740
319897
|
"type": "object",
|
|
@@ -321216,10 +320373,9 @@ var state5 = {
|
|
|
321216
320373
|
"enum": [
|
|
321217
320374
|
"conversation",
|
|
321218
320375
|
"user",
|
|
321219
|
-
"bot"
|
|
321220
|
-
"task"
|
|
320376
|
+
"bot"
|
|
321221
320377
|
],
|
|
321222
|
-
"description": "Type of the [State](#schema_state) (`conversation`, `user
|
|
320378
|
+
"description": "Type of the [State](#schema_state) (`conversation`, `user` or `bot`)"
|
|
321223
320379
|
},
|
|
321224
320380
|
"schema": {
|
|
321225
320381
|
"type": "object",
|
|
@@ -325486,7 +324642,7 @@ var state5 = {
|
|
|
325486
324642
|
"title": "Botpress API",
|
|
325487
324643
|
"description": "API for Botpress Cloud",
|
|
325488
324644
|
"server": "https://api.botpress.cloud",
|
|
325489
|
-
"version": "1.73.
|
|
324645
|
+
"version": "1.73.4",
|
|
325490
324646
|
"prefix": "v1"
|
|
325491
324647
|
},
|
|
325492
324648
|
"errors": [
|
|
@@ -325643,8 +324799,6 @@ var state5 = {
|
|
|
325643
324799
|
"patchStateBody": true,
|
|
325644
324800
|
"callActionBody": true,
|
|
325645
324801
|
"configureIntegrationBody": true,
|
|
325646
|
-
"createTaskBody": true,
|
|
325647
|
-
"updateTaskBody": true,
|
|
325648
324802
|
"createWorkflowBody": true,
|
|
325649
324803
|
"updateWorkflowBody": true,
|
|
325650
324804
|
"getOrCreateWorkflowBody": true,
|
|
@@ -325739,11 +324893,6 @@ var state5 = {
|
|
|
325739
324893
|
"patchStateResponse": true,
|
|
325740
324894
|
"callActionResponse": true,
|
|
325741
324895
|
"configureIntegrationResponse": true,
|
|
325742
|
-
"getTaskResponse": true,
|
|
325743
|
-
"createTaskResponse": true,
|
|
325744
|
-
"updateTaskResponse": true,
|
|
325745
|
-
"deleteTaskResponse": true,
|
|
325746
|
-
"listTasksResponse": true,
|
|
325747
324896
|
"createWorkflowResponse": true,
|
|
325748
324897
|
"getWorkflowResponse": true,
|
|
325749
324898
|
"updateWorkflowResponse": true,
|
|
@@ -325914,7 +325063,6 @@ var state5 = {
|
|
|
325914
325063
|
"Event": true,
|
|
325915
325064
|
"Message": true,
|
|
325916
325065
|
"State": true,
|
|
325917
|
-
"Task": true,
|
|
325918
325066
|
"Workflow": true,
|
|
325919
325067
|
"Table": true,
|
|
325920
325068
|
"Column": true,
|
|
@@ -326362,10 +325510,9 @@ var state5 = {
|
|
|
326362
325510
|
"enum": [
|
|
326363
325511
|
"conversation",
|
|
326364
325512
|
"user",
|
|
326365
|
-
"bot"
|
|
326366
|
-
"task"
|
|
325513
|
+
"bot"
|
|
326367
325514
|
],
|
|
326368
|
-
"description": "Type of the [State](#schema_state) (`conversation`, `user
|
|
325515
|
+
"description": "Type of the [State](#schema_state) (`conversation`, `user` or `bot`)"
|
|
326369
325516
|
},
|
|
326370
325517
|
"schema": {
|
|
326371
325518
|
"type": "object",
|
|
@@ -327696,10 +326843,9 @@ var state5 = {
|
|
|
327696
326843
|
"enum": [
|
|
327697
326844
|
"conversation",
|
|
327698
326845
|
"user",
|
|
327699
|
-
"bot"
|
|
327700
|
-
"task"
|
|
326846
|
+
"bot"
|
|
327701
326847
|
],
|
|
327702
|
-
"description": "Type of the [State](#schema_state) (`conversation`, `user
|
|
326848
|
+
"description": "Type of the [State](#schema_state) (`conversation`, `user` or `bot`)"
|
|
327703
326849
|
},
|
|
327704
326850
|
"schema": {
|
|
327705
326851
|
"type": "object",
|
|
@@ -328508,7 +327654,8 @@ var state5 = {
|
|
|
328508
327654
|
"type": "string",
|
|
328509
327655
|
"minLength": 28,
|
|
328510
327656
|
"maxLength": 36,
|
|
328511
|
-
"
|
|
327657
|
+
"deprecated": true,
|
|
327658
|
+
"description": "Unused. This field will be removed in the future."
|
|
328512
327659
|
},
|
|
328513
327660
|
"currentWorkflowId": {
|
|
328514
327661
|
"type": "string",
|
|
@@ -328759,11 +327906,10 @@ var state5 = {
|
|
|
328759
327906
|
"conversation",
|
|
328760
327907
|
"user",
|
|
328761
327908
|
"bot",
|
|
328762
|
-
"task",
|
|
328763
327909
|
"integration",
|
|
328764
327910
|
"workflow"
|
|
328765
327911
|
],
|
|
328766
|
-
"description": "Type of the [State](#schema_state) represents the resource type (`conversation`, `user`, `bot`, `
|
|
327912
|
+
"description": "Type of the [State](#schema_state) represents the resource type (`conversation`, `user`, `bot`, `integration` or `workflow`) that the state is related to"
|
|
328767
327913
|
},
|
|
328768
327914
|
"payload": {
|
|
328769
327915
|
"type": "object",
|
|
@@ -328784,112 +327930,6 @@ var state5 = {
|
|
|
328784
327930
|
"additionalProperties": false
|
|
328785
327931
|
}
|
|
328786
327932
|
},
|
|
328787
|
-
"Task": {
|
|
328788
|
-
"section": "task",
|
|
328789
|
-
"schema": {
|
|
328790
|
-
"type": "object",
|
|
328791
|
-
"properties": {
|
|
328792
|
-
"id": {
|
|
328793
|
-
"type": "string",
|
|
328794
|
-
"minLength": 28,
|
|
328795
|
-
"maxLength": 36,
|
|
328796
|
-
"description": "Id of the [Task](#schema_task)"
|
|
328797
|
-
},
|
|
328798
|
-
"title": {
|
|
328799
|
-
"type": "string",
|
|
328800
|
-
"maxLength": 64,
|
|
328801
|
-
"description": "Title describing the task"
|
|
328802
|
-
},
|
|
328803
|
-
"description": {
|
|
328804
|
-
"type": "string",
|
|
328805
|
-
"maxLength": 256,
|
|
328806
|
-
"description": "All the notes related to the execution of the current task"
|
|
328807
|
-
},
|
|
328808
|
-
"type": {
|
|
328809
|
-
"type": "string",
|
|
328810
|
-
"description": "Type of the task"
|
|
328811
|
-
},
|
|
328812
|
-
"data": {
|
|
328813
|
-
"type": "object",
|
|
328814
|
-
"additionalProperties": true,
|
|
328815
|
-
"description": "Content related to the task"
|
|
328816
|
-
},
|
|
328817
|
-
"status": {
|
|
328818
|
-
"type": "string",
|
|
328819
|
-
"enum": [
|
|
328820
|
-
"pending",
|
|
328821
|
-
"in_progress",
|
|
328822
|
-
"failed",
|
|
328823
|
-
"completed",
|
|
328824
|
-
"blocked",
|
|
328825
|
-
"paused",
|
|
328826
|
-
"timeout",
|
|
328827
|
-
"cancelled"
|
|
328828
|
-
],
|
|
328829
|
-
"description": "Status of the task"
|
|
328830
|
-
},
|
|
328831
|
-
"parentTaskId": {
|
|
328832
|
-
"type": "string",
|
|
328833
|
-
"minLength": 28,
|
|
328834
|
-
"maxLength": 36,
|
|
328835
|
-
"description": "Parent task id is the parent task that created this task"
|
|
328836
|
-
},
|
|
328837
|
-
"conversationId": {
|
|
328838
|
-
"type": "string",
|
|
328839
|
-
"minLength": 28,
|
|
328840
|
-
"maxLength": 36,
|
|
328841
|
-
"description": "Conversation id related to this task"
|
|
328842
|
-
},
|
|
328843
|
-
"userId": {
|
|
328844
|
-
"type": "string",
|
|
328845
|
-
"minLength": 28,
|
|
328846
|
-
"maxLength": 36,
|
|
328847
|
-
"description": "Specific user related to this task"
|
|
328848
|
-
},
|
|
328849
|
-
"timeoutAt": {
|
|
328850
|
-
"type": "string",
|
|
328851
|
-
"format": "date-time",
|
|
328852
|
-
"description": "The timeout date where the task should be failed in the ISO 8601 format"
|
|
328853
|
-
},
|
|
328854
|
-
"createdAt": {
|
|
328855
|
-
"type": "string",
|
|
328856
|
-
"format": "date-time",
|
|
328857
|
-
"description": "Creation date of the task in ISO 8601 format"
|
|
328858
|
-
},
|
|
328859
|
-
"updatedAt": {
|
|
328860
|
-
"type": "string",
|
|
328861
|
-
"format": "date-time",
|
|
328862
|
-
"description": "Updating date of the task in ISO 8601 format"
|
|
328863
|
-
},
|
|
328864
|
-
"failureReason": {
|
|
328865
|
-
"type": "string",
|
|
328866
|
-
"maxLength": 2e3,
|
|
328867
|
-
"description": "If the task fails this is the reason behind it"
|
|
328868
|
-
},
|
|
328869
|
-
"tags": {
|
|
328870
|
-
"type": "object",
|
|
328871
|
-
"additionalProperties": {
|
|
328872
|
-
"type": "string"
|
|
328873
|
-
},
|
|
328874
|
-
"description": "Set of [Tags](/docs/developers/concepts/tags) that you can attach to a [Task](#schema_task). Individual keys can be unset by posting an empty value to them."
|
|
328875
|
-
}
|
|
328876
|
-
},
|
|
328877
|
-
"required": [
|
|
328878
|
-
"id",
|
|
328879
|
-
"title",
|
|
328880
|
-
"description",
|
|
328881
|
-
"type",
|
|
328882
|
-
"data",
|
|
328883
|
-
"status",
|
|
328884
|
-
"timeoutAt",
|
|
328885
|
-
"createdAt",
|
|
328886
|
-
"updatedAt",
|
|
328887
|
-
"tags"
|
|
328888
|
-
],
|
|
328889
|
-
"description": "Task definition",
|
|
328890
|
-
"additionalProperties": false
|
|
328891
|
-
}
|
|
328892
|
-
},
|
|
328893
327933
|
"Workflow": {
|
|
328894
327934
|
"section": "workflow",
|
|
328895
327935
|
"schema": {
|
|
@@ -329673,19 +328713,6 @@ var state5 = {
|
|
|
329673
328713
|
"callAction"
|
|
329674
328714
|
]
|
|
329675
328715
|
},
|
|
329676
|
-
{
|
|
329677
|
-
"description": "",
|
|
329678
|
-
"title": "Task",
|
|
329679
|
-
"name": "task",
|
|
329680
|
-
"operations": [
|
|
329681
|
-
"getTask",
|
|
329682
|
-
"createTask",
|
|
329683
|
-
"updateTask",
|
|
329684
|
-
"deleteTask",
|
|
329685
|
-
"listTasks"
|
|
329686
|
-
],
|
|
329687
|
-
"schema": "Task"
|
|
329688
|
-
},
|
|
329689
328716
|
{
|
|
329690
328717
|
"description": "",
|
|
329691
328718
|
"title": "Workflow",
|
|
@@ -332398,7 +331425,7 @@ var state6 = {
|
|
|
332398
331425
|
"title": "Botpress Billing Public API",
|
|
332399
331426
|
"description": "API for Botpress Billing",
|
|
332400
331427
|
"server": "https://api.botpress.cloud",
|
|
332401
|
-
"version": "1.73.
|
|
331428
|
+
"version": "1.73.4",
|
|
332402
331429
|
"prefix": "v2"
|
|
332403
331430
|
},
|
|
332404
331431
|
"defaultParameters": {
|