@pyai/mcp 0.2.0 → 0.3.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/AGENT_GUIDE.md +47 -0
- package/README.md +81 -65
- package/dist/client.js +94 -52
- package/dist/extra-tools.js +150 -0
- package/dist/generated-tools.js +1473 -0
- package/dist/hosted.js +2 -0
- package/dist/http.js +35 -62
- package/dist/index.js +61 -58
- package/dist/rpc.js +3 -3
- package/dist/server.js +93 -0
- package/dist/tools.js +527 -82
- package/dist/workflows.js +127 -0
- package/package.json +23 -8
- package/server.json +30 -0
|
@@ -0,0 +1,1473 @@
|
|
|
1
|
+
// Generated from contracts/openapi.json by scripts/generate-tools.mjs.
|
|
2
|
+
export const API_TOOLS = [
|
|
3
|
+
{
|
|
4
|
+
"name": "list_agents",
|
|
5
|
+
"title": "List Agents",
|
|
6
|
+
"description": "List saved voice Agent profiles before creating or changing one.",
|
|
7
|
+
"inputSchema": {
|
|
8
|
+
"type": "object",
|
|
9
|
+
"properties": {},
|
|
10
|
+
"required": [],
|
|
11
|
+
"additionalProperties": false
|
|
12
|
+
},
|
|
13
|
+
"annotations": {
|
|
14
|
+
"readOnlyHint": true,
|
|
15
|
+
"destructiveHint": false,
|
|
16
|
+
"idempotentHint": true,
|
|
17
|
+
"openWorldHint": true
|
|
18
|
+
},
|
|
19
|
+
"route": {
|
|
20
|
+
"method": "GET",
|
|
21
|
+
"path": "/v1/agents",
|
|
22
|
+
"query": [],
|
|
23
|
+
"scope": "omni:session"
|
|
24
|
+
}
|
|
25
|
+
},
|
|
26
|
+
{
|
|
27
|
+
"name": "create_agent",
|
|
28
|
+
"title": "Create Agent",
|
|
29
|
+
"description": "Create a reusable voice Agent profile: persona, greeting, voice, language, tools and knowledge. Does not place a call.",
|
|
30
|
+
"inputSchema": {
|
|
31
|
+
"type": "object",
|
|
32
|
+
"properties": {
|
|
33
|
+
"body": {
|
|
34
|
+
"type": "object",
|
|
35
|
+
"description": "Writable agent fields. On update, present fields are set, `null` clears, absent fields are untouched.",
|
|
36
|
+
"properties": {
|
|
37
|
+
"name": {
|
|
38
|
+
"type": "string",
|
|
39
|
+
"maxLength": 200,
|
|
40
|
+
"description": "Display name. Required on create."
|
|
41
|
+
},
|
|
42
|
+
"persona_system_prompt": {
|
|
43
|
+
"type": [
|
|
44
|
+
"string",
|
|
45
|
+
"null"
|
|
46
|
+
],
|
|
47
|
+
"maxLength": 32000,
|
|
48
|
+
"description": "The agent's entire character, role, policies, and business context."
|
|
49
|
+
},
|
|
50
|
+
"role": {
|
|
51
|
+
"type": [
|
|
52
|
+
"string",
|
|
53
|
+
"null"
|
|
54
|
+
],
|
|
55
|
+
"enum": [
|
|
56
|
+
"receptionist",
|
|
57
|
+
"support",
|
|
58
|
+
"sales",
|
|
59
|
+
"collections",
|
|
60
|
+
"ea",
|
|
61
|
+
"concierge",
|
|
62
|
+
"custom",
|
|
63
|
+
null
|
|
64
|
+
],
|
|
65
|
+
"description": "Role archetype. Adds PyAI's role operating standard beneath your persona and derives the runtime mode (`receptionist`, `sales`, and `collections` enable their matching deterministic conversation guards; everything else runs the default mode). Your stored persona is unchanged and remains authoritative for identity and business policy. Null clears the role."
|
|
66
|
+
},
|
|
67
|
+
"greeting": {
|
|
68
|
+
"type": [
|
|
69
|
+
"string",
|
|
70
|
+
"null"
|
|
71
|
+
],
|
|
72
|
+
"maxLength": 1000,
|
|
73
|
+
"description": "Greeting message, opening line spoken at turn 0 when a call connects (before the caller speaks). Stored on the agent profile; played automatically when connecting with `session_label={agent_id}`. May also be sent inline in the Omni `configure` frame."
|
|
74
|
+
},
|
|
75
|
+
"greeting_variants": {
|
|
76
|
+
"type": [
|
|
77
|
+
"array",
|
|
78
|
+
"null"
|
|
79
|
+
],
|
|
80
|
+
"maxItems": 15,
|
|
81
|
+
"items": {
|
|
82
|
+
"type": "string",
|
|
83
|
+
"maxLength": 1000
|
|
84
|
+
},
|
|
85
|
+
"description": "Approved opening-line variants. PyAI selects one for each newly resolved call profile; null or empty falls back to greeting. Recording consent is fixed and never rotated."
|
|
86
|
+
},
|
|
87
|
+
"voice_id": {
|
|
88
|
+
"type": [
|
|
89
|
+
"string",
|
|
90
|
+
"null"
|
|
91
|
+
],
|
|
92
|
+
"description": "A stock `voice_id`, one of its permanent `aliases` from `GET /v1/voices`, or a cloned voice id. Omni reports the canonical served stock id in `configured.voice_id`."
|
|
93
|
+
},
|
|
94
|
+
"voice_instruct": {
|
|
95
|
+
"type": [
|
|
96
|
+
"string",
|
|
97
|
+
"null"
|
|
98
|
+
],
|
|
99
|
+
"maxLength": 200,
|
|
100
|
+
"description": "TTS delivery direction for this managed Agent on instruct-capable voice tiers. Omit or set null for PyAI's natural conversational pace; an inline Omni `configure.voice_instruct` wins for that session."
|
|
101
|
+
},
|
|
102
|
+
"brain_model": {
|
|
103
|
+
"type": [
|
|
104
|
+
"string",
|
|
105
|
+
"null"
|
|
106
|
+
],
|
|
107
|
+
"description": "Per-agent model selection. Omit for the platform default."
|
|
108
|
+
},
|
|
109
|
+
"barge_sensitivity": {
|
|
110
|
+
"type": [
|
|
111
|
+
"string",
|
|
112
|
+
"null"
|
|
113
|
+
],
|
|
114
|
+
"deprecated": true,
|
|
115
|
+
"description": "Deprecated compatibility field. Stored values are not applied to Omni runtime."
|
|
116
|
+
},
|
|
117
|
+
"ack_mode": {
|
|
118
|
+
"type": [
|
|
119
|
+
"string",
|
|
120
|
+
"null"
|
|
121
|
+
],
|
|
122
|
+
"deprecated": true,
|
|
123
|
+
"description": "Deprecated compatibility field. Stored values are not applied to Omni runtime."
|
|
124
|
+
},
|
|
125
|
+
"idle_check_in": {
|
|
126
|
+
"type": [
|
|
127
|
+
"string",
|
|
128
|
+
"null"
|
|
129
|
+
],
|
|
130
|
+
"enum": [
|
|
131
|
+
"auto",
|
|
132
|
+
"patient",
|
|
133
|
+
"off",
|
|
134
|
+
null
|
|
135
|
+
],
|
|
136
|
+
"description": "How patient the agent is before checking in on a silent caller (\"Sorry, are you still there?\"). `auto` checks in after a few seconds of silence; `patient` waits far longer, for callers who routinely think, read, or look something up mid-call; `off` disables the check-in entirely, so the agent stays silent until the caller speaks. When unset, most roles render `auto`; support agents render `patient`. Independent of `ack_mode`. May also be sent inline in the Omni `configure` frame, which wins for that session."
|
|
137
|
+
},
|
|
138
|
+
"persona_perspective": {
|
|
139
|
+
"type": [
|
|
140
|
+
"string",
|
|
141
|
+
"null"
|
|
142
|
+
],
|
|
143
|
+
"enum": [
|
|
144
|
+
"agent",
|
|
145
|
+
"caller",
|
|
146
|
+
null
|
|
147
|
+
],
|
|
148
|
+
"description": "Which side of the call the persona is on. `agent` (default) means the persona is the business being called, so PyAI adds its conversation layer for handling a caller (capability honesty, handoffs, turn discipline). `caller` means the persona is the individual on the call instead, as in QA and simulation callers, mystery shopping, or training partners; PyAI drops that operator-voice layer so it cannot contradict an inverted persona. May also be sent inline in the Omni `configure` frame, which wins for that session."
|
|
149
|
+
},
|
|
150
|
+
"recordings_enabled": {
|
|
151
|
+
"type": [
|
|
152
|
+
"boolean",
|
|
153
|
+
"null"
|
|
154
|
+
],
|
|
155
|
+
"description": "Enable stereo call recordings. Default false."
|
|
156
|
+
},
|
|
157
|
+
"consent_line": {
|
|
158
|
+
"type": [
|
|
159
|
+
"string",
|
|
160
|
+
"null"
|
|
161
|
+
],
|
|
162
|
+
"minLength": 10,
|
|
163
|
+
"maxLength": 500,
|
|
164
|
+
"description": "Recording disclosure spoken before recording starts when `recordings_enabled` is true. Required for compliance when recordings are on and must contain a meaningful spoken phrase (at least 10 characters and 5 letters). Playback order: consent_line, then greeting, then conversation."
|
|
165
|
+
},
|
|
166
|
+
"language": {
|
|
167
|
+
"type": [
|
|
168
|
+
"string",
|
|
169
|
+
"null"
|
|
170
|
+
],
|
|
171
|
+
"enum": [
|
|
172
|
+
"en",
|
|
173
|
+
"fr",
|
|
174
|
+
"es",
|
|
175
|
+
"de",
|
|
176
|
+
"hi",
|
|
177
|
+
null
|
|
178
|
+
],
|
|
179
|
+
"description": "Requested language for this Agent's Omni sessions. `null` or absent means `en`. Availability is staged: as of 2026-08-13 public serving is `en`, `fr`, `es`, and `hi`; `de` falls back to English. Inspect the session's `configured.language_active` and `language_fallback` fields before assuming the requested language is active. See the Language support reference."
|
|
180
|
+
},
|
|
181
|
+
"metadata": {
|
|
182
|
+
"type": [
|
|
183
|
+
"object",
|
|
184
|
+
"null"
|
|
185
|
+
],
|
|
186
|
+
"additionalProperties": {
|
|
187
|
+
"type": "string"
|
|
188
|
+
},
|
|
189
|
+
"description": "Up to 16 key/value annotations (keys ≤64 chars, values ≤512 chars)."
|
|
190
|
+
},
|
|
191
|
+
"vocabulary": {
|
|
192
|
+
"type": [
|
|
193
|
+
"array",
|
|
194
|
+
"null"
|
|
195
|
+
],
|
|
196
|
+
"maxItems": 5,
|
|
197
|
+
"items": {
|
|
198
|
+
"type": "string",
|
|
199
|
+
"minLength": 4,
|
|
200
|
+
"maxLength": 64
|
|
201
|
+
},
|
|
202
|
+
"description": "Optional custom vocabulary for this Agent's Omni speech recognition. A non-empty list is the opt-in. PyAI keeps at most five effective terms, with at most five words per term. It trims whitespace, deduplicates without regard to case while preserving the first spelling and order, and drops common-only phrases. Set `[]` or `null` to turn it off. The list is fixed when a session starts. Organization Hear vocabulary is never applied to Omni."
|
|
203
|
+
},
|
|
204
|
+
"keyterms": {
|
|
205
|
+
"type": [
|
|
206
|
+
"array",
|
|
207
|
+
"null"
|
|
208
|
+
],
|
|
209
|
+
"items": {
|
|
210
|
+
"type": "string"
|
|
211
|
+
},
|
|
212
|
+
"maxItems": 100,
|
|
213
|
+
"deprecated": true,
|
|
214
|
+
"description": "Deprecated stored compatibility field. It does not affect speech recognition. Use `vocabulary`."
|
|
215
|
+
},
|
|
216
|
+
"goals": {
|
|
217
|
+
"type": [
|
|
218
|
+
"array",
|
|
219
|
+
"null"
|
|
220
|
+
],
|
|
221
|
+
"items": {
|
|
222
|
+
"type": "string"
|
|
223
|
+
},
|
|
224
|
+
"maxItems": 20,
|
|
225
|
+
"description": "Goal checklist for post-call outcome scoring (stored now; scoring ships with summaries)."
|
|
226
|
+
},
|
|
227
|
+
"extraction_schema": {
|
|
228
|
+
"type": [
|
|
229
|
+
"object",
|
|
230
|
+
"null"
|
|
231
|
+
],
|
|
232
|
+
"additionalProperties": true,
|
|
233
|
+
"description": "JSON Schema of fields to capture from each completed call's transcript. When set with extraction_webhook_url, PyAI runs a post-call extraction pass and POSTs the structured JSON to your webhook (signed with X-PyAI-Signature). Null disables extraction."
|
|
234
|
+
},
|
|
235
|
+
"extraction_webhook_url": {
|
|
236
|
+
"type": [
|
|
237
|
+
"string",
|
|
238
|
+
"null"
|
|
239
|
+
],
|
|
240
|
+
"format": "uri",
|
|
241
|
+
"description": "HTTPS URL that receives the signed post-call extraction result (event `omni.call.extracted`). Requires extraction_schema. The call's agent is resolved from the connect-URL session_label when it equals this agent's id."
|
|
242
|
+
},
|
|
243
|
+
"tools": {
|
|
244
|
+
"type": [
|
|
245
|
+
"array",
|
|
246
|
+
"null"
|
|
247
|
+
],
|
|
248
|
+
"items": {
|
|
249
|
+
"type": "object",
|
|
250
|
+
"required": [
|
|
251
|
+
"tool_id"
|
|
252
|
+
],
|
|
253
|
+
"properties": {
|
|
254
|
+
"tool_id": {
|
|
255
|
+
"type": "string"
|
|
256
|
+
},
|
|
257
|
+
"enabled": {
|
|
258
|
+
"type": "boolean",
|
|
259
|
+
"default": true
|
|
260
|
+
},
|
|
261
|
+
"config": {
|
|
262
|
+
"type": "object",
|
|
263
|
+
"additionalProperties": true,
|
|
264
|
+
"description": "Customer SETTINGS for this tool on this agent, keyed by the tool's config_schema field keys (e.g. { from_number, provider_api_key }). Fields marked secret are encrypted at rest and returned masked ('********'); re-send the mask (or omit) to keep the stored value."
|
|
265
|
+
},
|
|
266
|
+
"name": {
|
|
267
|
+
"type": "string",
|
|
268
|
+
"description": "Present on agent reads when the tool resolves."
|
|
269
|
+
},
|
|
270
|
+
"description": {
|
|
271
|
+
"type": "string"
|
|
272
|
+
},
|
|
273
|
+
"input_schema": {
|
|
274
|
+
"type": "object",
|
|
275
|
+
"additionalProperties": true,
|
|
276
|
+
"description": "Per-call model argument schema. Present on agent reads when the tool resolves."
|
|
277
|
+
},
|
|
278
|
+
"execution": {
|
|
279
|
+
"type": "string",
|
|
280
|
+
"enum": [
|
|
281
|
+
"hosted",
|
|
282
|
+
"server",
|
|
283
|
+
"engine",
|
|
284
|
+
"client"
|
|
285
|
+
],
|
|
286
|
+
"description": "Resolved execution mode. Present on agent reads when the tool resolves."
|
|
287
|
+
}
|
|
288
|
+
}
|
|
289
|
+
},
|
|
290
|
+
"description": "Tool bindings for this agent profile (references tools from `GET /v1/tools`). Omni `configure.tools[]` may list hosted catalog names or client-loop schemas; server webhooks must be registered here. An inline configure `endpoint` is not supported."
|
|
291
|
+
},
|
|
292
|
+
"continuity": {
|
|
293
|
+
"type": [
|
|
294
|
+
"boolean",
|
|
295
|
+
"null"
|
|
296
|
+
],
|
|
297
|
+
"description": "Reuse a tiny caller card on the next call when PyAI can resolve the caller (phone number or a signed customer id). The card is advisory — the agent may recall a name or open thread, and must not refund, book, or transfer from it. Default false."
|
|
298
|
+
}
|
|
299
|
+
}
|
|
300
|
+
}
|
|
301
|
+
},
|
|
302
|
+
"required": [
|
|
303
|
+
"body"
|
|
304
|
+
],
|
|
305
|
+
"additionalProperties": false
|
|
306
|
+
},
|
|
307
|
+
"annotations": {
|
|
308
|
+
"readOnlyHint": false,
|
|
309
|
+
"destructiveHint": false,
|
|
310
|
+
"idempotentHint": false,
|
|
311
|
+
"openWorldHint": true
|
|
312
|
+
},
|
|
313
|
+
"route": {
|
|
314
|
+
"method": "POST",
|
|
315
|
+
"path": "/v1/agents",
|
|
316
|
+
"query": [],
|
|
317
|
+
"scope": "omni:session"
|
|
318
|
+
}
|
|
319
|
+
},
|
|
320
|
+
{
|
|
321
|
+
"name": "get_agent",
|
|
322
|
+
"title": "Get Agent",
|
|
323
|
+
"description": "Read a saved voice Agent profile and its current configuration.",
|
|
324
|
+
"inputSchema": {
|
|
325
|
+
"type": "object",
|
|
326
|
+
"properties": {
|
|
327
|
+
"id": {
|
|
328
|
+
"type": "string",
|
|
329
|
+
"description": "Agent id, e.g. `agent_7f3a…`."
|
|
330
|
+
}
|
|
331
|
+
},
|
|
332
|
+
"required": [
|
|
333
|
+
"id"
|
|
334
|
+
],
|
|
335
|
+
"additionalProperties": false
|
|
336
|
+
},
|
|
337
|
+
"annotations": {
|
|
338
|
+
"readOnlyHint": true,
|
|
339
|
+
"destructiveHint": false,
|
|
340
|
+
"idempotentHint": true,
|
|
341
|
+
"openWorldHint": true
|
|
342
|
+
},
|
|
343
|
+
"route": {
|
|
344
|
+
"method": "GET",
|
|
345
|
+
"path": "/v1/agents/{id}",
|
|
346
|
+
"query": [],
|
|
347
|
+
"scope": "omni:session"
|
|
348
|
+
}
|
|
349
|
+
},
|
|
350
|
+
{
|
|
351
|
+
"name": "update_agent",
|
|
352
|
+
"title": "Update Agent",
|
|
353
|
+
"description": "Update a voice Agent profile. Read it first and change only user-requested fields.",
|
|
354
|
+
"inputSchema": {
|
|
355
|
+
"type": "object",
|
|
356
|
+
"properties": {
|
|
357
|
+
"id": {
|
|
358
|
+
"type": "string"
|
|
359
|
+
},
|
|
360
|
+
"body": {
|
|
361
|
+
"type": "object",
|
|
362
|
+
"description": "Writable agent fields. On update, present fields are set, `null` clears, absent fields are untouched.",
|
|
363
|
+
"properties": {
|
|
364
|
+
"name": {
|
|
365
|
+
"type": "string",
|
|
366
|
+
"maxLength": 200,
|
|
367
|
+
"description": "Display name. Required on create."
|
|
368
|
+
},
|
|
369
|
+
"persona_system_prompt": {
|
|
370
|
+
"type": [
|
|
371
|
+
"string",
|
|
372
|
+
"null"
|
|
373
|
+
],
|
|
374
|
+
"maxLength": 32000,
|
|
375
|
+
"description": "The agent's entire character, role, policies, and business context."
|
|
376
|
+
},
|
|
377
|
+
"role": {
|
|
378
|
+
"type": [
|
|
379
|
+
"string",
|
|
380
|
+
"null"
|
|
381
|
+
],
|
|
382
|
+
"enum": [
|
|
383
|
+
"receptionist",
|
|
384
|
+
"support",
|
|
385
|
+
"sales",
|
|
386
|
+
"collections",
|
|
387
|
+
"ea",
|
|
388
|
+
"concierge",
|
|
389
|
+
"custom",
|
|
390
|
+
null
|
|
391
|
+
],
|
|
392
|
+
"description": "Role archetype. Adds PyAI's role operating standard beneath your persona and derives the runtime mode (`receptionist`, `sales`, and `collections` enable their matching deterministic conversation guards; everything else runs the default mode). Your stored persona is unchanged and remains authoritative for identity and business policy. Null clears the role."
|
|
393
|
+
},
|
|
394
|
+
"greeting": {
|
|
395
|
+
"type": [
|
|
396
|
+
"string",
|
|
397
|
+
"null"
|
|
398
|
+
],
|
|
399
|
+
"maxLength": 1000,
|
|
400
|
+
"description": "Greeting message, opening line spoken at turn 0 when a call connects (before the caller speaks). Stored on the agent profile; played automatically when connecting with `session_label={agent_id}`. May also be sent inline in the Omni `configure` frame."
|
|
401
|
+
},
|
|
402
|
+
"greeting_variants": {
|
|
403
|
+
"type": [
|
|
404
|
+
"array",
|
|
405
|
+
"null"
|
|
406
|
+
],
|
|
407
|
+
"maxItems": 15,
|
|
408
|
+
"items": {
|
|
409
|
+
"type": "string",
|
|
410
|
+
"maxLength": 1000
|
|
411
|
+
},
|
|
412
|
+
"description": "Approved opening-line variants. PyAI selects one for each newly resolved call profile; null or empty falls back to greeting. Recording consent is fixed and never rotated."
|
|
413
|
+
},
|
|
414
|
+
"voice_id": {
|
|
415
|
+
"type": [
|
|
416
|
+
"string",
|
|
417
|
+
"null"
|
|
418
|
+
],
|
|
419
|
+
"description": "A stock `voice_id`, one of its permanent `aliases` from `GET /v1/voices`, or a cloned voice id. Omni reports the canonical served stock id in `configured.voice_id`."
|
|
420
|
+
},
|
|
421
|
+
"voice_instruct": {
|
|
422
|
+
"type": [
|
|
423
|
+
"string",
|
|
424
|
+
"null"
|
|
425
|
+
],
|
|
426
|
+
"maxLength": 200,
|
|
427
|
+
"description": "TTS delivery direction for this managed Agent on instruct-capable voice tiers. Omit or set null for PyAI's natural conversational pace; an inline Omni `configure.voice_instruct` wins for that session."
|
|
428
|
+
},
|
|
429
|
+
"brain_model": {
|
|
430
|
+
"type": [
|
|
431
|
+
"string",
|
|
432
|
+
"null"
|
|
433
|
+
],
|
|
434
|
+
"description": "Per-agent model selection. Omit for the platform default."
|
|
435
|
+
},
|
|
436
|
+
"barge_sensitivity": {
|
|
437
|
+
"type": [
|
|
438
|
+
"string",
|
|
439
|
+
"null"
|
|
440
|
+
],
|
|
441
|
+
"deprecated": true,
|
|
442
|
+
"description": "Deprecated compatibility field. Stored values are not applied to Omni runtime."
|
|
443
|
+
},
|
|
444
|
+
"ack_mode": {
|
|
445
|
+
"type": [
|
|
446
|
+
"string",
|
|
447
|
+
"null"
|
|
448
|
+
],
|
|
449
|
+
"deprecated": true,
|
|
450
|
+
"description": "Deprecated compatibility field. Stored values are not applied to Omni runtime."
|
|
451
|
+
},
|
|
452
|
+
"idle_check_in": {
|
|
453
|
+
"type": [
|
|
454
|
+
"string",
|
|
455
|
+
"null"
|
|
456
|
+
],
|
|
457
|
+
"enum": [
|
|
458
|
+
"auto",
|
|
459
|
+
"patient",
|
|
460
|
+
"off",
|
|
461
|
+
null
|
|
462
|
+
],
|
|
463
|
+
"description": "How patient the agent is before checking in on a silent caller (\"Sorry, are you still there?\"). `auto` checks in after a few seconds of silence; `patient` waits far longer, for callers who routinely think, read, or look something up mid-call; `off` disables the check-in entirely, so the agent stays silent until the caller speaks. When unset, most roles render `auto`; support agents render `patient`. Independent of `ack_mode`. May also be sent inline in the Omni `configure` frame, which wins for that session."
|
|
464
|
+
},
|
|
465
|
+
"persona_perspective": {
|
|
466
|
+
"type": [
|
|
467
|
+
"string",
|
|
468
|
+
"null"
|
|
469
|
+
],
|
|
470
|
+
"enum": [
|
|
471
|
+
"agent",
|
|
472
|
+
"caller",
|
|
473
|
+
null
|
|
474
|
+
],
|
|
475
|
+
"description": "Which side of the call the persona is on. `agent` (default) means the persona is the business being called, so PyAI adds its conversation layer for handling a caller (capability honesty, handoffs, turn discipline). `caller` means the persona is the individual on the call instead, as in QA and simulation callers, mystery shopping, or training partners; PyAI drops that operator-voice layer so it cannot contradict an inverted persona. May also be sent inline in the Omni `configure` frame, which wins for that session."
|
|
476
|
+
},
|
|
477
|
+
"recordings_enabled": {
|
|
478
|
+
"type": [
|
|
479
|
+
"boolean",
|
|
480
|
+
"null"
|
|
481
|
+
],
|
|
482
|
+
"description": "Enable stereo call recordings. Default false."
|
|
483
|
+
},
|
|
484
|
+
"consent_line": {
|
|
485
|
+
"type": [
|
|
486
|
+
"string",
|
|
487
|
+
"null"
|
|
488
|
+
],
|
|
489
|
+
"minLength": 10,
|
|
490
|
+
"maxLength": 500,
|
|
491
|
+
"description": "Recording disclosure spoken before recording starts when `recordings_enabled` is true. Required for compliance when recordings are on and must contain a meaningful spoken phrase (at least 10 characters and 5 letters). Playback order: consent_line, then greeting, then conversation."
|
|
492
|
+
},
|
|
493
|
+
"language": {
|
|
494
|
+
"type": [
|
|
495
|
+
"string",
|
|
496
|
+
"null"
|
|
497
|
+
],
|
|
498
|
+
"enum": [
|
|
499
|
+
"en",
|
|
500
|
+
"fr",
|
|
501
|
+
"es",
|
|
502
|
+
"de",
|
|
503
|
+
"hi",
|
|
504
|
+
null
|
|
505
|
+
],
|
|
506
|
+
"description": "Requested language for this Agent's Omni sessions. `null` or absent means `en`. Availability is staged: as of 2026-08-13 public serving is `en`, `fr`, `es`, and `hi`; `de` falls back to English. Inspect the session's `configured.language_active` and `language_fallback` fields before assuming the requested language is active. See the Language support reference."
|
|
507
|
+
},
|
|
508
|
+
"metadata": {
|
|
509
|
+
"type": [
|
|
510
|
+
"object",
|
|
511
|
+
"null"
|
|
512
|
+
],
|
|
513
|
+
"additionalProperties": {
|
|
514
|
+
"type": "string"
|
|
515
|
+
},
|
|
516
|
+
"description": "Up to 16 key/value annotations (keys ≤64 chars, values ≤512 chars)."
|
|
517
|
+
},
|
|
518
|
+
"vocabulary": {
|
|
519
|
+
"type": [
|
|
520
|
+
"array",
|
|
521
|
+
"null"
|
|
522
|
+
],
|
|
523
|
+
"maxItems": 5,
|
|
524
|
+
"items": {
|
|
525
|
+
"type": "string",
|
|
526
|
+
"minLength": 4,
|
|
527
|
+
"maxLength": 64
|
|
528
|
+
},
|
|
529
|
+
"description": "Optional custom vocabulary for this Agent's Omni speech recognition. A non-empty list is the opt-in. PyAI keeps at most five effective terms, with at most five words per term. It trims whitespace, deduplicates without regard to case while preserving the first spelling and order, and drops common-only phrases. Set `[]` or `null` to turn it off. The list is fixed when a session starts. Organization Hear vocabulary is never applied to Omni."
|
|
530
|
+
},
|
|
531
|
+
"keyterms": {
|
|
532
|
+
"type": [
|
|
533
|
+
"array",
|
|
534
|
+
"null"
|
|
535
|
+
],
|
|
536
|
+
"items": {
|
|
537
|
+
"type": "string"
|
|
538
|
+
},
|
|
539
|
+
"maxItems": 100,
|
|
540
|
+
"deprecated": true,
|
|
541
|
+
"description": "Deprecated stored compatibility field. It does not affect speech recognition. Use `vocabulary`."
|
|
542
|
+
},
|
|
543
|
+
"goals": {
|
|
544
|
+
"type": [
|
|
545
|
+
"array",
|
|
546
|
+
"null"
|
|
547
|
+
],
|
|
548
|
+
"items": {
|
|
549
|
+
"type": "string"
|
|
550
|
+
},
|
|
551
|
+
"maxItems": 20,
|
|
552
|
+
"description": "Goal checklist for post-call outcome scoring (stored now; scoring ships with summaries)."
|
|
553
|
+
},
|
|
554
|
+
"extraction_schema": {
|
|
555
|
+
"type": [
|
|
556
|
+
"object",
|
|
557
|
+
"null"
|
|
558
|
+
],
|
|
559
|
+
"additionalProperties": true,
|
|
560
|
+
"description": "JSON Schema of fields to capture from each completed call's transcript. When set with extraction_webhook_url, PyAI runs a post-call extraction pass and POSTs the structured JSON to your webhook (signed with X-PyAI-Signature). Null disables extraction."
|
|
561
|
+
},
|
|
562
|
+
"extraction_webhook_url": {
|
|
563
|
+
"type": [
|
|
564
|
+
"string",
|
|
565
|
+
"null"
|
|
566
|
+
],
|
|
567
|
+
"format": "uri",
|
|
568
|
+
"description": "HTTPS URL that receives the signed post-call extraction result (event `omni.call.extracted`). Requires extraction_schema. The call's agent is resolved from the connect-URL session_label when it equals this agent's id."
|
|
569
|
+
},
|
|
570
|
+
"tools": {
|
|
571
|
+
"type": [
|
|
572
|
+
"array",
|
|
573
|
+
"null"
|
|
574
|
+
],
|
|
575
|
+
"items": {
|
|
576
|
+
"type": "object",
|
|
577
|
+
"required": [
|
|
578
|
+
"tool_id"
|
|
579
|
+
],
|
|
580
|
+
"properties": {
|
|
581
|
+
"tool_id": {
|
|
582
|
+
"type": "string"
|
|
583
|
+
},
|
|
584
|
+
"enabled": {
|
|
585
|
+
"type": "boolean",
|
|
586
|
+
"default": true
|
|
587
|
+
},
|
|
588
|
+
"config": {
|
|
589
|
+
"type": "object",
|
|
590
|
+
"additionalProperties": true,
|
|
591
|
+
"description": "Customer SETTINGS for this tool on this agent, keyed by the tool's config_schema field keys (e.g. { from_number, provider_api_key }). Fields marked secret are encrypted at rest and returned masked ('********'); re-send the mask (or omit) to keep the stored value."
|
|
592
|
+
},
|
|
593
|
+
"name": {
|
|
594
|
+
"type": "string",
|
|
595
|
+
"description": "Present on agent reads when the tool resolves."
|
|
596
|
+
},
|
|
597
|
+
"description": {
|
|
598
|
+
"type": "string"
|
|
599
|
+
},
|
|
600
|
+
"input_schema": {
|
|
601
|
+
"type": "object",
|
|
602
|
+
"additionalProperties": true,
|
|
603
|
+
"description": "Per-call model argument schema. Present on agent reads when the tool resolves."
|
|
604
|
+
},
|
|
605
|
+
"execution": {
|
|
606
|
+
"type": "string",
|
|
607
|
+
"enum": [
|
|
608
|
+
"hosted",
|
|
609
|
+
"server",
|
|
610
|
+
"engine",
|
|
611
|
+
"client"
|
|
612
|
+
],
|
|
613
|
+
"description": "Resolved execution mode. Present on agent reads when the tool resolves."
|
|
614
|
+
}
|
|
615
|
+
}
|
|
616
|
+
},
|
|
617
|
+
"description": "Tool bindings for this agent profile (references tools from `GET /v1/tools`). Omni `configure.tools[]` may list hosted catalog names or client-loop schemas; server webhooks must be registered here. An inline configure `endpoint` is not supported."
|
|
618
|
+
},
|
|
619
|
+
"continuity": {
|
|
620
|
+
"type": [
|
|
621
|
+
"boolean",
|
|
622
|
+
"null"
|
|
623
|
+
],
|
|
624
|
+
"description": "Reuse a tiny caller card on the next call when PyAI can resolve the caller (phone number or a signed customer id). The card is advisory — the agent may recall a name or open thread, and must not refund, book, or transfer from it. Default false."
|
|
625
|
+
}
|
|
626
|
+
}
|
|
627
|
+
}
|
|
628
|
+
},
|
|
629
|
+
"required": [
|
|
630
|
+
"id",
|
|
631
|
+
"body"
|
|
632
|
+
],
|
|
633
|
+
"additionalProperties": false
|
|
634
|
+
},
|
|
635
|
+
"annotations": {
|
|
636
|
+
"readOnlyHint": false,
|
|
637
|
+
"destructiveHint": false,
|
|
638
|
+
"idempotentHint": false,
|
|
639
|
+
"openWorldHint": true
|
|
640
|
+
},
|
|
641
|
+
"route": {
|
|
642
|
+
"method": "POST",
|
|
643
|
+
"path": "/v1/agents/{id}",
|
|
644
|
+
"query": [],
|
|
645
|
+
"scope": "omni:session"
|
|
646
|
+
}
|
|
647
|
+
},
|
|
648
|
+
{
|
|
649
|
+
"name": "set_agent_tools",
|
|
650
|
+
"title": "Set Agent Tools",
|
|
651
|
+
"description": "Replace the tools bound to an Agent. Read the current Agent first; this replaces its bindings.",
|
|
652
|
+
"inputSchema": {
|
|
653
|
+
"type": "object",
|
|
654
|
+
"properties": {
|
|
655
|
+
"id": {
|
|
656
|
+
"type": "string"
|
|
657
|
+
},
|
|
658
|
+
"body": {
|
|
659
|
+
"type": "array",
|
|
660
|
+
"items": {
|
|
661
|
+
"type": "object",
|
|
662
|
+
"required": [
|
|
663
|
+
"tool_id"
|
|
664
|
+
],
|
|
665
|
+
"properties": {
|
|
666
|
+
"tool_id": {
|
|
667
|
+
"type": "string"
|
|
668
|
+
},
|
|
669
|
+
"enabled": {
|
|
670
|
+
"type": "boolean",
|
|
671
|
+
"default": true
|
|
672
|
+
},
|
|
673
|
+
"config": {
|
|
674
|
+
"type": "object",
|
|
675
|
+
"additionalProperties": true,
|
|
676
|
+
"description": "Customer SETTINGS for this tool on this agent, keyed by the tool's config_schema field keys (e.g. { from_number, provider_api_key }). Fields marked secret are encrypted at rest and returned masked ('********'); re-send the mask (or omit) to keep the stored value."
|
|
677
|
+
},
|
|
678
|
+
"name": {
|
|
679
|
+
"type": "string",
|
|
680
|
+
"description": "Present on agent reads when the tool resolves."
|
|
681
|
+
},
|
|
682
|
+
"description": {
|
|
683
|
+
"type": "string"
|
|
684
|
+
},
|
|
685
|
+
"input_schema": {
|
|
686
|
+
"type": "object",
|
|
687
|
+
"additionalProperties": true,
|
|
688
|
+
"description": "Per-call model argument schema. Present on agent reads when the tool resolves."
|
|
689
|
+
},
|
|
690
|
+
"execution": {
|
|
691
|
+
"type": "string",
|
|
692
|
+
"enum": [
|
|
693
|
+
"hosted",
|
|
694
|
+
"server",
|
|
695
|
+
"engine",
|
|
696
|
+
"client"
|
|
697
|
+
],
|
|
698
|
+
"description": "Resolved execution mode. Present on agent reads when the tool resolves."
|
|
699
|
+
}
|
|
700
|
+
}
|
|
701
|
+
}
|
|
702
|
+
}
|
|
703
|
+
},
|
|
704
|
+
"required": [
|
|
705
|
+
"id",
|
|
706
|
+
"body"
|
|
707
|
+
],
|
|
708
|
+
"additionalProperties": false
|
|
709
|
+
},
|
|
710
|
+
"annotations": {
|
|
711
|
+
"readOnlyHint": false,
|
|
712
|
+
"destructiveHint": true,
|
|
713
|
+
"idempotentHint": true,
|
|
714
|
+
"openWorldHint": true
|
|
715
|
+
},
|
|
716
|
+
"route": {
|
|
717
|
+
"method": "PUT",
|
|
718
|
+
"path": "/v1/agents/{id}/tools",
|
|
719
|
+
"query": [],
|
|
720
|
+
"scope": "omni:session"
|
|
721
|
+
}
|
|
722
|
+
},
|
|
723
|
+
{
|
|
724
|
+
"name": "set_agent_knowledge",
|
|
725
|
+
"title": "Set Agent Knowledge",
|
|
726
|
+
"description": "Replace the knowledge bases bound to an Agent. Read its existing bindings first.",
|
|
727
|
+
"inputSchema": {
|
|
728
|
+
"type": "object",
|
|
729
|
+
"properties": {
|
|
730
|
+
"id": {
|
|
731
|
+
"type": "string"
|
|
732
|
+
},
|
|
733
|
+
"body": {
|
|
734
|
+
"type": "array",
|
|
735
|
+
"items": {
|
|
736
|
+
"type": "object",
|
|
737
|
+
"required": [
|
|
738
|
+
"kb_id"
|
|
739
|
+
],
|
|
740
|
+
"properties": {
|
|
741
|
+
"kb_id": {
|
|
742
|
+
"type": "string",
|
|
743
|
+
"description": "Knowledge base id."
|
|
744
|
+
},
|
|
745
|
+
"weight": {
|
|
746
|
+
"type": "number",
|
|
747
|
+
"default": 1,
|
|
748
|
+
"description": "Retrieval weight relative to other bound bases."
|
|
749
|
+
}
|
|
750
|
+
}
|
|
751
|
+
}
|
|
752
|
+
}
|
|
753
|
+
},
|
|
754
|
+
"required": [
|
|
755
|
+
"id",
|
|
756
|
+
"body"
|
|
757
|
+
],
|
|
758
|
+
"additionalProperties": false
|
|
759
|
+
},
|
|
760
|
+
"annotations": {
|
|
761
|
+
"readOnlyHint": false,
|
|
762
|
+
"destructiveHint": true,
|
|
763
|
+
"idempotentHint": true,
|
|
764
|
+
"openWorldHint": true
|
|
765
|
+
},
|
|
766
|
+
"route": {
|
|
767
|
+
"method": "PUT",
|
|
768
|
+
"path": "/v1/agents/{id}/knowledgebases",
|
|
769
|
+
"query": [],
|
|
770
|
+
"scope": "omni:session"
|
|
771
|
+
}
|
|
772
|
+
},
|
|
773
|
+
{
|
|
774
|
+
"name": "get_trace_config",
|
|
775
|
+
"title": "Get Trace Config",
|
|
776
|
+
"description": "Inspect Trace call-compliance configuration.",
|
|
777
|
+
"inputSchema": {
|
|
778
|
+
"type": "object",
|
|
779
|
+
"properties": {
|
|
780
|
+
"agent_id": {
|
|
781
|
+
"type": "string",
|
|
782
|
+
"description": "Agent to read config for; omit for the org default."
|
|
783
|
+
}
|
|
784
|
+
},
|
|
785
|
+
"required": [],
|
|
786
|
+
"additionalProperties": false
|
|
787
|
+
},
|
|
788
|
+
"annotations": {
|
|
789
|
+
"readOnlyHint": true,
|
|
790
|
+
"destructiveHint": false,
|
|
791
|
+
"idempotentHint": true,
|
|
792
|
+
"openWorldHint": true
|
|
793
|
+
},
|
|
794
|
+
"route": {
|
|
795
|
+
"method": "GET",
|
|
796
|
+
"path": "/v1/trace/config",
|
|
797
|
+
"query": [
|
|
798
|
+
"agent_id"
|
|
799
|
+
],
|
|
800
|
+
"scope": "trace:configure"
|
|
801
|
+
}
|
|
802
|
+
},
|
|
803
|
+
{
|
|
804
|
+
"name": "configure_trace",
|
|
805
|
+
"title": "Configure Trace",
|
|
806
|
+
"description": "Configure Trace compliance monitoring for the selected workspace.",
|
|
807
|
+
"inputSchema": {
|
|
808
|
+
"type": "object",
|
|
809
|
+
"properties": {
|
|
810
|
+
"body": {
|
|
811
|
+
"type": "object",
|
|
812
|
+
"description": "Per-agent Trace config (spec §5.1). May be wrapped as { agent_id, config } or sent raw.",
|
|
813
|
+
"properties": {
|
|
814
|
+
"agent_id": {
|
|
815
|
+
"type": "string",
|
|
816
|
+
"description": "Agent to configure; omit for the org-wide default."
|
|
817
|
+
},
|
|
818
|
+
"enabled": {
|
|
819
|
+
"type": "boolean",
|
|
820
|
+
"default": false
|
|
821
|
+
},
|
|
822
|
+
"channels": {
|
|
823
|
+
"type": "array",
|
|
824
|
+
"items": {
|
|
825
|
+
"type": "string",
|
|
826
|
+
"enum": [
|
|
827
|
+
"voice",
|
|
828
|
+
"text"
|
|
829
|
+
]
|
|
830
|
+
},
|
|
831
|
+
"default": [
|
|
832
|
+
"voice"
|
|
833
|
+
]
|
|
834
|
+
},
|
|
835
|
+
"rule_packs": {
|
|
836
|
+
"type": "object",
|
|
837
|
+
"additionalProperties": {
|
|
838
|
+
"type": "object",
|
|
839
|
+
"properties": {
|
|
840
|
+
"enabled": {
|
|
841
|
+
"type": "boolean"
|
|
842
|
+
},
|
|
843
|
+
"version": {
|
|
844
|
+
"type": "string",
|
|
845
|
+
"nullable": true
|
|
846
|
+
}
|
|
847
|
+
}
|
|
848
|
+
},
|
|
849
|
+
"description": "Map of pack_id → { enabled, version }, e.g. { tcpa: { enabled: true } }."
|
|
850
|
+
},
|
|
851
|
+
"guardrails": {
|
|
852
|
+
"type": "object",
|
|
853
|
+
"description": "Inline guardrails compiled into a synthesized rule pack (spec §5.1).",
|
|
854
|
+
"properties": {
|
|
855
|
+
"mode": {
|
|
856
|
+
"type": "string",
|
|
857
|
+
"enum": [
|
|
858
|
+
"warn",
|
|
859
|
+
"modify",
|
|
860
|
+
"block",
|
|
861
|
+
"human_handoff"
|
|
862
|
+
],
|
|
863
|
+
"default": "warn",
|
|
864
|
+
"description": "warn = log only (never blocks); modify = redact/inject; block = suppress; human_handoff = escalate."
|
|
865
|
+
},
|
|
866
|
+
"block_pii": {
|
|
867
|
+
"type": "object",
|
|
868
|
+
"properties": {
|
|
869
|
+
"patterns": {
|
|
870
|
+
"type": "array",
|
|
871
|
+
"items": {
|
|
872
|
+
"type": "string",
|
|
873
|
+
"enum": [
|
|
874
|
+
"ssn",
|
|
875
|
+
"credit_card",
|
|
876
|
+
"email",
|
|
877
|
+
"us_phone"
|
|
878
|
+
]
|
|
879
|
+
},
|
|
880
|
+
"description": "Deterministically-redactable PII (context-dependent PII like DOB is Tier-2, not inline)."
|
|
881
|
+
}
|
|
882
|
+
}
|
|
883
|
+
},
|
|
884
|
+
"mandatory_disclosures": {
|
|
885
|
+
"type": "array",
|
|
886
|
+
"items": {
|
|
887
|
+
"type": "object",
|
|
888
|
+
"required": [
|
|
889
|
+
"text"
|
|
890
|
+
],
|
|
891
|
+
"properties": {
|
|
892
|
+
"text": {
|
|
893
|
+
"type": "string",
|
|
894
|
+
"description": "Phrase the agent must speak, e.g. an AI / recording disclosure."
|
|
895
|
+
},
|
|
896
|
+
"trigger": {
|
|
897
|
+
"type": "string",
|
|
898
|
+
"enum": [
|
|
899
|
+
"call_start",
|
|
900
|
+
"any"
|
|
901
|
+
],
|
|
902
|
+
"description": "call_start = must appear on the first agent turn."
|
|
903
|
+
},
|
|
904
|
+
"required_within_seconds": {
|
|
905
|
+
"type": "number",
|
|
906
|
+
"description": "Deadline in seconds; otherwise a 2-turn default applies."
|
|
907
|
+
}
|
|
908
|
+
}
|
|
909
|
+
}
|
|
910
|
+
},
|
|
911
|
+
"blocked_phrases": {
|
|
912
|
+
"type": "array",
|
|
913
|
+
"items": {
|
|
914
|
+
"type": "string"
|
|
915
|
+
},
|
|
916
|
+
"description": "Phrases the agent must never say."
|
|
917
|
+
},
|
|
918
|
+
"fail_open": {
|
|
919
|
+
"type": "boolean",
|
|
920
|
+
"default": true,
|
|
921
|
+
"description": "Trace down must never make a call worse, log 'unavailable' instead of blocking."
|
|
922
|
+
},
|
|
923
|
+
"inline_timeout_ms": {
|
|
924
|
+
"type": "number",
|
|
925
|
+
"default": 10,
|
|
926
|
+
"description": "Inline budget; the in-process gate is ~14µs p99, far under this."
|
|
927
|
+
}
|
|
928
|
+
}
|
|
929
|
+
}
|
|
930
|
+
}
|
|
931
|
+
}
|
|
932
|
+
},
|
|
933
|
+
"required": [
|
|
934
|
+
"body"
|
|
935
|
+
],
|
|
936
|
+
"additionalProperties": false
|
|
937
|
+
},
|
|
938
|
+
"annotations": {
|
|
939
|
+
"readOnlyHint": false,
|
|
940
|
+
"destructiveHint": true,
|
|
941
|
+
"idempotentHint": true,
|
|
942
|
+
"openWorldHint": true
|
|
943
|
+
},
|
|
944
|
+
"route": {
|
|
945
|
+
"method": "PUT",
|
|
946
|
+
"path": "/v1/trace/config",
|
|
947
|
+
"query": [],
|
|
948
|
+
"scope": "trace:configure"
|
|
949
|
+
}
|
|
950
|
+
},
|
|
951
|
+
{
|
|
952
|
+
"name": "list_trace_rule_packs",
|
|
953
|
+
"title": "List Trace Rule Packs",
|
|
954
|
+
"description": "Discover available Trace compliance rule packs before enabling monitoring.",
|
|
955
|
+
"inputSchema": {
|
|
956
|
+
"type": "object",
|
|
957
|
+
"properties": {},
|
|
958
|
+
"required": [],
|
|
959
|
+
"additionalProperties": false
|
|
960
|
+
},
|
|
961
|
+
"annotations": {
|
|
962
|
+
"readOnlyHint": true,
|
|
963
|
+
"destructiveHint": false,
|
|
964
|
+
"idempotentHint": true,
|
|
965
|
+
"openWorldHint": true
|
|
966
|
+
},
|
|
967
|
+
"route": {
|
|
968
|
+
"method": "GET",
|
|
969
|
+
"path": "/v1/trace/rule-packs",
|
|
970
|
+
"query": [],
|
|
971
|
+
"scope": "trace:configure"
|
|
972
|
+
}
|
|
973
|
+
},
|
|
974
|
+
{
|
|
975
|
+
"name": "create_trace_rule_pack",
|
|
976
|
+
"title": "Create Trace Rule Pack",
|
|
977
|
+
"description": "Create a workspace Trace compliance rule pack. This creates persistent configuration.",
|
|
978
|
+
"inputSchema": {
|
|
979
|
+
"type": "object",
|
|
980
|
+
"properties": {
|
|
981
|
+
"body": {
|
|
982
|
+
"type": "object",
|
|
983
|
+
"required": [
|
|
984
|
+
"pack_id",
|
|
985
|
+
"version",
|
|
986
|
+
"rules"
|
|
987
|
+
],
|
|
988
|
+
"description": "An authored rule pack in the Trace DSL (rule_pack_schema.json).",
|
|
989
|
+
"properties": {
|
|
990
|
+
"pack_id": {
|
|
991
|
+
"type": "string",
|
|
992
|
+
"pattern": "^[a-z0-9_]+$"
|
|
993
|
+
},
|
|
994
|
+
"version": {
|
|
995
|
+
"type": "string"
|
|
996
|
+
},
|
|
997
|
+
"jurisdiction": {
|
|
998
|
+
"type": "string"
|
|
999
|
+
},
|
|
1000
|
+
"legal_status": {
|
|
1001
|
+
"type": "string",
|
|
1002
|
+
"description": "Provenance / attorney-curation status."
|
|
1003
|
+
},
|
|
1004
|
+
"rules": {
|
|
1005
|
+
"type": "array",
|
|
1006
|
+
"minItems": 1,
|
|
1007
|
+
"items": {
|
|
1008
|
+
"type": "object"
|
|
1009
|
+
}
|
|
1010
|
+
}
|
|
1011
|
+
}
|
|
1012
|
+
}
|
|
1013
|
+
},
|
|
1014
|
+
"required": [
|
|
1015
|
+
"body"
|
|
1016
|
+
],
|
|
1017
|
+
"additionalProperties": false
|
|
1018
|
+
},
|
|
1019
|
+
"annotations": {
|
|
1020
|
+
"readOnlyHint": false,
|
|
1021
|
+
"destructiveHint": false,
|
|
1022
|
+
"idempotentHint": false,
|
|
1023
|
+
"openWorldHint": true
|
|
1024
|
+
},
|
|
1025
|
+
"route": {
|
|
1026
|
+
"method": "POST",
|
|
1027
|
+
"path": "/v1/trace/rule-packs",
|
|
1028
|
+
"query": [],
|
|
1029
|
+
"scope": "trace:configure"
|
|
1030
|
+
}
|
|
1031
|
+
},
|
|
1032
|
+
{
|
|
1033
|
+
"name": "list_trace_interactions",
|
|
1034
|
+
"title": "List Trace Interactions",
|
|
1035
|
+
"description": "Find monitored calls and interactions for compliance review.",
|
|
1036
|
+
"inputSchema": {
|
|
1037
|
+
"type": "object",
|
|
1038
|
+
"properties": {
|
|
1039
|
+
"verdict": {
|
|
1040
|
+
"type": "string",
|
|
1041
|
+
"enum": [
|
|
1042
|
+
"PASS",
|
|
1043
|
+
"WARN",
|
|
1044
|
+
"FAIL"
|
|
1045
|
+
]
|
|
1046
|
+
},
|
|
1047
|
+
"agent_id": {
|
|
1048
|
+
"type": "string"
|
|
1049
|
+
},
|
|
1050
|
+
"limit": {
|
|
1051
|
+
"type": "integer",
|
|
1052
|
+
"minimum": 1,
|
|
1053
|
+
"maximum": 100,
|
|
1054
|
+
"default": 20
|
|
1055
|
+
},
|
|
1056
|
+
"cursor": {
|
|
1057
|
+
"type": "string"
|
|
1058
|
+
}
|
|
1059
|
+
},
|
|
1060
|
+
"required": [],
|
|
1061
|
+
"additionalProperties": false
|
|
1062
|
+
},
|
|
1063
|
+
"annotations": {
|
|
1064
|
+
"readOnlyHint": true,
|
|
1065
|
+
"destructiveHint": false,
|
|
1066
|
+
"idempotentHint": true,
|
|
1067
|
+
"openWorldHint": true
|
|
1068
|
+
},
|
|
1069
|
+
"route": {
|
|
1070
|
+
"method": "GET",
|
|
1071
|
+
"path": "/v1/trace/interactions",
|
|
1072
|
+
"query": [
|
|
1073
|
+
"verdict",
|
|
1074
|
+
"agent_id",
|
|
1075
|
+
"limit",
|
|
1076
|
+
"cursor"
|
|
1077
|
+
],
|
|
1078
|
+
"scope": "trace:read"
|
|
1079
|
+
}
|
|
1080
|
+
},
|
|
1081
|
+
{
|
|
1082
|
+
"name": "get_trace_interaction",
|
|
1083
|
+
"title": "Get Trace Interaction",
|
|
1084
|
+
"description": "Read one monitored interaction and its compliance evidence.",
|
|
1085
|
+
"inputSchema": {
|
|
1086
|
+
"type": "object",
|
|
1087
|
+
"properties": {
|
|
1088
|
+
"id": {
|
|
1089
|
+
"type": "string",
|
|
1090
|
+
"description": "The call_id."
|
|
1091
|
+
}
|
|
1092
|
+
},
|
|
1093
|
+
"required": [
|
|
1094
|
+
"id"
|
|
1095
|
+
],
|
|
1096
|
+
"additionalProperties": false
|
|
1097
|
+
},
|
|
1098
|
+
"annotations": {
|
|
1099
|
+
"readOnlyHint": true,
|
|
1100
|
+
"destructiveHint": false,
|
|
1101
|
+
"idempotentHint": true,
|
|
1102
|
+
"openWorldHint": true
|
|
1103
|
+
},
|
|
1104
|
+
"route": {
|
|
1105
|
+
"method": "GET",
|
|
1106
|
+
"path": "/v1/trace/interactions/{id}",
|
|
1107
|
+
"query": [],
|
|
1108
|
+
"scope": "trace:read"
|
|
1109
|
+
}
|
|
1110
|
+
},
|
|
1111
|
+
{
|
|
1112
|
+
"name": "list_trace_findings",
|
|
1113
|
+
"title": "List Trace Findings",
|
|
1114
|
+
"description": "Find compliance findings with source evidence. Findings are signals for review, not legal conclusions.",
|
|
1115
|
+
"inputSchema": {
|
|
1116
|
+
"type": "object",
|
|
1117
|
+
"properties": {
|
|
1118
|
+
"check_id": {
|
|
1119
|
+
"type": "string"
|
|
1120
|
+
},
|
|
1121
|
+
"action": {
|
|
1122
|
+
"type": "string",
|
|
1123
|
+
"enum": [
|
|
1124
|
+
"flag",
|
|
1125
|
+
"preempt_next",
|
|
1126
|
+
"escalate"
|
|
1127
|
+
]
|
|
1128
|
+
},
|
|
1129
|
+
"severity": {
|
|
1130
|
+
"type": "string",
|
|
1131
|
+
"enum": [
|
|
1132
|
+
"low",
|
|
1133
|
+
"medium",
|
|
1134
|
+
"high",
|
|
1135
|
+
"critical"
|
|
1136
|
+
]
|
|
1137
|
+
},
|
|
1138
|
+
"interaction_id": {
|
|
1139
|
+
"type": "string"
|
|
1140
|
+
},
|
|
1141
|
+
"limit": {
|
|
1142
|
+
"type": "integer",
|
|
1143
|
+
"minimum": 1,
|
|
1144
|
+
"maximum": 100,
|
|
1145
|
+
"default": 20
|
|
1146
|
+
},
|
|
1147
|
+
"cursor": {
|
|
1148
|
+
"type": "string"
|
|
1149
|
+
}
|
|
1150
|
+
},
|
|
1151
|
+
"required": [],
|
|
1152
|
+
"additionalProperties": false
|
|
1153
|
+
},
|
|
1154
|
+
"annotations": {
|
|
1155
|
+
"readOnlyHint": true,
|
|
1156
|
+
"destructiveHint": false,
|
|
1157
|
+
"idempotentHint": true,
|
|
1158
|
+
"openWorldHint": true
|
|
1159
|
+
},
|
|
1160
|
+
"route": {
|
|
1161
|
+
"method": "GET",
|
|
1162
|
+
"path": "/v1/trace/findings",
|
|
1163
|
+
"query": [
|
|
1164
|
+
"check_id",
|
|
1165
|
+
"action",
|
|
1166
|
+
"severity",
|
|
1167
|
+
"interaction_id",
|
|
1168
|
+
"limit",
|
|
1169
|
+
"cursor"
|
|
1170
|
+
],
|
|
1171
|
+
"scope": "trace:read"
|
|
1172
|
+
}
|
|
1173
|
+
},
|
|
1174
|
+
{
|
|
1175
|
+
"name": "list_trace_violations",
|
|
1176
|
+
"title": "List Trace Violations",
|
|
1177
|
+
"description": "List Trace rule violations for compliance review.",
|
|
1178
|
+
"inputSchema": {
|
|
1179
|
+
"type": "object",
|
|
1180
|
+
"properties": {
|
|
1181
|
+
"rule_id": {
|
|
1182
|
+
"type": "string"
|
|
1183
|
+
},
|
|
1184
|
+
"severity": {
|
|
1185
|
+
"type": "string",
|
|
1186
|
+
"enum": [
|
|
1187
|
+
"low",
|
|
1188
|
+
"medium",
|
|
1189
|
+
"high",
|
|
1190
|
+
"critical"
|
|
1191
|
+
]
|
|
1192
|
+
},
|
|
1193
|
+
"interaction_id": {
|
|
1194
|
+
"type": "string"
|
|
1195
|
+
},
|
|
1196
|
+
"limit": {
|
|
1197
|
+
"type": "integer",
|
|
1198
|
+
"minimum": 1,
|
|
1199
|
+
"maximum": 100,
|
|
1200
|
+
"default": 20
|
|
1201
|
+
},
|
|
1202
|
+
"cursor": {
|
|
1203
|
+
"type": "string"
|
|
1204
|
+
}
|
|
1205
|
+
},
|
|
1206
|
+
"required": [],
|
|
1207
|
+
"additionalProperties": false
|
|
1208
|
+
},
|
|
1209
|
+
"annotations": {
|
|
1210
|
+
"readOnlyHint": true,
|
|
1211
|
+
"destructiveHint": false,
|
|
1212
|
+
"idempotentHint": true,
|
|
1213
|
+
"openWorldHint": true
|
|
1214
|
+
},
|
|
1215
|
+
"route": {
|
|
1216
|
+
"method": "GET",
|
|
1217
|
+
"path": "/v1/trace/violations",
|
|
1218
|
+
"query": [
|
|
1219
|
+
"rule_id",
|
|
1220
|
+
"severity",
|
|
1221
|
+
"interaction_id",
|
|
1222
|
+
"limit",
|
|
1223
|
+
"cursor"
|
|
1224
|
+
],
|
|
1225
|
+
"scope": "trace:read"
|
|
1226
|
+
}
|
|
1227
|
+
},
|
|
1228
|
+
{
|
|
1229
|
+
"name": "get_trace_exposure",
|
|
1230
|
+
"title": "Get Trace Exposure",
|
|
1231
|
+
"description": "Read aggregate compliance exposure for the workspace.",
|
|
1232
|
+
"inputSchema": {
|
|
1233
|
+
"type": "object",
|
|
1234
|
+
"properties": {
|
|
1235
|
+
"window_days": {
|
|
1236
|
+
"type": "integer",
|
|
1237
|
+
"minimum": 1,
|
|
1238
|
+
"maximum": 365,
|
|
1239
|
+
"default": 30,
|
|
1240
|
+
"description": "Trailing window in days."
|
|
1241
|
+
}
|
|
1242
|
+
},
|
|
1243
|
+
"required": [],
|
|
1244
|
+
"additionalProperties": false
|
|
1245
|
+
},
|
|
1246
|
+
"annotations": {
|
|
1247
|
+
"readOnlyHint": true,
|
|
1248
|
+
"destructiveHint": false,
|
|
1249
|
+
"idempotentHint": true,
|
|
1250
|
+
"openWorldHint": true
|
|
1251
|
+
},
|
|
1252
|
+
"route": {
|
|
1253
|
+
"method": "GET",
|
|
1254
|
+
"path": "/v1/trace/exposure",
|
|
1255
|
+
"query": [
|
|
1256
|
+
"window_days"
|
|
1257
|
+
],
|
|
1258
|
+
"scope": "trace:read"
|
|
1259
|
+
}
|
|
1260
|
+
},
|
|
1261
|
+
{
|
|
1262
|
+
"name": "get_recap_config",
|
|
1263
|
+
"title": "Get Recap Config",
|
|
1264
|
+
"description": "Read Recap summarization configuration before changing it.",
|
|
1265
|
+
"inputSchema": {
|
|
1266
|
+
"type": "object",
|
|
1267
|
+
"properties": {},
|
|
1268
|
+
"required": [],
|
|
1269
|
+
"additionalProperties": false
|
|
1270
|
+
},
|
|
1271
|
+
"annotations": {
|
|
1272
|
+
"readOnlyHint": true,
|
|
1273
|
+
"destructiveHint": false,
|
|
1274
|
+
"idempotentHint": true,
|
|
1275
|
+
"openWorldHint": true
|
|
1276
|
+
},
|
|
1277
|
+
"route": {
|
|
1278
|
+
"method": "GET",
|
|
1279
|
+
"path": "/v1/recap/config",
|
|
1280
|
+
"query": [],
|
|
1281
|
+
"scope": "recap:configure"
|
|
1282
|
+
}
|
|
1283
|
+
},
|
|
1284
|
+
{
|
|
1285
|
+
"name": "get_cast_capabilities",
|
|
1286
|
+
"title": "Get Cast Capabilities",
|
|
1287
|
+
"description": "Discover Cast voices, emotions, formats and supported rendering capabilities.",
|
|
1288
|
+
"inputSchema": {
|
|
1289
|
+
"type": "object",
|
|
1290
|
+
"properties": {},
|
|
1291
|
+
"required": [],
|
|
1292
|
+
"additionalProperties": false
|
|
1293
|
+
},
|
|
1294
|
+
"annotations": {
|
|
1295
|
+
"readOnlyHint": true,
|
|
1296
|
+
"destructiveHint": false,
|
|
1297
|
+
"idempotentHint": true,
|
|
1298
|
+
"openWorldHint": true
|
|
1299
|
+
},
|
|
1300
|
+
"route": {
|
|
1301
|
+
"method": "GET",
|
|
1302
|
+
"path": "/v1/cast/capabilities",
|
|
1303
|
+
"query": [],
|
|
1304
|
+
"scope": "cast:render"
|
|
1305
|
+
}
|
|
1306
|
+
},
|
|
1307
|
+
{
|
|
1308
|
+
"name": "direct_cast_script",
|
|
1309
|
+
"title": "Direct Cast Script",
|
|
1310
|
+
"description": "Turn a narration script into directed Cast lines before rendering. Consumes usage.",
|
|
1311
|
+
"inputSchema": {
|
|
1312
|
+
"type": "object",
|
|
1313
|
+
"properties": {
|
|
1314
|
+
"body": {
|
|
1315
|
+
"type": "object",
|
|
1316
|
+
"required": [
|
|
1317
|
+
"text"
|
|
1318
|
+
],
|
|
1319
|
+
"properties": {
|
|
1320
|
+
"text": {
|
|
1321
|
+
"type": "string",
|
|
1322
|
+
"minLength": 1
|
|
1323
|
+
}
|
|
1324
|
+
}
|
|
1325
|
+
}
|
|
1326
|
+
},
|
|
1327
|
+
"required": [
|
|
1328
|
+
"body"
|
|
1329
|
+
],
|
|
1330
|
+
"additionalProperties": false
|
|
1331
|
+
},
|
|
1332
|
+
"annotations": {
|
|
1333
|
+
"readOnlyHint": false,
|
|
1334
|
+
"destructiveHint": false,
|
|
1335
|
+
"idempotentHint": false,
|
|
1336
|
+
"openWorldHint": true
|
|
1337
|
+
},
|
|
1338
|
+
"route": {
|
|
1339
|
+
"method": "POST",
|
|
1340
|
+
"path": "/v1/cast/direct",
|
|
1341
|
+
"query": [],
|
|
1342
|
+
"scope": "cast:render"
|
|
1343
|
+
}
|
|
1344
|
+
},
|
|
1345
|
+
{
|
|
1346
|
+
"name": "render_cast",
|
|
1347
|
+
"title": "Render Cast",
|
|
1348
|
+
"description": "Submit script text or a directed, multi-line Cast narration render. Returns a job; preserve its ID and poll with get_cast_render. Consumes usage; do not resubmit on timeout.",
|
|
1349
|
+
"inputSchema": {
|
|
1350
|
+
"type": "object",
|
|
1351
|
+
"properties": {
|
|
1352
|
+
"body": {
|
|
1353
|
+
"type": "object",
|
|
1354
|
+
"required": [
|
|
1355
|
+
"voice"
|
|
1356
|
+
],
|
|
1357
|
+
"anyOf": [
|
|
1358
|
+
{
|
|
1359
|
+
"required": [
|
|
1360
|
+
"script"
|
|
1361
|
+
]
|
|
1362
|
+
},
|
|
1363
|
+
{
|
|
1364
|
+
"required": [
|
|
1365
|
+
"lines"
|
|
1366
|
+
]
|
|
1367
|
+
}
|
|
1368
|
+
],
|
|
1369
|
+
"properties": {
|
|
1370
|
+
"script": {
|
|
1371
|
+
"type": "string",
|
|
1372
|
+
"minLength": 1
|
|
1373
|
+
},
|
|
1374
|
+
"voice": {
|
|
1375
|
+
"type": "string",
|
|
1376
|
+
"minLength": 1
|
|
1377
|
+
},
|
|
1378
|
+
"lines": {
|
|
1379
|
+
"type": "array",
|
|
1380
|
+
"minItems": 1,
|
|
1381
|
+
"items": {
|
|
1382
|
+
"type": "object",
|
|
1383
|
+
"required": [
|
|
1384
|
+
"text",
|
|
1385
|
+
"emotion",
|
|
1386
|
+
"intensity"
|
|
1387
|
+
],
|
|
1388
|
+
"properties": {
|
|
1389
|
+
"text": {
|
|
1390
|
+
"type": "string",
|
|
1391
|
+
"minLength": 1
|
|
1392
|
+
},
|
|
1393
|
+
"emotion": {
|
|
1394
|
+
"type": "string",
|
|
1395
|
+
"minLength": 1
|
|
1396
|
+
},
|
|
1397
|
+
"intensity": {
|
|
1398
|
+
"oneOf": [
|
|
1399
|
+
{
|
|
1400
|
+
"type": "string"
|
|
1401
|
+
},
|
|
1402
|
+
{
|
|
1403
|
+
"type": "number"
|
|
1404
|
+
}
|
|
1405
|
+
]
|
|
1406
|
+
}
|
|
1407
|
+
}
|
|
1408
|
+
}
|
|
1409
|
+
},
|
|
1410
|
+
"steps": {
|
|
1411
|
+
"type": "integer",
|
|
1412
|
+
"minimum": 1
|
|
1413
|
+
}
|
|
1414
|
+
}
|
|
1415
|
+
}
|
|
1416
|
+
},
|
|
1417
|
+
"required": [
|
|
1418
|
+
"body"
|
|
1419
|
+
],
|
|
1420
|
+
"additionalProperties": false
|
|
1421
|
+
},
|
|
1422
|
+
"annotations": {
|
|
1423
|
+
"readOnlyHint": false,
|
|
1424
|
+
"destructiveHint": false,
|
|
1425
|
+
"idempotentHint": false,
|
|
1426
|
+
"openWorldHint": true
|
|
1427
|
+
},
|
|
1428
|
+
"route": {
|
|
1429
|
+
"method": "POST",
|
|
1430
|
+
"path": "/v1/cast/render_jobs",
|
|
1431
|
+
"query": [],
|
|
1432
|
+
"scope": "cast:render"
|
|
1433
|
+
}
|
|
1434
|
+
},
|
|
1435
|
+
{
|
|
1436
|
+
"name": "list_transcription_jobs",
|
|
1437
|
+
"title": "List Transcription Jobs",
|
|
1438
|
+
"description": "Find existing audio processing and transcription jobs before submitting duplicates.",
|
|
1439
|
+
"inputSchema": {
|
|
1440
|
+
"type": "object",
|
|
1441
|
+
"properties": {
|
|
1442
|
+
"limit": {
|
|
1443
|
+
"type": "integer",
|
|
1444
|
+
"minimum": 1,
|
|
1445
|
+
"maximum": 100,
|
|
1446
|
+
"default": 20,
|
|
1447
|
+
"description": "Max items to return (1-100)."
|
|
1448
|
+
},
|
|
1449
|
+
"cursor": {
|
|
1450
|
+
"type": "string",
|
|
1451
|
+
"description": "Opaque token from a previous page's `next_cursor`. Omit for the first page."
|
|
1452
|
+
}
|
|
1453
|
+
},
|
|
1454
|
+
"required": [],
|
|
1455
|
+
"additionalProperties": false
|
|
1456
|
+
},
|
|
1457
|
+
"annotations": {
|
|
1458
|
+
"readOnlyHint": true,
|
|
1459
|
+
"destructiveHint": false,
|
|
1460
|
+
"idempotentHint": true,
|
|
1461
|
+
"openWorldHint": true
|
|
1462
|
+
},
|
|
1463
|
+
"route": {
|
|
1464
|
+
"method": "GET",
|
|
1465
|
+
"path": "/v1/transcription/jobs",
|
|
1466
|
+
"query": [
|
|
1467
|
+
"limit",
|
|
1468
|
+
"cursor"
|
|
1469
|
+
],
|
|
1470
|
+
"scope": "transcribe:jobs"
|
|
1471
|
+
}
|
|
1472
|
+
}
|
|
1473
|
+
];
|