@retell-ai/retell-cli 0.13.0 → 0.15.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/src/generated/operations.js +234 -13
- package/package.json +1 -1
|
@@ -3,8 +3,8 @@ export const catalogMetadata = {
|
|
|
3
3
|
"title": "Retell SDK",
|
|
4
4
|
"apiVersion": "3.0.0",
|
|
5
5
|
"server": "https://api.retellai.com",
|
|
6
|
-
"sourceSha256": "
|
|
7
|
-
"operationCount":
|
|
6
|
+
"sourceSha256": "1cc0ff5e4dbcde6c0e9d2c4cfa9678d589e9858e1edb82f8b21e0defba28baa0",
|
|
7
|
+
"operationCount": 111
|
|
8
8
|
};
|
|
9
9
|
export const schemaDefinitions = {
|
|
10
10
|
"AgentFilter": {
|
|
@@ -7571,7 +7571,7 @@ export const operations = [
|
|
|
7571
7571
|
}
|
|
7572
7572
|
]
|
|
7573
7573
|
},
|
|
7574
|
-
"responseContractHash": "
|
|
7574
|
+
"responseContractHash": "62531dcc54900399151590ff19b8da06601726af27bd2530283f063efdf04742"
|
|
7575
7575
|
},
|
|
7576
7576
|
{
|
|
7577
7577
|
"operationId": "createChatAgent",
|
|
@@ -8932,7 +8932,7 @@ export const operations = [
|
|
|
8932
8932
|
"flag": "--inbound-webhook-url",
|
|
8933
8933
|
"required": false,
|
|
8934
8934
|
"type": "string",
|
|
8935
|
-
"description": "If set, Retell will send a webhook for inbound calls, where you can override the agent ID, set dynamic variables, reject the call, and configure other fields specific to that call.",
|
|
8935
|
+
"description": "If set, Retell will send a webhook for inbound calls, where you can override the agent ID, set dynamic variables, reject the call, and configure other fields specific to that call. Includes call_inbound.call_id for deduplication across HTTP retries. Early setup failures may not create a call history record.",
|
|
8936
8936
|
"example": "https://example.com/inbound-webhook",
|
|
8937
8937
|
"array": false,
|
|
8938
8938
|
"nullable": true,
|
|
@@ -9456,7 +9456,7 @@ export const operations = [
|
|
|
9456
9456
|
}
|
|
9457
9457
|
]
|
|
9458
9458
|
},
|
|
9459
|
-
"responseContractHash": "
|
|
9459
|
+
"responseContractHash": "b14d904a975892f99c9dfb613d0f2d3b905f974c6a31bc34ad8b3fb12b061683"
|
|
9460
9460
|
},
|
|
9461
9461
|
{
|
|
9462
9462
|
"operationId": "createTestCaseDefinition",
|
|
@@ -9599,7 +9599,7 @@ export const operations = [
|
|
|
9599
9599
|
"method": "POST",
|
|
9600
9600
|
"path": "/v2/create-web-call",
|
|
9601
9601
|
"description": "Create a new web call",
|
|
9602
|
-
"deprecated":
|
|
9602
|
+
"deprecated": true,
|
|
9603
9603
|
"authenticated": true,
|
|
9604
9604
|
"parameters": [],
|
|
9605
9605
|
"requestBody": {
|
|
@@ -9725,6 +9725,138 @@ export const operations = [
|
|
|
9725
9725
|
},
|
|
9726
9726
|
"responseContractHash": "41fb8734cceb8c5d24a3dbb3024a881746d7ceea15a22814299ba9b174adacd2"
|
|
9727
9727
|
},
|
|
9728
|
+
{
|
|
9729
|
+
"operationId": "createWebCallV3",
|
|
9730
|
+
"command": "create-web-call-v3",
|
|
9731
|
+
"method": "POST",
|
|
9732
|
+
"path": "/v3/create-web-call",
|
|
9733
|
+
"description": "Create a new web call and return browser connection details.",
|
|
9734
|
+
"deprecated": false,
|
|
9735
|
+
"authenticated": true,
|
|
9736
|
+
"parameters": [],
|
|
9737
|
+
"requestBody": {
|
|
9738
|
+
"required": true,
|
|
9739
|
+
"contentType": "application/json",
|
|
9740
|
+
"propertyCount": 7,
|
|
9741
|
+
"requiredFields": [
|
|
9742
|
+
"agent_id"
|
|
9743
|
+
],
|
|
9744
|
+
"validationSchema": {
|
|
9745
|
+
"type": "object",
|
|
9746
|
+
"required": [
|
|
9747
|
+
"agent_id"
|
|
9748
|
+
],
|
|
9749
|
+
"properties": {
|
|
9750
|
+
"agent_id": {
|
|
9751
|
+
"type": "string",
|
|
9752
|
+
"minLength": 1
|
|
9753
|
+
},
|
|
9754
|
+
"agent_version": {
|
|
9755
|
+
"$ref": "#/components/schemas/AgentVersionReference"
|
|
9756
|
+
},
|
|
9757
|
+
"agent_override": {
|
|
9758
|
+
"$ref": "#/components/schemas/AgentOverrideRequest"
|
|
9759
|
+
},
|
|
9760
|
+
"metadata": {
|
|
9761
|
+
"type": "object"
|
|
9762
|
+
},
|
|
9763
|
+
"retell_llm_dynamic_variables": {
|
|
9764
|
+
"type": "object",
|
|
9765
|
+
"additionalProperties": {
|
|
9766
|
+
"type": "string"
|
|
9767
|
+
}
|
|
9768
|
+
},
|
|
9769
|
+
"current_node_id": {
|
|
9770
|
+
"type": "string",
|
|
9771
|
+
"nullable": true
|
|
9772
|
+
},
|
|
9773
|
+
"current_state": {
|
|
9774
|
+
"type": "string",
|
|
9775
|
+
"nullable": true
|
|
9776
|
+
}
|
|
9777
|
+
}
|
|
9778
|
+
},
|
|
9779
|
+
"fields": [
|
|
9780
|
+
{
|
|
9781
|
+
"name": "agent_id",
|
|
9782
|
+
"flag": "--agent-id",
|
|
9783
|
+
"required": true,
|
|
9784
|
+
"type": "string",
|
|
9785
|
+
"description": "Unique id of agent used for the call. Your agent would contain the LLM Websocket url used for this call.",
|
|
9786
|
+
"example": "oBeDLoLOeuAbiuaMFXRtDOLriTJ5tSxD",
|
|
9787
|
+
"array": false,
|
|
9788
|
+
"nullable": false,
|
|
9789
|
+
"contractHash": "9ac136edb99a2063b3091602181c8d2022fdccb5b514991319d58544c2e57e95"
|
|
9790
|
+
},
|
|
9791
|
+
{
|
|
9792
|
+
"name": "agent_version",
|
|
9793
|
+
"flag": "--agent-version",
|
|
9794
|
+
"required": false,
|
|
9795
|
+
"type": "oneOf",
|
|
9796
|
+
"description": "The version of the agent to use for the call.",
|
|
9797
|
+
"array": false,
|
|
9798
|
+
"nullable": false,
|
|
9799
|
+
"contractHash": "684cd44f848f81e904b8973188277a469c18a3514b8094f3817829afc286f07b"
|
|
9800
|
+
},
|
|
9801
|
+
{
|
|
9802
|
+
"name": "agent_override",
|
|
9803
|
+
"flag": "--agent-override",
|
|
9804
|
+
"required": false,
|
|
9805
|
+
"type": "object",
|
|
9806
|
+
"description": "For this particular call, override agent configuration with these settings. This allows you to customize agent behavior for individual calls without modifying the base agent.",
|
|
9807
|
+
"array": false,
|
|
9808
|
+
"nullable": false,
|
|
9809
|
+
"contractHash": "bf6fddff97fd4506afe9c37c0eac1edae28af369c56826673701f2ee8d8d1b89"
|
|
9810
|
+
},
|
|
9811
|
+
{
|
|
9812
|
+
"name": "metadata",
|
|
9813
|
+
"flag": "--metadata",
|
|
9814
|
+
"required": false,
|
|
9815
|
+
"type": "object",
|
|
9816
|
+
"description": "An arbitrary object for storage purpose only. You can put anything here like your internal customer id associated with the call. Not used for processing. You can later get this field from the call object.",
|
|
9817
|
+
"array": false,
|
|
9818
|
+
"nullable": false,
|
|
9819
|
+
"contractHash": "a2c799262a3ce3c19ef5cdd983bf3d12b43ab3c426227091b909dcb7054738c0"
|
|
9820
|
+
},
|
|
9821
|
+
{
|
|
9822
|
+
"name": "retell_llm_dynamic_variables",
|
|
9823
|
+
"flag": "--retell-llm-dynamic-variables",
|
|
9824
|
+
"required": false,
|
|
9825
|
+
"type": "object",
|
|
9826
|
+
"description": "Add optional dynamic variables in key value pairs of string that injects into your Response Engine prompt and tool description. Only applicable for Response Engine.",
|
|
9827
|
+
"example": {
|
|
9828
|
+
"customer_name": "John Doe"
|
|
9829
|
+
},
|
|
9830
|
+
"array": false,
|
|
9831
|
+
"nullable": false,
|
|
9832
|
+
"contractHash": "3f161562db4a7237942681ccf41abd9a699b0260591ddd0d154bfca063f449bf"
|
|
9833
|
+
},
|
|
9834
|
+
{
|
|
9835
|
+
"name": "current_node_id",
|
|
9836
|
+
"flag": "--current-node-id",
|
|
9837
|
+
"required": false,
|
|
9838
|
+
"type": "string",
|
|
9839
|
+
"description": "Start the call at this conversation flow node (stage). Must be a valid node id in the agent's conversation flow. Only applicable when the agent uses conversation flow as the response engine. Ignored for retell-llm agents.",
|
|
9840
|
+
"example": "collect_info",
|
|
9841
|
+
"array": false,
|
|
9842
|
+
"nullable": true,
|
|
9843
|
+
"contractHash": "e16b0c0d0cdce6a489ad1ac5bbb7534eb3cca67b3ad23818a640e2bce397a142"
|
|
9844
|
+
},
|
|
9845
|
+
{
|
|
9846
|
+
"name": "current_state",
|
|
9847
|
+
"flag": "--current-state",
|
|
9848
|
+
"required": false,
|
|
9849
|
+
"type": "string",
|
|
9850
|
+
"description": "Start the conversation in this state (stage). Must be a valid state name in the agent's Retell LLM. Only applicable when the agent uses Retell LLM with states. Ignored for conversation-flow agents.",
|
|
9851
|
+
"example": "information_collection",
|
|
9852
|
+
"array": false,
|
|
9853
|
+
"nullable": true,
|
|
9854
|
+
"contractHash": "e16b0c0d0cdce6a489ad1ac5bbb7534eb3cca67b3ad23818a640e2bce397a142"
|
|
9855
|
+
}
|
|
9856
|
+
]
|
|
9857
|
+
},
|
|
9858
|
+
"responseContractHash": "45482a8f3e81d244ac5ed30eacac1fd2625bbd309f642637dea271d4c57fa860"
|
|
9859
|
+
},
|
|
9728
9860
|
{
|
|
9729
9861
|
"operationId": "deleteAgent",
|
|
9730
9862
|
"command": "delete-agent",
|
|
@@ -10433,7 +10565,7 @@ export const operations = [
|
|
|
10433
10565
|
}
|
|
10434
10566
|
}
|
|
10435
10567
|
],
|
|
10436
|
-
"responseContractHash": "
|
|
10568
|
+
"responseContractHash": "b14d904a975892f99c9dfb613d0f2d3b905f974c6a31bc34ad8b3fb12b061683"
|
|
10437
10569
|
},
|
|
10438
10570
|
{
|
|
10439
10571
|
"operationId": "getChatAgent",
|
|
@@ -11143,7 +11275,7 @@ export const operations = [
|
|
|
11143
11275
|
"flag": "--inbound-webhook-url",
|
|
11144
11276
|
"required": false,
|
|
11145
11277
|
"type": "string",
|
|
11146
|
-
"description": "If set, Retell will send a webhook for inbound calls, where you can override the agent ID, set dynamic variables, reject the call, and configure other fields specific to that call.",
|
|
11278
|
+
"description": "If set, Retell will send a webhook for inbound calls, where you can override the agent ID, set dynamic variables, reject the call, and configure other fields specific to that call. Includes call_inbound.call_id for deduplication across HTTP retries. Early setup failures may not create a call history record.",
|
|
11147
11279
|
"example": "https://example.com/inbound-webhook",
|
|
11148
11280
|
"array": false,
|
|
11149
11281
|
"nullable": true,
|
|
@@ -11868,7 +12000,7 @@ export const operations = [
|
|
|
11868
12000
|
"cursorField": "pagination_key",
|
|
11869
12001
|
"hasMoreField": "has_more"
|
|
11870
12002
|
},
|
|
11871
|
-
"responseContractHash": "
|
|
12003
|
+
"responseContractHash": "36347cc7ec1f8e8a8a60283fc1ecc1b2bae30fb9501073d0acb650f3f320e1c4"
|
|
11872
12004
|
},
|
|
11873
12005
|
{
|
|
11874
12006
|
"operationId": "listContactConversations",
|
|
@@ -12607,6 +12739,34 @@ export const operations = [
|
|
|
12607
12739
|
"parameters": [],
|
|
12608
12740
|
"responseContractHash": "11c25fb87d1be09b1f4d4de37012b2ae0741a611981c7fcee58da1c360a8ed10"
|
|
12609
12741
|
},
|
|
12742
|
+
{
|
|
12743
|
+
"operationId": "listenLiveCall",
|
|
12744
|
+
"command": "listen-live-call",
|
|
12745
|
+
"method": "POST",
|
|
12746
|
+
"path": "/v2/listen-live-call/{call_id}",
|
|
12747
|
+
"description": "Mint a subscribe-only access token for an in-progress call so a client can listen to live audio. The returned token grants join + subscribe on the call's existing audio room; it cannot publish. The call must be in ONGOING status.",
|
|
12748
|
+
"deprecated": false,
|
|
12749
|
+
"authenticated": true,
|
|
12750
|
+
"parameters": [
|
|
12751
|
+
{
|
|
12752
|
+
"name": "call_id",
|
|
12753
|
+
"flag": "--call-id",
|
|
12754
|
+
"in": "path",
|
|
12755
|
+
"required": true,
|
|
12756
|
+
"type": "string",
|
|
12757
|
+
"description": "The call id to listen to.",
|
|
12758
|
+
"array": false,
|
|
12759
|
+
"style": "simple",
|
|
12760
|
+
"explode": false,
|
|
12761
|
+
"allowReserved": false,
|
|
12762
|
+
"contractHash": "00404e686415370f1711c4d7acfa2905444d3cf23cef2e10c47d445ebe690f96",
|
|
12763
|
+
"validationSchema": {
|
|
12764
|
+
"type": "string"
|
|
12765
|
+
}
|
|
12766
|
+
}
|
|
12767
|
+
],
|
|
12768
|
+
"responseContractHash": "00a883c0c0f21e01478bbeb424748b225c9fcd29e3393909f81791ff5ec7e5d6"
|
|
12769
|
+
},
|
|
12610
12770
|
{
|
|
12611
12771
|
"operationId": "publishAgentVersion",
|
|
12612
12772
|
"command": "publish-agent-version",
|
|
@@ -12934,7 +13094,7 @@ export const operations = [
|
|
|
12934
13094
|
}
|
|
12935
13095
|
}
|
|
12936
13096
|
],
|
|
12937
|
-
"responseContractHash": "
|
|
13097
|
+
"responseContractHash": "62531dcc54900399151590ff19b8da06601726af27bd2530283f063efdf04742"
|
|
12938
13098
|
},
|
|
12939
13099
|
{
|
|
12940
13100
|
"operationId": "runSyncJob",
|
|
@@ -13044,6 +13204,67 @@ export const operations = [
|
|
|
13044
13204
|
],
|
|
13045
13205
|
"responseContractHash": "ca4902eb8a38d2da414fd61c103fdd9de69102c27704882bdc4cd6c8ad769346"
|
|
13046
13206
|
},
|
|
13207
|
+
{
|
|
13208
|
+
"operationId": "takeOverLiveCall",
|
|
13209
|
+
"command": "take-over-live-call",
|
|
13210
|
+
"method": "POST",
|
|
13211
|
+
"path": "/v2/take-over-live-call/{call_id}",
|
|
13212
|
+
"description": "Take over an in-progress call from the AI agent. The agent stops responding and the specified live-listen participant is allowed to speak directly to the caller. The call must be in ONGOING status.",
|
|
13213
|
+
"deprecated": false,
|
|
13214
|
+
"authenticated": true,
|
|
13215
|
+
"parameters": [
|
|
13216
|
+
{
|
|
13217
|
+
"name": "call_id",
|
|
13218
|
+
"flag": "--call-id",
|
|
13219
|
+
"in": "path",
|
|
13220
|
+
"required": true,
|
|
13221
|
+
"type": "string",
|
|
13222
|
+
"description": "The call id to take over.",
|
|
13223
|
+
"array": false,
|
|
13224
|
+
"style": "simple",
|
|
13225
|
+
"explode": false,
|
|
13226
|
+
"allowReserved": false,
|
|
13227
|
+
"contractHash": "00404e686415370f1711c4d7acfa2905444d3cf23cef2e10c47d445ebe690f96",
|
|
13228
|
+
"validationSchema": {
|
|
13229
|
+
"type": "string"
|
|
13230
|
+
}
|
|
13231
|
+
}
|
|
13232
|
+
],
|
|
13233
|
+
"requestBody": {
|
|
13234
|
+
"required": true,
|
|
13235
|
+
"contentType": "application/json",
|
|
13236
|
+
"propertyCount": 1,
|
|
13237
|
+
"requiredFields": [
|
|
13238
|
+
"participant_id"
|
|
13239
|
+
],
|
|
13240
|
+
"validationSchema": {
|
|
13241
|
+
"type": "object",
|
|
13242
|
+
"required": [
|
|
13243
|
+
"participant_id"
|
|
13244
|
+
],
|
|
13245
|
+
"properties": {
|
|
13246
|
+
"participant_id": {
|
|
13247
|
+
"type": "string"
|
|
13248
|
+
}
|
|
13249
|
+
},
|
|
13250
|
+
"additionalProperties": false
|
|
13251
|
+
},
|
|
13252
|
+
"fields": [
|
|
13253
|
+
{
|
|
13254
|
+
"name": "participant_id",
|
|
13255
|
+
"flag": "--participant-id",
|
|
13256
|
+
"required": true,
|
|
13257
|
+
"type": "string",
|
|
13258
|
+
"description": "The id of the live-listen participant to upgrade, obtained when joining via /v2/listen-live-call.",
|
|
13259
|
+
"example": "listener_a1b2c3d4e5f6g7h8i9j0",
|
|
13260
|
+
"array": false,
|
|
13261
|
+
"nullable": false,
|
|
13262
|
+
"contractHash": "00404e686415370f1711c4d7acfa2905444d3cf23cef2e10c47d445ebe690f96"
|
|
13263
|
+
}
|
|
13264
|
+
]
|
|
13265
|
+
},
|
|
13266
|
+
"responseContractHash": "a6ff74906d3096dbdef3f9a65e712f7bab7359b1c944eb8c6b2e9122ad071680"
|
|
13267
|
+
},
|
|
13047
13268
|
{
|
|
13048
13269
|
"operationId": "testAppAuth",
|
|
13049
13270
|
"command": "test-app-auth",
|
|
@@ -14471,7 +14692,7 @@ export const operations = [
|
|
|
14471
14692
|
}
|
|
14472
14693
|
]
|
|
14473
14694
|
},
|
|
14474
|
-
"responseContractHash": "
|
|
14695
|
+
"responseContractHash": "b14d904a975892f99c9dfb613d0f2d3b905f974c6a31bc34ad8b3fb12b061683"
|
|
14475
14696
|
},
|
|
14476
14697
|
{
|
|
14477
14698
|
"operationId": "updateContact",
|
|
@@ -15364,7 +15585,7 @@ export const operations = [
|
|
|
15364
15585
|
"flag": "--inbound-webhook-url",
|
|
15365
15586
|
"required": false,
|
|
15366
15587
|
"type": "string",
|
|
15367
|
-
"description": "If set, Retell will send a webhook for inbound calls, where you can override the agent ID, set dynamic variables, reject the call, and configure other fields specific to that call.",
|
|
15588
|
+
"description": "If set, Retell will send a webhook for inbound calls, where you can override the agent ID, set dynamic variables, reject the call, and configure other fields specific to that call. Includes call_inbound.call_id for deduplication across HTTP retries. Early setup failures may not create a call history record.",
|
|
15368
15589
|
"example": "https://example.com/inbound-webhook",
|
|
15369
15590
|
"array": false,
|
|
15370
15591
|
"nullable": true,
|
|
@@ -15375,7 +15596,7 @@ export const operations = [
|
|
|
15375
15596
|
"flag": "--inbound-sms-webhook-url",
|
|
15376
15597
|
"required": false,
|
|
15377
15598
|
"type": "string",
|
|
15378
|
-
"description": "If set, Retell will send a webhook for inbound SMS, where you can override the agent ID, set dynamic variables, reject the SMS, and configure other fields specific to that chat.",
|
|
15599
|
+
"description": "If set, Retell will send a webhook for inbound SMS, where you can override the agent ID, set dynamic variables, reject the SMS, and configure other fields specific to that chat. Includes chat_inbound.chat_id for deduplication across HTTP retries. Early setup failures may not create a chat history record.",
|
|
15379
15600
|
"example": "https://example.com/inbound-sms-webhook",
|
|
15380
15601
|
"array": false,
|
|
15381
15602
|
"nullable": true,
|