@botpress/api 0.32.3 → 0.33.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/dist/index.js CHANGED
@@ -269951,6 +269951,193 @@ var state = {
269951
269951
  }
269952
269952
  }
269953
269953
  },
269954
+ "listBotVersions": {
269955
+ "name": "listBotVersions",
269956
+ "description": "List Versions for a Bot",
269957
+ "method": "get",
269958
+ "path": "/v1/admin/bots/{id}/versions",
269959
+ "section": "bot",
269960
+ "parameters": {
269961
+ "id": {
269962
+ "type": "string",
269963
+ "description": "Bot ID",
269964
+ "in": "path"
269965
+ }
269966
+ },
269967
+ "response": {
269968
+ "description": "Success",
269969
+ "schema": {
269970
+ "type": "object",
269971
+ "properties": {
269972
+ "versions": {
269973
+ "type": "array",
269974
+ "items": {
269975
+ "type": "object",
269976
+ "properties": {
269977
+ "id": {
269978
+ "type": "string"
269979
+ },
269980
+ "name": {
269981
+ "type": "string"
269982
+ },
269983
+ "description": {
269984
+ "type": "string"
269985
+ }
269986
+ },
269987
+ "required": [
269988
+ "id",
269989
+ "name"
269990
+ ]
269991
+ }
269992
+ }
269993
+ },
269994
+ "required": [
269995
+ "versions"
269996
+ ],
269997
+ "title": "listBotVersionsResponse",
269998
+ "additionalProperties": false
269999
+ }
270000
+ }
270001
+ },
270002
+ "getBotVersion": {
270003
+ "name": "getBotVersion",
270004
+ "description": "Get a specific version of a bot",
270005
+ "method": "get",
270006
+ "path": "/v1/admin/bots/{id}/versions/{versionId}",
270007
+ "section": "bot",
270008
+ "parameters": {
270009
+ "id": {
270010
+ "type": "string",
270011
+ "description": "Bot ID",
270012
+ "in": "path"
270013
+ },
270014
+ "versionId": {
270015
+ "type": "string",
270016
+ "description": "Version ID",
270017
+ "in": "path"
270018
+ }
270019
+ },
270020
+ "response": {
270021
+ "description": "Success",
270022
+ "schema": {
270023
+ "type": "object",
270024
+ "properties": {
270025
+ "url": {
270026
+ "type": "string",
270027
+ "format": "uri"
270028
+ }
270029
+ },
270030
+ "required": [
270031
+ "url"
270032
+ ],
270033
+ "title": "getBotVersionResponse",
270034
+ "additionalProperties": false
270035
+ }
270036
+ }
270037
+ },
270038
+ "createBotVersion": {
270039
+ "name": "createBotVersion",
270040
+ "description": "Create a new version for a bot",
270041
+ "method": "post",
270042
+ "path": "/v1/admin/bots/{id}/versions",
270043
+ "section": "bot",
270044
+ "parameters": {
270045
+ "id": {
270046
+ "type": "string",
270047
+ "description": "Bot ID",
270048
+ "in": "path"
270049
+ }
270050
+ },
270051
+ "requestBody": {
270052
+ "description": "Version metadata",
270053
+ "schema": {
270054
+ "type": "object",
270055
+ "properties": {
270056
+ "name": {
270057
+ "type": "string"
270058
+ },
270059
+ "description": {
270060
+ "type": "string"
270061
+ }
270062
+ },
270063
+ "required": [
270064
+ "name"
270065
+ ],
270066
+ "title": "createBotVersionBody",
270067
+ "additionalProperties": false
270068
+ }
270069
+ },
270070
+ "response": {
270071
+ "description": "Success",
270072
+ "schema": {
270073
+ "type": "object",
270074
+ "properties": {
270075
+ "version": {
270076
+ "type": "object",
270077
+ "properties": {
270078
+ "id": {
270079
+ "type": "string"
270080
+ },
270081
+ "name": {
270082
+ "type": "string"
270083
+ },
270084
+ "description": {
270085
+ "type": "string"
270086
+ }
270087
+ },
270088
+ "required": [
270089
+ "id",
270090
+ "name"
270091
+ ],
270092
+ "additionalProperties": false
270093
+ }
270094
+ },
270095
+ "required": [
270096
+ "version"
270097
+ ],
270098
+ "title": "createBotVersionResponse",
270099
+ "additionalProperties": false
270100
+ }
270101
+ }
270102
+ },
270103
+ "deployBotVersion": {
270104
+ "name": "deployBotVersion",
270105
+ "description": "Deploys a version for a bot",
270106
+ "method": "post",
270107
+ "path": "/v1/admin/bots/{id}/versions/deploy",
270108
+ "section": "bot",
270109
+ "parameters": {
270110
+ "id": {
270111
+ "type": "string",
270112
+ "description": "Bot ID",
270113
+ "in": "path"
270114
+ }
270115
+ },
270116
+ "requestBody": {
270117
+ "description": "Version metadata",
270118
+ "schema": {
270119
+ "type": "object",
270120
+ "properties": {
270121
+ "versionId": {
270122
+ "type": "string"
270123
+ }
270124
+ },
270125
+ "required": [
270126
+ "versionId"
270127
+ ],
270128
+ "title": "deployBotVersionBody",
270129
+ "additionalProperties": false
270130
+ }
270131
+ },
270132
+ "response": {
270133
+ "description": "Success",
270134
+ "schema": {
270135
+ "type": "object",
270136
+ "title": "deployBotVersionResponse",
270137
+ "additionalProperties": false
270138
+ }
270139
+ }
270140
+ },
269954
270141
  "setWorkspacePaymentMethod": {
269955
270142
  "name": "setWorkspacePaymentMethod",
269956
270143
  "description": "Set the Stripe PaymentMethod to use for billing the workspace. To create a PaymentMethod, use the Stripe API or SDK with our Stripe Publishable Key which is listed in this documentation.",
@@ -275611,7 +275798,7 @@ var state = {
275611
275798
  "title": "Botpress API",
275612
275799
  "description": "API for Botpress Cloud",
275613
275800
  "server": "https://api.botpress.cloud",
275614
- "version": "0.32.3",
275801
+ "version": "0.33.0",
275615
275802
  "prefix": "v1"
275616
275803
  },
275617
275804
  "errors": [
@@ -275765,6 +275952,8 @@ var state = {
275765
275952
  "createBotBody": true,
275766
275953
  "updateBotBody": true,
275767
275954
  "transferBotBody": true,
275955
+ "createBotVersionBody": true,
275956
+ "deployBotVersionBody": true,
275768
275957
  "setWorkspacePaymentMethodBody": true,
275769
275958
  "chargeWorkspaceUnpaidInvoicesBody": true,
275770
275959
  "createWorkspaceBody": true,
@@ -275854,6 +276043,10 @@ var state = {
275854
276043
  "listBotIssuesResponse": true,
275855
276044
  "deleteBotIssueResponse": true,
275856
276045
  "listBotIssueEventsResponse": true,
276046
+ "listBotVersionsResponse": true,
276047
+ "getBotVersionResponse": true,
276048
+ "createBotVersionResponse": true,
276049
+ "deployBotVersionResponse": true,
275857
276050
  "setWorkspacePaymentMethodResponse": true,
275858
276051
  "listWorkspaceInvoicesResponse": true,
275859
276052
  "getUpcomingInvoiceResponse": true,
@@ -275931,6 +276124,7 @@ var state = {
275931
276124
  "Issue": true,
275932
276125
  "IssueEvent": true,
275933
276126
  "Activity": true,
276127
+ "Version": true,
275934
276128
  "User": true,
275935
276129
  "Conversation": true,
275936
276130
  "Event": true,
@@ -277504,6 +277698,28 @@ var state = {
277504
277698
  "additionalProperties": false
277505
277699
  }
277506
277700
  },
277701
+ "Version": {
277702
+ "section": "bot",
277703
+ "schema": {
277704
+ "type": "object",
277705
+ "properties": {
277706
+ "id": {
277707
+ "type": "string"
277708
+ },
277709
+ "name": {
277710
+ "type": "string"
277711
+ },
277712
+ "description": {
277713
+ "type": "string"
277714
+ }
277715
+ },
277716
+ "required": [
277717
+ "id",
277718
+ "name"
277719
+ ],
277720
+ "additionalProperties": false
277721
+ }
277722
+ },
277507
277723
  "User": {
277508
277724
  "section": "user",
277509
277725
  "schema": {
@@ -278523,7 +278739,11 @@ var state = {
278523
278739
  "getBotIssue",
278524
278740
  "listBotIssues",
278525
278741
  "deleteBotIssue",
278526
- "listBotIssueEvents"
278742
+ "listBotIssueEvents",
278743
+ "listBotVersions",
278744
+ "getBotVersion",
278745
+ "createBotVersion",
278746
+ "deployBotVersion"
278527
278747
  ],
278528
278748
  "schema": "Bot"
278529
278749
  },
@@ -1,5 +1,5 @@
1
1
  import * as opapi from '@bpinternal/opapi';
2
- export type State = opapi.State<'Bot' | 'Integration' | 'Interface' | 'Workspace' | 'WorkspaceMember' | 'Account' | 'Usage' | 'Issue' | 'IssueEvent' | 'Activity' | 'User' | 'Conversation' | 'Event' | 'Message' | 'State' | 'Task' | 'Table' | 'Column' | 'Row' | 'File', never, 'user' | 'conversation' | 'event' | 'message' | 'file' | 'state' | 'hub' | 'action' | 'task' | 'bot' | 'integration' | 'interface' | 'workspace' | 'workspaceMember' | 'account' | 'usage' | 'quotas' | 'helper' | 'activity' | 'tables' | 'files'>;
2
+ export type State = opapi.State<'Bot' | 'Integration' | 'Interface' | 'Workspace' | 'WorkspaceMember' | 'Account' | 'Usage' | 'Issue' | 'IssueEvent' | 'Activity' | 'Version' | 'User' | 'Conversation' | 'Event' | 'Message' | 'State' | 'Task' | 'Table' | 'Column' | 'Row' | 'File', never, 'user' | 'conversation' | 'event' | 'message' | 'file' | 'state' | 'hub' | 'action' | 'task' | 'bot' | 'integration' | 'interface' | 'workspace' | 'workspaceMember' | 'account' | 'usage' | 'quotas' | 'helper' | 'activity' | 'tables' | 'files'>;
3
3
  export declare const state: {
4
4
  operations: {
5
5
  createConversation: {
@@ -4514,6 +4514,177 @@ export declare const state: {
4514
4514
  };
4515
4515
  };
4516
4516
  };
4517
+ listBotVersions: {
4518
+ name: string;
4519
+ description: string;
4520
+ method: "get";
4521
+ path: string;
4522
+ section: "bot";
4523
+ parameters: {
4524
+ id: {
4525
+ type: "string";
4526
+ description: string;
4527
+ in: "path";
4528
+ };
4529
+ };
4530
+ response: {
4531
+ description: string;
4532
+ schema: {
4533
+ type: "object";
4534
+ properties: {
4535
+ versions: {
4536
+ type: "array";
4537
+ items: {
4538
+ type: "object";
4539
+ properties: {
4540
+ id: {
4541
+ type: "string";
4542
+ };
4543
+ name: {
4544
+ type: "string";
4545
+ };
4546
+ description: {
4547
+ type: "string";
4548
+ };
4549
+ };
4550
+ required: string[];
4551
+ };
4552
+ };
4553
+ };
4554
+ required: string[];
4555
+ title: string;
4556
+ additionalProperties: false;
4557
+ };
4558
+ };
4559
+ };
4560
+ getBotVersion: {
4561
+ name: string;
4562
+ description: string;
4563
+ method: "get";
4564
+ path: string;
4565
+ section: "bot";
4566
+ parameters: {
4567
+ id: {
4568
+ type: "string";
4569
+ description: string;
4570
+ in: "path";
4571
+ };
4572
+ versionId: {
4573
+ type: "string";
4574
+ description: string;
4575
+ in: "path";
4576
+ };
4577
+ };
4578
+ response: {
4579
+ description: string;
4580
+ schema: {
4581
+ type: "object";
4582
+ properties: {
4583
+ url: {
4584
+ type: "string";
4585
+ format: string;
4586
+ };
4587
+ };
4588
+ required: string[];
4589
+ title: string;
4590
+ additionalProperties: false;
4591
+ };
4592
+ };
4593
+ };
4594
+ createBotVersion: {
4595
+ name: string;
4596
+ description: string;
4597
+ method: "post";
4598
+ path: string;
4599
+ section: "bot";
4600
+ parameters: {
4601
+ id: {
4602
+ type: "string";
4603
+ description: string;
4604
+ in: "path";
4605
+ };
4606
+ };
4607
+ requestBody: {
4608
+ description: string;
4609
+ schema: {
4610
+ type: "object";
4611
+ properties: {
4612
+ name: {
4613
+ type: "string";
4614
+ };
4615
+ description: {
4616
+ type: "string";
4617
+ };
4618
+ };
4619
+ required: string[];
4620
+ title: string;
4621
+ additionalProperties: false;
4622
+ };
4623
+ };
4624
+ response: {
4625
+ description: string;
4626
+ schema: {
4627
+ type: "object";
4628
+ properties: {
4629
+ version: {
4630
+ type: "object";
4631
+ properties: {
4632
+ id: {
4633
+ type: "string";
4634
+ };
4635
+ name: {
4636
+ type: "string";
4637
+ };
4638
+ description: {
4639
+ type: "string";
4640
+ };
4641
+ };
4642
+ required: string[];
4643
+ additionalProperties: false;
4644
+ };
4645
+ };
4646
+ required: string[];
4647
+ title: string;
4648
+ additionalProperties: false;
4649
+ };
4650
+ };
4651
+ };
4652
+ deployBotVersion: {
4653
+ name: string;
4654
+ description: string;
4655
+ method: "post";
4656
+ path: string;
4657
+ section: "bot";
4658
+ parameters: {
4659
+ id: {
4660
+ type: "string";
4661
+ description: string;
4662
+ in: "path";
4663
+ };
4664
+ };
4665
+ requestBody: {
4666
+ description: string;
4667
+ schema: {
4668
+ type: "object";
4669
+ properties: {
4670
+ versionId: {
4671
+ type: "string";
4672
+ };
4673
+ };
4674
+ required: string[];
4675
+ title: string;
4676
+ additionalProperties: false;
4677
+ };
4678
+ };
4679
+ response: {
4680
+ description: string;
4681
+ schema: {
4682
+ type: "object";
4683
+ title: string;
4684
+ additionalProperties: false;
4685
+ };
4686
+ };
4687
+ };
4517
4688
  setWorkspacePaymentMethod: {
4518
4689
  name: string;
4519
4690
  description: string;
@@ -9513,6 +9684,8 @@ export declare const state: {
9513
9684
  createBotBody: true;
9514
9685
  updateBotBody: true;
9515
9686
  transferBotBody: true;
9687
+ createBotVersionBody: true;
9688
+ deployBotVersionBody: true;
9516
9689
  setWorkspacePaymentMethodBody: true;
9517
9690
  chargeWorkspaceUnpaidInvoicesBody: true;
9518
9691
  createWorkspaceBody: true;
@@ -9602,6 +9775,10 @@ export declare const state: {
9602
9775
  listBotIssuesResponse: true;
9603
9776
  deleteBotIssueResponse: true;
9604
9777
  listBotIssueEventsResponse: true;
9778
+ listBotVersionsResponse: true;
9779
+ getBotVersionResponse: true;
9780
+ createBotVersionResponse: true;
9781
+ deployBotVersionResponse: true;
9605
9782
  setWorkspacePaymentMethodResponse: true;
9606
9783
  listWorkspaceInvoicesResponse: true;
9607
9784
  getUpcomingInvoiceResponse: true;
@@ -9679,6 +9856,7 @@ export declare const state: {
9679
9856
  Issue: true;
9680
9857
  IssueEvent: true;
9681
9858
  Activity: true;
9859
+ Version: true;
9682
9860
  User: true;
9683
9861
  Conversation: true;
9684
9862
  Event: true;
@@ -10974,6 +11152,25 @@ export declare const state: {
10974
11152
  additionalProperties: false;
10975
11153
  };
10976
11154
  };
11155
+ Version: {
11156
+ section: "bot";
11157
+ schema: {
11158
+ type: "object";
11159
+ properties: {
11160
+ id: {
11161
+ type: "string";
11162
+ };
11163
+ name: {
11164
+ type: "string";
11165
+ };
11166
+ description: {
11167
+ type: "string";
11168
+ };
11169
+ };
11170
+ required: string[];
11171
+ additionalProperties: false;
11172
+ };
11173
+ };
10977
11174
  User: {
10978
11175
  section: "user";
10979
11176
  schema: {
@@ -1,6 +1,6 @@
1
1
  export * from './gen/state';
2
2
  export declare const api: {
3
- getModelRef: (name: "Bot" | "Integration" | "Interface" | "Workspace" | "WorkspaceMember" | "Account" | "Usage" | "Issue" | "IssueEvent" | "Activity" | "User" | "Conversation" | "Event" | "Message" | "State" | "Task" | "Table" | "Column" | "Row" | "File") => import("@bpinternal/opapi").OpenApiZodAny;
3
+ getModelRef: (name: "Bot" | "Integration" | "Interface" | "Workspace" | "WorkspaceMember" | "Account" | "Usage" | "Issue" | "IssueEvent" | "Activity" | "Version" | "User" | "Conversation" | "Event" | "Message" | "State" | "Task" | "Table" | "Column" | "Row" | "File") => import("@bpinternal/opapi").OpenApiZodAny;
4
4
  addOperation: <Path extends string>(operationProps: import("@bpinternal/opapi").Operation<"x-integration-id" | "x-workspace-id", "user" | "conversation" | "event" | "message" | "file" | "state" | "hub" | "action" | "task" | "bot" | "integration" | "interface" | "workspace" | "workspaceMember" | "account" | "usage" | "quotas" | "helper" | "activity" | "tables" | "files", Path, "zod-schema">) => void;
5
5
  exportClient: {
6
6
  (dir: string, openapiGeneratorEndpoint: string, postProcessors?: import("@bpinternal/opapi").OpenApiPostProcessors | undefined): Promise<void>;
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@botpress/api",
3
- "version": "0.32.3",
3
+ "version": "0.33.0",
4
4
  "main": "dist/index.js",
5
5
  "types": "dist/src/index.d.ts",
6
6
  "scripts": {
@@ -1 +1 @@
1
- {"sections":[{"description":"","title":"User","name":"user","operations":["createUser","getUser","listUsers","getOrCreateUser","updateUser","deleteUser"],"schema":"User"},{"description":"","title":"Conversation","name":"conversation","operations":["createConversation","getConversation","listConversations","getOrCreateConversation","updateConversation","deleteConversation","listParticipants","addParticipant","getParticipant","removeParticipant"],"schema":"Conversation"},{"description":"","title":"Event","name":"event","operations":["createEvent","getEvent","listEvents"],"schema":"Event"},{"description":"","title":"Message","name":"message","operations":["createMessage","getOrCreateMessage","getMessage","updateMessage","listMessages","deleteMessage"],"schema":"Message"},{"description":"","title":"File","name":"file","operations":[]},{"description":"","title":"State","name":"state","operations":["getState","setState","getOrSetState","patchState"],"schema":"State"},{"title":"Hub","description":"","name":"hub","operations":["listPublicIntegrations","getPublicIntegrationById","getPublicIntegration"]},{"description":"","title":"Action","name":"action","operations":["callAction"]},{"description":"","title":"Task","name":"task","operations":["getTask","createTask","updateTask","deleteTask","listTasks"],"schema":"Task"},{"title":"Bot","description":"","name":"bot","operations":["createBot","updateBot","transferBot","listBots","getBot","deleteBot","getBotLogs","getBotWebchat","getBotAnalytics","getBotIssue","listBotIssues","deleteBotIssue","listBotIssueEvents"],"schema":"Bot"},{"title":"Integration","description":"","name":"integration","operations":["listIntegrationApiKeys","createIntegrationApiKey","deleteIntegrationApiKey","createIntegration","updateIntegration","listIntegrations","getIntegration","getIntegrationLogs","getIntegrationByName","deleteIntegration"],"schema":"Integration"},{"title":"Interface","description":"","name":"interface","operations":["createInterface","getInterface","getInterfaceByName","updateInterface","deleteInterface","listInterfaces"],"schema":"Interface"},{"title":"Workspace","description":"","name":"workspace","operations":["setWorkspacePaymentMethod","listWorkspaceInvoices","getUpcomingInvoice","chargeWorkspaceUnpaidInvoices","createWorkspace","getPublicWorkspace","getWorkspace","listWorkspaceUsages","breakDownWorkspaceUsageByBot","getAllWorkspaceQuotaCompletion","getWorkspaceQuota","listWorkspaceQuotas","updateWorkspace","checkHandleAvailability","listWorkspaces","listPublicWorkspaces","deleteWorkspace","getAuditRecords"],"schema":"Workspace"},{"title":"Workspace Member","description":"","name":"workspaceMember","operations":["listWorkspaceMembers","getWorkspaceMember","deleteWorkspaceMember","createWorkspaceMember","updateWorkspaceMember"],"schema":"WorkspaceMember"},{"title":"Account","description":"","name":"account","operations":["getAccount","updateAccount","listPersonalAccessTokens","createPersonalAccessToken","deletePersonalAccessToken","setAccountPreference","getAccountPreference"],"schema":"Account"},{"title":"Usage","description":"","name":"usage","operations":["getUsage","getMultipleUsages"],"schema":"Usage"},{"title":"Quotas","description":"","name":"quotas","operations":["changeAISpendQuota"]},{"title":"Helper","description":"","name":"helper","operations":["runVrl"]},{"title":"Activity","description":"","name":"activity","operations":["listActivities"],"schema":"Activity"},{"title":"Tables","description":"Manage and interact with table structures, including creation, updates, and querying of tables and their rows.","name":"tables","operations":["listTables","getTable","getOrCreateTable","createTable","duplicateTable","updateTable","renameTableColumn","deleteTable","getTableRow","findTableRows","createTableRows","deleteTableRows","updateTableRows","upsertTableRows"],"schema":"Table"},{"title":"Files","description":"The Files API allows you to create, manage, and index files that can be used by your bots and integrations. Files can be in any text or binary format, and documents (such as PDF, Microsoft Office, HTML, CSV, etc.) can be indexed to be used for semantic search in RAG (Retrieval Augmented Generation) implementations. Files are private by default but can be made publicly accessible through a permanent URL that's unique for each file.","name":"files","operations":["upsertFile","deleteFile","listFiles","getFile","updateFileMetadata","searchFiles"],"schema":"File"}],"errors":[{"status":500,"type":"Unknown","description":"An unknown error occurred"},{"status":500,"type":"Internal","description":"An internal error occurred"},{"status":401,"type":"Unauthorized","description":"The request requires to be authenticated."},{"status":403,"type":"Forbidden","description":"The requested action can't be peform by this resource."},{"status":413,"type":"PayloadTooLarge","description":"The request payload is too large."},{"status":400,"type":"InvalidPayload","description":"The request payload is invalid."},{"status":415,"type":"UnsupportedMediaType","description":"The request is invalid because the content-type is not supported."},{"status":405,"type":"MethodNotFound","description":"The requested method does not exist."},{"status":404,"type":"ResourceNotFound","description":"The requested resource does not exist."},{"status":400,"type":"InvalidJsonSchema","description":"The provided JSON schema is invalid."},{"status":400,"type":"InvalidDataFormat","description":"The provided data doesn't respect the provided JSON schema."},{"status":400,"type":"InvalidIdentifier","description":"The provided identifier is not valid. An identifier must start with a lowercase letter, be between 2 and 100 characters long and use only alphanumeric characters."},{"status":409,"type":"RelationConflict","description":"The resource is related with a different resource that the one referenced in the request. This is usually caused when providing two resource identifiers that aren't linked together."},{"status":409,"type":"ReferenceConstraint","description":"The resource cannot be deleted because it's referenced by another resource"},{"status":409,"type":"ResourceLockedConflict","description":"The resource is current locked and cannot be operated on until the lock is released."},{"status":400,"type":"ReferenceNotFound","description":"The provided resource reference is missing. This is usually caused when providing an invalid id inside the payload of a request."},{"status":400,"type":"InvalidQuery","description":"The provided query is invalid. This is usually caused when providing an invalid parameter for querying a resource."},{"status":400,"type":"Runtime","description":"An error happened during the execution of a runtime (bot or integration)."},{"status":409,"type":"AlreadyExists","description":"The record attempted to be created already exists."},{"status":429,"type":"RateLimited","description":"The request has been rate limited."},{"status":402,"type":"PaymentRequired","description":"A payment is required to perform this request."},{"status":403,"type":"QuotaExceeded","description":"The request exceeds the allowed quota. Quotas are a soft limit that can be increased."},{"status":413,"type":"LimitExceeded","description":"The request exceeds the allowed limit. Limits are a hard limit that cannot be increased."},{"status":400,"type":"BreakingChanges","description":"Request payload contains breaking changes which is not allowed for this resource without a version increment."}]}
1
+ {"sections":[{"description":"","title":"User","name":"user","operations":["createUser","getUser","listUsers","getOrCreateUser","updateUser","deleteUser"],"schema":"User"},{"description":"","title":"Conversation","name":"conversation","operations":["createConversation","getConversation","listConversations","getOrCreateConversation","updateConversation","deleteConversation","listParticipants","addParticipant","getParticipant","removeParticipant"],"schema":"Conversation"},{"description":"","title":"Event","name":"event","operations":["createEvent","getEvent","listEvents"],"schema":"Event"},{"description":"","title":"Message","name":"message","operations":["createMessage","getOrCreateMessage","getMessage","updateMessage","listMessages","deleteMessage"],"schema":"Message"},{"description":"","title":"File","name":"file","operations":[]},{"description":"","title":"State","name":"state","operations":["getState","setState","getOrSetState","patchState"],"schema":"State"},{"title":"Hub","description":"","name":"hub","operations":["listPublicIntegrations","getPublicIntegrationById","getPublicIntegration"]},{"description":"","title":"Action","name":"action","operations":["callAction"]},{"description":"","title":"Task","name":"task","operations":["getTask","createTask","updateTask","deleteTask","listTasks"],"schema":"Task"},{"title":"Bot","description":"","name":"bot","operations":["createBot","updateBot","transferBot","listBots","getBot","deleteBot","getBotLogs","getBotWebchat","getBotAnalytics","getBotIssue","listBotIssues","deleteBotIssue","listBotIssueEvents","listBotVersions","getBotVersion","createBotVersion","deployBotVersion"],"schema":"Bot"},{"title":"Integration","description":"","name":"integration","operations":["listIntegrationApiKeys","createIntegrationApiKey","deleteIntegrationApiKey","createIntegration","updateIntegration","listIntegrations","getIntegration","getIntegrationLogs","getIntegrationByName","deleteIntegration"],"schema":"Integration"},{"title":"Interface","description":"","name":"interface","operations":["createInterface","getInterface","getInterfaceByName","updateInterface","deleteInterface","listInterfaces"],"schema":"Interface"},{"title":"Workspace","description":"","name":"workspace","operations":["setWorkspacePaymentMethod","listWorkspaceInvoices","getUpcomingInvoice","chargeWorkspaceUnpaidInvoices","createWorkspace","getPublicWorkspace","getWorkspace","listWorkspaceUsages","breakDownWorkspaceUsageByBot","getAllWorkspaceQuotaCompletion","getWorkspaceQuota","listWorkspaceQuotas","updateWorkspace","checkHandleAvailability","listWorkspaces","listPublicWorkspaces","deleteWorkspace","getAuditRecords"],"schema":"Workspace"},{"title":"Workspace Member","description":"","name":"workspaceMember","operations":["listWorkspaceMembers","getWorkspaceMember","deleteWorkspaceMember","createWorkspaceMember","updateWorkspaceMember"],"schema":"WorkspaceMember"},{"title":"Account","description":"","name":"account","operations":["getAccount","updateAccount","listPersonalAccessTokens","createPersonalAccessToken","deletePersonalAccessToken","setAccountPreference","getAccountPreference"],"schema":"Account"},{"title":"Usage","description":"","name":"usage","operations":["getUsage","getMultipleUsages"],"schema":"Usage"},{"title":"Quotas","description":"","name":"quotas","operations":["changeAISpendQuota"]},{"title":"Helper","description":"","name":"helper","operations":["runVrl"]},{"title":"Activity","description":"","name":"activity","operations":["listActivities"],"schema":"Activity"},{"title":"Tables","description":"Manage and interact with table structures, including creation, updates, and querying of tables and their rows.","name":"tables","operations":["listTables","getTable","getOrCreateTable","createTable","duplicateTable","updateTable","renameTableColumn","deleteTable","getTableRow","findTableRows","createTableRows","deleteTableRows","updateTableRows","upsertTableRows"],"schema":"Table"},{"title":"Files","description":"The Files API allows you to create, manage, and index files that can be used by your bots and integrations. Files can be in any text or binary format, and documents (such as PDF, Microsoft Office, HTML, CSV, etc.) can be indexed to be used for semantic search in RAG (Retrieval Augmented Generation) implementations. Files are private by default but can be made publicly accessible through a permanent URL that's unique for each file.","name":"files","operations":["upsertFile","deleteFile","listFiles","getFile","updateFileMetadata","searchFiles"],"schema":"File"}],"errors":[{"status":500,"type":"Unknown","description":"An unknown error occurred"},{"status":500,"type":"Internal","description":"An internal error occurred"},{"status":401,"type":"Unauthorized","description":"The request requires to be authenticated."},{"status":403,"type":"Forbidden","description":"The requested action can't be peform by this resource."},{"status":413,"type":"PayloadTooLarge","description":"The request payload is too large."},{"status":400,"type":"InvalidPayload","description":"The request payload is invalid."},{"status":415,"type":"UnsupportedMediaType","description":"The request is invalid because the content-type is not supported."},{"status":405,"type":"MethodNotFound","description":"The requested method does not exist."},{"status":404,"type":"ResourceNotFound","description":"The requested resource does not exist."},{"status":400,"type":"InvalidJsonSchema","description":"The provided JSON schema is invalid."},{"status":400,"type":"InvalidDataFormat","description":"The provided data doesn't respect the provided JSON schema."},{"status":400,"type":"InvalidIdentifier","description":"The provided identifier is not valid. An identifier must start with a lowercase letter, be between 2 and 100 characters long and use only alphanumeric characters."},{"status":409,"type":"RelationConflict","description":"The resource is related with a different resource that the one referenced in the request. This is usually caused when providing two resource identifiers that aren't linked together."},{"status":409,"type":"ReferenceConstraint","description":"The resource cannot be deleted because it's referenced by another resource"},{"status":409,"type":"ResourceLockedConflict","description":"The resource is current locked and cannot be operated on until the lock is released."},{"status":400,"type":"ReferenceNotFound","description":"The provided resource reference is missing. This is usually caused when providing an invalid id inside the payload of a request."},{"status":400,"type":"InvalidQuery","description":"The provided query is invalid. This is usually caused when providing an invalid parameter for querying a resource."},{"status":400,"type":"Runtime","description":"An error happened during the execution of a runtime (bot or integration)."},{"status":409,"type":"AlreadyExists","description":"The record attempted to be created already exists."},{"status":429,"type":"RateLimited","description":"The request has been rate limited."},{"status":402,"type":"PaymentRequired","description":"A payment is required to perform this request."},{"status":403,"type":"QuotaExceeded","description":"The request exceeds the allowed quota. Quotas are a soft limit that can be increased."},{"status":413,"type":"LimitExceeded","description":"The request exceeds the allowed limit. Limits are a hard limit that cannot be increased."},{"status":400,"type":"BreakingChanges","description":"Request payload contains breaking changes which is not allowed for this resource without a version increment."}]}