Skip to content

Commit 5b13cb7

Browse files
🌿 ✨ [Scheduled] Update API Spec (#185)
* feat(openapi): add and update schemas for backoff plan, chat completion, and more * fix(openapi): replace HttpRequest with ApiRequest and add silenceTimeoutMessage * feat(openapi): add mipOptOut, acknowledgementPhrases, interruptionPhrases, and other improvements to the OpenAPI spec * feat(openapi): add pciEnabled and hook fields to schemas * fix(fern/apis/api/openapi.json): Add blocking boolean to tool call message configuration --------- Co-authored-by: fern-api[bot] <115122769+fern-api[bot]@users.noreply.github.com>
1 parent f44377b commit 5b13cb7

File tree

1 file changed

+64
-0
lines changed

1 file changed

+64
-0
lines changed

fern/apis/api/openapi.json

Lines changed: 64 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4296,6 +4296,12 @@
42964296
],
42974297
"description": "This message is triggered when the tool call starts.\n\nThis message is never triggered for async tools.\n\nIf this message is not provided, one of the default filler messages \"Hold on a sec\", \"One moment\", \"Just a sec\", \"Give me a moment\" or \"This'll just take a sec\" will be used."
42984298
},
4299+
"blocking": {
4300+
"type": "boolean",
4301+
"description": "This is an optional boolean that if true, the tool call will only trigger after the message is spoken. Default is false.\n\n@default false",
4302+
"example": false,
4303+
"default": false
4304+
},
42994305
"content": {
43004306
"type": "string",
43014307
"description": "This is the content that the assistant says when this message is triggered.",
@@ -11541,6 +11547,11 @@
1154111547
"description": "When this is enabled, no logs, recordings, or transcriptions will be stored. At the end of the call, you will still receive an end-of-call-report message to store on your server. Defaults to false.",
1154211548
"example": false
1154311549
},
11550+
"pciEnabled": {
11551+
"type": "boolean",
11552+
"description": "This field indicates that this assistant is dealing with the card holder data (and needs PCI compliance)",
11553+
"example": false
11554+
},
1154411555
"clientMessages": {
1154511556
"type": "array",
1154611557
"enum": [
@@ -12111,6 +12122,11 @@
1211112122
"description": "When this is enabled, no logs, recordings, or transcriptions will be stored. At the end of the call, you will still receive an end-of-call-report message to store on your server. Defaults to false.",
1211212123
"example": false
1211312124
},
12125+
"pciEnabled": {
12126+
"type": "boolean",
12127+
"description": "This field indicates that this assistant is dealing with the card holder data (and needs PCI compliance)",
12128+
"example": false
12129+
},
1211412130
"clientMessages": {
1211512131
"type": "array",
1211612132
"enum": [
@@ -13727,6 +13743,11 @@
1372713743
"description": "When this is enabled, no logs, recordings, or transcriptions will be stored. At the end of the call, you will still receive an end-of-call-report message to store on your server. Defaults to false.",
1372813744
"example": false
1372913745
},
13746+
"pciEnabled": {
13747+
"type": "boolean",
13748+
"description": "This field indicates that this assistant is dealing with the card holder data (and needs PCI compliance)",
13749+
"example": false
13750+
},
1373013751
"clientMessages": {
1373113752
"type": "array",
1373213753
"enum": [
@@ -14321,6 +14342,11 @@
1432114342
"description": "When this is enabled, no logs, recordings, or transcriptions will be stored. At the end of the call, you will still receive an end-of-call-report message to store on your server. Defaults to false.",
1432214343
"example": false
1432314344
},
14345+
"pciEnabled": {
14346+
"type": "boolean",
14347+
"description": "This field indicates that this assistant is dealing with the card holder data (and needs PCI compliance)",
14348+
"example": false
14349+
},
1432414350
"clientMessages": {
1432514351
"type": "array",
1432614352
"enum": [
@@ -19299,6 +19325,30 @@
1929919325
"name"
1930019326
]
1930119327
},
19328+
"Hook": {
19329+
"type": "object",
19330+
"properties": {
19331+
"on": {
19332+
"type": "string",
19333+
"enum": [
19334+
"task.start",
19335+
"task.output.confirmation",
19336+
"task.delayed"
19337+
],
19338+
"maxLength": 80
19339+
},
19340+
"do": {
19341+
"type": "array",
19342+
"items": {
19343+
"$ref": "#/components/schemas/Say"
19344+
}
19345+
}
19346+
},
19347+
"required": [
19348+
"on",
19349+
"do"
19350+
]
19351+
},
1930219352
"Gather": {
1930319353
"type": "object",
1930419354
"properties": {
@@ -19319,6 +19369,13 @@
1931919369
"type": "boolean",
1932019370
"description": "This is whether or not the workflow should read back the gathered data to the user, and ask about its correctness."
1932119371
},
19372+
"hooks": {
19373+
"description": "This is a list of hooks for a task.\nEach hook is a list of tasks to run on a trigger (such as on start, on failure, etc).\nOnly Say is supported for now.",
19374+
"type": "array",
19375+
"items": {
19376+
"$ref": "#/components/schemas/Hook"
19377+
}
19378+
},
1932219379
"maxRetries": {
1932319380
"type": "number",
1932419381
"description": "This is the number of times we should try to gather the information from the user before we failover to the fail path. An example of this would be a user refusing to give their phone number for privacy reasons, and then going down a different path on account of this"
@@ -19384,6 +19441,13 @@
1938419441
"background"
1938519442
]
1938619443
},
19444+
"hooks": {
19445+
"description": "This is a list of hooks for a task.\nEach hook is a list of tasks to run on a trigger (such as on start, on failure, etc).\nOnly Say is supported for now.",
19446+
"type": "array",
19447+
"items": {
19448+
"$ref": "#/components/schemas/Hook"
19449+
}
19450+
},
1938719451
"startTaskMessage": {
1938819452
"type": "string"
1938919453
},

0 commit comments

Comments
 (0)