@graph8/sdk 0.251.0 → 0.262.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/README.md +9 -2
- package/dist/cli.js +216 -0
- package/dist/index.d.mts +105 -7
- package/dist/index.d.ts +105 -7
- package/dist/index.js +44 -3
- package/dist/index.js.map +1 -1
- package/dist/index.mjs +44 -3
- package/dist/index.mjs.map +1 -1
- package/dist/react.d.mts +103 -7
- package/dist/react.d.ts +103 -7
- package/dist/react.js +62 -11
- package/dist/react.js.map +1 -1
- package/dist/react.mjs +53 -12
- package/dist/react.mjs.map +1 -1
- package/dist/types/README.md +7 -0
- package/dist/types/agency.d.ts +20 -0
- package/dist/types/agentSetup.d.ts +57 -0
- package/dist/types/api.d.ts +127 -0
- package/dist/types/appClient.d.ts +99 -0
- package/dist/types/appPlatform.d.ts +269 -0
- package/dist/types/appTokens.d.ts +125 -0
- package/dist/types/apps.d.ts +130 -0
- package/dist/types/audiences.d.ts +88 -0
- package/dist/types/calendar.d.ts +55 -0
- package/dist/types/campaigns.d.ts +61 -0
- package/dist/types/chat.d.ts +35 -0
- package/dist/types/cli.d.ts +14 -0
- package/dist/types/companies.d.ts +123 -0
- package/dist/types/contacts.d.ts +200 -0
- package/dist/types/copilot.d.ts +31 -0
- package/dist/types/core.d.ts +1052 -0
- package/dist/types/deals.d.ts +215 -0
- package/dist/types/enrich.d.ts +51 -0
- package/dist/types/fields.d.ts +84 -0
- package/dist/types/forms.d.ts +16 -0
- package/dist/types/http.d.ts +141 -0
- package/dist/types/inbox.d.ts +123 -0
- package/dist/types/index.d.ts +63 -0
- package/dist/types/intent.d.ts +196 -0
- package/dist/types/lists.d.ts +44 -0
- package/dist/types/mailboxes.d.ts +240 -0
- package/dist/types/marketplace.d.ts +62 -0
- package/dist/types/meetings.d.ts +70 -0
- package/dist/types/newsletter.d.ts +212 -0
- package/dist/types/notes.d.ts +57 -0
- package/dist/types/objects.d.ts +281 -0
- package/dist/types/pipelines.d.ts +135 -0
- package/dist/types/quotes.d.ts +143 -0
- package/dist/types/react.d.ts +978 -0
- package/dist/types/search.d.ts +99 -0
- package/dist/types/sequences.d.ts +255 -0
- package/dist/types/signals.d.ts +28 -0
- package/dist/types/skills.d.ts +176 -0
- package/dist/types/snippet.d.ts +24 -0
- package/dist/types/studio.d.ts +161 -0
- package/dist/types/tasks.d.ts +101 -0
- package/dist/types/types.d.ts +45 -0
- package/dist/types/utils.d.ts +21 -0
- package/dist/types/version.d.ts +10 -0
- package/dist/types/visitors.d.ts +29 -0
- package/dist/types/voice.d.ts +304 -0
- package/dist/types/webhooks.d.ts +71 -0
- package/dist/types/workflows.d.ts +229 -0
- package/docs/agents.md +748 -0
- package/docs/api/README.md +165 -0
- package/docs/api/accounts.d.ts +396 -0
- package/docs/api/accounts.md +644 -0
- package/docs/api/adCampaigns.d.ts +707 -0
- package/docs/api/adCampaigns.md +1091 -0
- package/docs/api/adCreatives.d.ts +996 -0
- package/docs/api/adCreatives.md +1708 -0
- package/docs/api/agency.d.ts +556 -0
- package/docs/api/agency.md +845 -0
- package/docs/api/agent.d.ts +330 -0
- package/docs/api/agent.md +514 -0
- package/docs/api/agents.d.ts +1622 -0
- package/docs/api/agents.md +2860 -0
- package/docs/api/aiInbox.d.ts +1984 -0
- package/docs/api/aiInbox.md +3490 -0
- package/docs/api/analytics.d.ts +1273 -0
- package/docs/api/analytics.md +2095 -0
- package/docs/api/apiKeys.d.ts +252 -0
- package/docs/api/apiKeys.md +318 -0
- package/docs/api/appDeployments.d.ts +236 -0
- package/docs/api/appDeployments.md +471 -0
- package/docs/api/appDomains.d.ts +171 -0
- package/docs/api/appDomains.md +281 -0
- package/docs/api/appLogs.d.ts +120 -0
- package/docs/api/appLogs.md +159 -0
- package/docs/api/appObjects.d.ts +415 -0
- package/docs/api/appObjects.md +568 -0
- package/docs/api/appPages.d.ts +557 -0
- package/docs/api/appPages.md +796 -0
- package/docs/api/appPlatformTokens.d.ts +123 -0
- package/docs/api/appPlatformTokens.md +172 -0
- package/docs/api/appointments.d.ts +2361 -0
- package/docs/api/appointments.md +3917 -0
- package/docs/api/apps.d.ts +822 -0
- package/docs/api/apps.md +1342 -0
- package/docs/api/assertUpsert.d.ts +286 -0
- package/docs/api/assertUpsert.md +370 -0
- package/docs/api/audienceSyncs.d.ts +259 -0
- package/docs/api/audienceSyncs.md +395 -0
- package/docs/api/brandKit.d.ts +686 -0
- package/docs/api/brandKit.md +1133 -0
- package/docs/api/bugReports.d.ts +181 -0
- package/docs/api/bugReports.md +268 -0
- package/docs/api/by-path.md +3260 -0
- package/docs/api/calendarInvites.d.ts +117 -0
- package/docs/api/calendarInvites.md +148 -0
- package/docs/api/campaignWorkflows.d.ts +152 -0
- package/docs/api/campaignWorkflows.md +200 -0
- package/docs/api/campaigns.d.ts +721 -0
- package/docs/api/campaigns.md +1236 -0
- package/docs/api/channels.d.ts +171 -0
- package/docs/api/channels.md +235 -0
- package/docs/api/cliCampaigns.d.ts +205 -0
- package/docs/api/cliCampaigns.md +256 -0
- package/docs/api/cliPipelines.d.ts +324 -0
- package/docs/api/cliPipelines.md +562 -0
- package/docs/api/clickHouse.d.ts +115 -0
- package/docs/api/clickHouse.md +138 -0
- package/docs/api/companies.d.ts +1636 -0
- package/docs/api/companies.md +2211 -0
- package/docs/api/companyIntelligence.d.ts +299 -0
- package/docs/api/companyIntelligence.md +488 -0
- package/docs/api/contacts.d.ts +2173 -0
- package/docs/api/contacts.md +3143 -0
- package/docs/api/content.d.ts +968 -0
- package/docs/api/content.md +1667 -0
- package/docs/api/contentGridSkills.d.ts +177 -0
- package/docs/api/contentGridSkills.md +271 -0
- package/docs/api/copilot.d.ts +1017 -0
- package/docs/api/copilot.md +1765 -0
- package/docs/api/crmSyncs.d.ts +215 -0
- package/docs/api/crmSyncs.md +301 -0
- package/docs/api/customerSuccess.d.ts +491 -0
- package/docs/api/customerSuccess.md +776 -0
- package/docs/api/deals.d.ts +1697 -0
- package/docs/api/deals.md +2436 -0
- package/docs/api/deliverability.d.ts +418 -0
- package/docs/api/deliverability.md +677 -0
- package/docs/api/desk.d.ts +1765 -0
- package/docs/api/desk.md +3007 -0
- package/docs/api/dialer.d.ts +1185 -0
- package/docs/api/dialer.md +2166 -0
- package/docs/api/dialerAnalytics.d.ts +187 -0
- package/docs/api/dialerAnalytics.md +257 -0
- package/docs/api/documents.d.ts +895 -0
- package/docs/api/documents.md +1440 -0
- package/docs/api/duplicates.d.ts +195 -0
- package/docs/api/duplicates.md +315 -0
- package/docs/api/eSign.d.ts +38 -0
- package/docs/api/eSign.md +54 -0
- package/docs/api/eSignature.d.ts +242 -0
- package/docs/api/eSignature.md +341 -0
- package/docs/api/enrichment.d.ts +3207 -0
- package/docs/api/enrichment.md +5225 -0
- package/docs/api/events.d.ts +115 -0
- package/docs/api/events.md +105 -0
- package/docs/api/fields.d.ts +482 -0
- package/docs/api/fields.md +566 -0
- package/docs/api/forms.d.ts +1012 -0
- package/docs/api/forms.md +1542 -0
- package/docs/api/gtmCampaigns.d.ts +662 -0
- package/docs/api/gtmCampaigns.md +1044 -0
- package/docs/api/gtmContext.d.ts +1187 -0
- package/docs/api/gtmContext.md +2112 -0
- package/docs/api/gtmDeliverability.d.ts +60 -0
- package/docs/api/gtmDeliverability.md +63 -0
- package/docs/api/gtmKnowledgeBase.d.ts +76 -0
- package/docs/api/gtmKnowledgeBase.md +91 -0
- package/docs/api/gtmLaunchHelpers.d.ts +123 -0
- package/docs/api/gtmLaunchHelpers.md +148 -0
- package/docs/api/gtmLibrary.d.ts +448 -0
- package/docs/api/gtmLibrary.md +780 -0
- package/docs/api/health.d.ts +39 -0
- package/docs/api/health.md +58 -0
- package/docs/api/imageLibrary.d.ts +341 -0
- package/docs/api/imageLibrary.md +569 -0
- package/docs/api/imports.d.ts +157 -0
- package/docs/api/imports.md +174 -0
- package/docs/api/inbox.d.ts +709 -0
- package/docs/api/inbox.md +1067 -0
- package/docs/api/install.d.ts +213 -0
- package/docs/api/install.md +317 -0
- package/docs/api/installedApps.d.ts +131 -0
- package/docs/api/installedApps.md +241 -0
- package/docs/api/integrationStatus.d.ts +142 -0
- package/docs/api/integrationStatus.md +205 -0
- package/docs/api/integrations.d.ts +2327 -0
- package/docs/api/integrations.md +3791 -0
- package/docs/api/intent.d.ts +482 -0
- package/docs/api/intent.md +858 -0
- package/docs/api/knowledge.d.ts +501 -0
- package/docs/api/knowledge.md +843 -0
- package/docs/api/knowledgeBase.d.ts +84 -0
- package/docs/api/knowledgeBase.md +96 -0
- package/docs/api/landingPages.d.ts +1411 -0
- package/docs/api/landingPages.md +2488 -0
- package/docs/api/leads.d.ts +133 -0
- package/docs/api/leads.md +180 -0
- package/docs/api/library.d.ts +217 -0
- package/docs/api/library.md +338 -0
- package/docs/api/linkedIn.d.ts +227 -0
- package/docs/api/linkedIn.md +289 -0
- package/docs/api/linkedInOutreach.d.ts +727 -0
- package/docs/api/linkedInOutreach.md +990 -0
- package/docs/api/lists.d.ts +1106 -0
- package/docs/api/lists.md +1609 -0
- package/docs/api/logs.d.ts +71 -0
- package/docs/api/logs.md +70 -0
- package/docs/api/mailboxes.d.ts +1050 -0
- package/docs/api/mailboxes.md +1690 -0
- package/docs/api/marketingIntelligence.d.ts +256 -0
- package/docs/api/marketingIntelligence.md +454 -0
- package/docs/api/marketplace.d.ts +3173 -0
- package/docs/api/marketplace.md +5953 -0
- package/docs/api/mcp.d.ts +69 -0
- package/docs/api/mcp.md +69 -0
- package/docs/api/me.d.ts +54 -0
- package/docs/api/me.md +56 -0
- package/docs/api/meetings.d.ts +539 -0
- package/docs/api/meetings.md +747 -0
- package/docs/api/newsletter.d.ts +1613 -0
- package/docs/api/newsletter.md +2746 -0
- package/docs/api/notes.d.ts +517 -0
- package/docs/api/notes.md +888 -0
- package/docs/api/notifications.d.ts +94 -0
- package/docs/api/notifications.md +105 -0
- package/docs/api/objects.d.ts +621 -0
- package/docs/api/objects.md +1098 -0
- package/docs/api/openSearch.d.ts +234 -0
- package/docs/api/openSearch.md +297 -0
- package/docs/api/ops.d.ts +299 -0
- package/docs/api/ops.md +339 -0
- package/docs/api/orgGovernance.d.ts +393 -0
- package/docs/api/orgGovernance.md +623 -0
- package/docs/api/orgVideos.d.ts +184 -0
- package/docs/api/orgVideos.md +252 -0
- package/docs/api/organizationSettings.d.ts +626 -0
- package/docs/api/organizationSettings.md +911 -0
- package/docs/api/phoneNumbers.d.ts +484 -0
- package/docs/api/phoneNumbers.md +777 -0
- package/docs/api/profile.d.ts +329 -0
- package/docs/api/profile.md +540 -0
- package/docs/api/programmaticPages.d.ts +400 -0
- package/docs/api/programmaticPages.md +626 -0
- package/docs/api/providerDomains.d.ts +866 -0
- package/docs/api/providerDomains.md +1446 -0
- package/docs/api/providerUsage.d.ts +129 -0
- package/docs/api/providerUsage.md +186 -0
- package/docs/api/public.d.ts +69 -0
- package/docs/api/public.md +78 -0
- package/docs/api/publicCopilot.d.ts +67 -0
- package/docs/api/publicCopilot.md +80 -0
- package/docs/api/publicSignals.d.ts +66 -0
- package/docs/api/publicSignals.md +71 -0
- package/docs/api/publicVisitors.d.ts +97 -0
- package/docs/api/publicVisitors.md +118 -0
- package/docs/api/quotes.d.ts +1564 -0
- package/docs/api/quotes.md +2553 -0
- package/docs/api/radar.d.ts +808 -0
- package/docs/api/radar.md +1431 -0
- package/docs/api/radarReports.d.ts +208 -0
- package/docs/api/radarReports.md +306 -0
- package/docs/api/recordRoles.d.ts +143 -0
- package/docs/api/recordRoles.md +175 -0
- package/docs/api/repos.d.ts +146 -0
- package/docs/api/repos.md +211 -0
- package/docs/api/research.d.ts +295 -0
- package/docs/api/research.md +534 -0
- package/docs/api/revenue.d.ts +402 -0
- package/docs/api/revenue.md +608 -0
- package/docs/api/revenueAnalytics.d.ts +147 -0
- package/docs/api/revenueAnalytics.md +212 -0
- package/docs/api/revenueLifecycle.d.ts +207 -0
- package/docs/api/revenueLifecycle.md +274 -0
- package/docs/api/revenueRecords.d.ts +372 -0
- package/docs/api/revenueRecords.md +563 -0
- package/docs/api/roles.d.ts +431 -0
- package/docs/api/roles.md +812 -0
- package/docs/api/salesCoach.d.ts +877 -0
- package/docs/api/salesCoach.md +1540 -0
- package/docs/api/sandbox.d.ts +210 -0
- package/docs/api/sandbox.md +380 -0
- package/docs/api/scans.d.ts +104 -0
- package/docs/api/scans.md +136 -0
- package/docs/api/scheduleBuy.d.ts +293 -0
- package/docs/api/scheduleBuy.md +431 -0
- package/docs/api/scraping.d.ts +266 -0
- package/docs/api/scraping.md +383 -0
- package/docs/api/sdrAnalytics.d.ts +138 -0
- package/docs/api/sdrAnalytics.md +246 -0
- package/docs/api/search.d.ts +598 -0
- package/docs/api/search.md +866 -0
- package/docs/api/seo.d.ts +447 -0
- package/docs/api/seo.md +660 -0
- package/docs/api/sequenceLifecycle.d.ts +439 -0
- package/docs/api/sequenceLifecycle.md +513 -0
- package/docs/api/sequences.d.ts +1936 -0
- package/docs/api/sequences.md +3232 -0
- package/docs/api/settings.d.ts +448 -0
- package/docs/api/settings.md +731 -0
- package/docs/api/signals.d.ts +1441 -0
- package/docs/api/signals.md +2526 -0
- package/docs/api/signatures.d.ts +719 -0
- package/docs/api/signatures.md +1247 -0
- package/docs/api/skills.d.ts +230 -0
- package/docs/api/skills.md +466 -0
- package/docs/api/snippet.d.ts +85 -0
- package/docs/api/snippet.md +106 -0
- package/docs/api/socialPublishing.d.ts +824 -0
- package/docs/api/socialPublishing.md +1245 -0
- package/docs/api/studioDocuments.d.ts +244 -0
- package/docs/api/studioDocuments.md +348 -0
- package/docs/api/support.d.ts +90 -0
- package/docs/api/support.md +76 -0
- package/docs/api/suppressions.d.ts +241 -0
- package/docs/api/suppressions.md +343 -0
- package/docs/api/surveys.d.ts +847 -0
- package/docs/api/surveys.md +1223 -0
- package/docs/api/tasks.d.ts +813 -0
- package/docs/api/tasks.md +1344 -0
- package/docs/api/teamMembers.d.ts +668 -0
- package/docs/api/teamMembers.md +1040 -0
- package/docs/api/teams.d.ts +784 -0
- package/docs/api/teams.md +1395 -0
- package/docs/api/usage.d.ts +277 -0
- package/docs/api/usage.md +389 -0
- package/docs/api/visitors.d.ts +690 -0
- package/docs/api/visitors.md +1075 -0
- package/docs/api/voice.d.ts +4661 -0
- package/docs/api/voice.md +7905 -0
- package/docs/api/webAnalytics.d.ts +964 -0
- package/docs/api/webAnalytics.md +1452 -0
- package/docs/api/webChat.d.ts +1704 -0
- package/docs/api/webChat.md +2048 -0
- package/docs/api/webhooks.d.ts +251 -0
- package/docs/api/webhooks.md +386 -0
- package/docs/api/websiteEditor.d.ts +324 -0
- package/docs/api/websiteEditor.md +517 -0
- package/docs/api/work.d.ts +2298 -0
- package/docs/api/work.md +3096 -0
- package/docs/api/workbench.d.ts +2962 -0
- package/docs/api/workbench.md +4884 -0
- package/docs/api/workflows.d.ts +1218 -0
- package/docs/api/workflows.md +2302 -0
- package/docs/sdk-clients.md +4339 -0
- package/package.json +10 -3
|
@@ -0,0 +1,1622 @@
|
|
|
1
|
+
/* Generated by sdk/js/scripts/generate-agent-docs.ts from developer-contract/openapi.json. Regenerated on every build. */
|
|
2
|
+
|
|
3
|
+
/**
|
|
4
|
+
* Types for `g8.api.agents` (Agents): 65 operations.
|
|
5
|
+
*
|
|
6
|
+
* For reading. In code, import from the package instead:
|
|
7
|
+
* import type { ApiInput, ApiOutput, G8Contract } from "@graph8/sdk";
|
|
8
|
+
* type In = ApiInput<"answer_agent_discovery_agent_onboarding_discovery_answer_post">;
|
|
9
|
+
*
|
|
10
|
+
* Reference with examples: agents.md
|
|
11
|
+
*/
|
|
12
|
+
/* eslint-disable */
|
|
13
|
+
|
|
14
|
+
/** `g8.api.agents.<member>` -> the operationId it calls. */
|
|
15
|
+
export interface AgentsMembers {
|
|
16
|
+
answerAgentDiscovery: "answer_agent_discovery_agent_onboarding_discovery_answer_post";
|
|
17
|
+
cancelAgentWorkItem: "cancel_agent_work_item_agent_work_items__work_item_id__cancel_post";
|
|
18
|
+
captureAgentEntryPoint: "capture_agent_entry_point_agent_onboarding_entry_point_post";
|
|
19
|
+
captureAgentSignupAttribution: "capture_agent_signup_attribution_agent_onboarding_attribution_post";
|
|
20
|
+
confirmAgentSessionCard: "confirm_agent_session_card_agent_sessions__session_id__cards__card_id__confirm_post";
|
|
21
|
+
createAgentSession: "create_agent_session_agent_sessions_post";
|
|
22
|
+
createAgentVoiceDraft: "create_agent_voice_draft_agent_sessions_voice_draft_post";
|
|
23
|
+
createAgentWorkItem: "create_agent_work_item_agent_work_items_post";
|
|
24
|
+
decideAgentOperatorApproval: "decide_agent_operator_approval_agent_operators__operator__approvals__task_id__decide_post";
|
|
25
|
+
deleteAgentSession: "delete_agent_session_agent_sessions__session_id__delete";
|
|
26
|
+
endAgentSessionVoice: "end_agent_session_voice_agent_sessions__session_id__voice__voice_id__delete";
|
|
27
|
+
getAgentDiscovery: "get_agent_discovery_agent_onboarding_discovery_get";
|
|
28
|
+
getAgentDiscoveryCampaignBrief: "get_agent_discovery_campaign_brief_agent_onboarding_discovery_campaign_brief_get";
|
|
29
|
+
getAgentDiscoveryReport: "get_agent_discovery_report_agent_onboarding_discovery_report_get";
|
|
30
|
+
getAgentMemory: "get_agent_memory_agent_memory_get";
|
|
31
|
+
getAgentOperatingModel: "get_agent_operating_model_agent_operators_operating_model_get";
|
|
32
|
+
getAgentOperatorCatalog: "get_agent_operator_catalog_agent_operators__operator__catalog_get";
|
|
33
|
+
getAgentOperatorFeedbackSummary: "get_agent_operator_feedback_summary_agent_operators__operator__feedback_summary_get";
|
|
34
|
+
getAgentOperatorForApprovalTask: "get_agent_operator_for_approval_task_agent_operators_approvals__task_id__operator_get";
|
|
35
|
+
getAgentOperatorHealth: "get_agent_operator_health_agent_operators__operator__health_get";
|
|
36
|
+
getAgentOperatorRecipient: "get_agent_operator_recipient_agent_operators__operator__recipient_get";
|
|
37
|
+
getAgentOperatorScorecard: "get_agent_operator_scorecard_agent_operators__operator__scorecard_get";
|
|
38
|
+
getAgentOperatorStatus: "get_agent_operator_status_agent_operators__operator__status_get";
|
|
39
|
+
getAgentOperatorsSummary: "get_agent_operators_summary_agent_operators_summary_get";
|
|
40
|
+
getAgentOversight: "get_agent_oversight_agent_oversight_get";
|
|
41
|
+
getAgentProactiveOpener: "get_agent_proactive_opener_agent_proactive_opener_get";
|
|
42
|
+
getAgentPushbackEvidence: "get_agent_pushback_evidence_agent_evidence_pushback_get";
|
|
43
|
+
getAgentSession: "get_agent_session_agent_sessions__session_id__get";
|
|
44
|
+
getAgentSessionState: "get_agent_session_state_agent_sessions__session_id__state_get";
|
|
45
|
+
getAgentSessionVoiceCapability: "get_agent_session_voice_capability_agent_sessions__session_id__voice_get";
|
|
46
|
+
getAgentVoiceCapability: "get_agent_voice_capability_agent_sessions_voice_capability_get";
|
|
47
|
+
listAgentOperatorActions: "list_agent_operator_actions_agent_operators__operator__actions_get";
|
|
48
|
+
listAgentOperatorActivity: "list_agent_operator_activity_agent_operators__operator__activity_get";
|
|
49
|
+
listAgentOperatorActivityRecords: "list_agent_operator_activity_records_agent_operators__operator__activity__task_id__records_get";
|
|
50
|
+
listAgentOperatorApprovalSources: "list_agent_operator_approval_sources_agent_operators_approvals_sources_get";
|
|
51
|
+
listAgentOperatorCollections: "list_agent_operator_collections_agent_operators__operator__collections_get";
|
|
52
|
+
listAgentOperatorFindings: "list_agent_operator_findings_agent_operators__operator__findings_get";
|
|
53
|
+
listAgentOperatorSkills: "list_agent_operator_skills_agent_operators__operator__skills_get";
|
|
54
|
+
listAgentOperators: "list_agent_operators_agent_operators_get";
|
|
55
|
+
listAgentSessions: "list_agent_sessions_agent_sessions_get";
|
|
56
|
+
listAgentSpecialists: "list_agent_specialists_agent_specialists_get";
|
|
57
|
+
listAgentWorkItems: "list_agent_work_items_agent_work_items_get";
|
|
58
|
+
loadCopilotIntentContext: "load_copilot_intent_context_copilot_context_load_post";
|
|
59
|
+
markAgentSessionRead: "mark_agent_session_read_agent_sessions__session_id__read_put";
|
|
60
|
+
openAgentDiscovery: "open_agent_discovery_agent_onboarding_discovery_open_post";
|
|
61
|
+
pinAgentSession: "pin_agent_session_agent_sessions__session_id__pin_post";
|
|
62
|
+
postAgentChat: "post_agent_chat_agent_chat_post";
|
|
63
|
+
postAgentOnboardingCatchup: "post_agent_onboarding_catchup_agent_onboarding_catchup_post";
|
|
64
|
+
postAgentSessionMessage: "post_agent_session_message_agent_sessions__session_id__messages_post";
|
|
65
|
+
projectAgentDiscovery: "project_agent_discovery_agent_onboarding_discovery_project_post";
|
|
66
|
+
putAgentOperatingModel: "put_agent_operating_model_agent_operators_operating_model_put";
|
|
67
|
+
quoteAgentSessionVoice: "quote_agent_session_voice_agent_sessions__session_id__voice_quote_post";
|
|
68
|
+
ratifyAgentDiscovery: "ratify_agent_discovery_agent_onboarding_discovery_ratify_post";
|
|
69
|
+
renameAgentSession: "rename_agent_session_agent_sessions__session_id__rename_post";
|
|
70
|
+
requestAgentApprovalChanges: "request_agent_approval_changes_agent_approvals__approval_id__request_changes_post";
|
|
71
|
+
searchAgentMentions: "search_agent_mentions_agent_mention_search_post";
|
|
72
|
+
setAgentOperatorEnabled: "set_agent_operator_enabled_agent_operators__operator__enabled_put";
|
|
73
|
+
setAgentOperatorRecipient: "set_agent_operator_recipient_agent_operators__operator__recipient_put";
|
|
74
|
+
setAgentOperatorTrustDial: "set_agent_operator_trust_dial_agent_operators__operator__skills__skill_key__put";
|
|
75
|
+
setupAgentDiscoverySignals: "setup_agent_discovery_signals_agent_onboarding_discovery_signals_post";
|
|
76
|
+
startAgentSessionVoice: "start_agent_session_voice_agent_sessions__session_id__voice_post";
|
|
77
|
+
steerAgentWorkItem: "steer_agent_work_item_agent_work_items__work_item_id__steer_post";
|
|
78
|
+
submitAgentDomainResponse: "submit_agent_domain_response_agent_onboarding_domain_response_post";
|
|
79
|
+
takeAgentDiscoveryTurn: "take_agent_discovery_turn_agent_onboarding_discovery_turn_post";
|
|
80
|
+
updateAgentSession: "update_agent_session_agent_sessions__session_id__patch";
|
|
81
|
+
}
|
|
82
|
+
|
|
83
|
+
/** Input and output of every `g8.api.agents` operation, keyed by operationId. */
|
|
84
|
+
export interface AgentsOperations {
|
|
85
|
+
/**
|
|
86
|
+
* POST /agent/onboarding/discovery/answer
|
|
87
|
+
* Answer Agent Discovery
|
|
88
|
+
* tier: write · scope: workflows:write
|
|
89
|
+
*/
|
|
90
|
+
answer_agent_discovery_agent_onboarding_discovery_answer_post: {
|
|
91
|
+
input: {
|
|
92
|
+
headers?: {
|
|
93
|
+
"X-Target-Org-Id"?: string | null;
|
|
94
|
+
};
|
|
95
|
+
body: DiscoveryAnswerRequest;
|
|
96
|
+
};
|
|
97
|
+
output: ApiResponse_OnboardingPayload_;
|
|
98
|
+
};
|
|
99
|
+
/**
|
|
100
|
+
* POST /agent/work-items/{work_item_id}/cancel
|
|
101
|
+
* Cancel Agent Work Item
|
|
102
|
+
* tier: destructive · scope: workflows:delete
|
|
103
|
+
*/
|
|
104
|
+
cancel_agent_work_item_agent_work_items__work_item_id__cancel_post: {
|
|
105
|
+
input: {
|
|
106
|
+
path: {
|
|
107
|
+
/** Work item id (UUID). */
|
|
108
|
+
work_item_id: string;
|
|
109
|
+
};
|
|
110
|
+
headers?: {
|
|
111
|
+
"X-Target-Org-Id"?: string | null;
|
|
112
|
+
};
|
|
113
|
+
};
|
|
114
|
+
output: ApiResponse_dict_;
|
|
115
|
+
};
|
|
116
|
+
/**
|
|
117
|
+
* POST /agent/onboarding/entry-point
|
|
118
|
+
* Capture Agent Entry Point
|
|
119
|
+
* tier: write · scope: workflows:write
|
|
120
|
+
*/
|
|
121
|
+
capture_agent_entry_point_agent_onboarding_entry_point_post: {
|
|
122
|
+
input: {
|
|
123
|
+
headers?: {
|
|
124
|
+
"X-Target-Org-Id"?: string | null;
|
|
125
|
+
};
|
|
126
|
+
body: EntryPointCaptureRequest;
|
|
127
|
+
};
|
|
128
|
+
output: ApiResponse_OnboardingPayload_;
|
|
129
|
+
};
|
|
130
|
+
/**
|
|
131
|
+
* POST /agent/onboarding/attribution
|
|
132
|
+
* Capture Agent Signup Attribution
|
|
133
|
+
* tier: write · scope: workflows:write
|
|
134
|
+
*/
|
|
135
|
+
capture_agent_signup_attribution_agent_onboarding_attribution_post: {
|
|
136
|
+
input: {
|
|
137
|
+
headers?: {
|
|
138
|
+
"X-Target-Org-Id"?: string | null;
|
|
139
|
+
};
|
|
140
|
+
body: SignupAttributionRequest;
|
|
141
|
+
};
|
|
142
|
+
output: ApiResponse_OnboardingPayload_;
|
|
143
|
+
};
|
|
144
|
+
/**
|
|
145
|
+
* POST /agent/sessions/{session_id}/cards/{card_id}/confirm
|
|
146
|
+
* Confirm Agent Session Card
|
|
147
|
+
* tier: write · scope: workflows:write
|
|
148
|
+
*/
|
|
149
|
+
confirm_agent_session_card_agent_sessions__session_id__cards__card_id__confirm_post: {
|
|
150
|
+
input: {
|
|
151
|
+
path: {
|
|
152
|
+
/** Session id (UUID). */
|
|
153
|
+
session_id: string;
|
|
154
|
+
/** The card's id in the session. */
|
|
155
|
+
card_id: string;
|
|
156
|
+
};
|
|
157
|
+
headers?: {
|
|
158
|
+
"X-Target-Org-Id"?: string | null;
|
|
159
|
+
};
|
|
160
|
+
body: AgentCardConfirmationRequest;
|
|
161
|
+
};
|
|
162
|
+
output: ApiResponse_AgentConversationPayload_;
|
|
163
|
+
};
|
|
164
|
+
/**
|
|
165
|
+
* POST /agent/sessions
|
|
166
|
+
* Create Agent Session
|
|
167
|
+
* tier: write · scope: workflows:write
|
|
168
|
+
*/
|
|
169
|
+
create_agent_session_agent_sessions_post: {
|
|
170
|
+
input: {
|
|
171
|
+
headers?: {
|
|
172
|
+
"X-Target-Org-Id"?: string | null;
|
|
173
|
+
};
|
|
174
|
+
body: AgentSessionCreateRequest;
|
|
175
|
+
};
|
|
176
|
+
output: ApiResponse_AgentSession_;
|
|
177
|
+
};
|
|
178
|
+
/**
|
|
179
|
+
* POST /agent/sessions/voice/draft
|
|
180
|
+
* Create Agent Voice Draft
|
|
181
|
+
* tier: write · scope: workflows:write
|
|
182
|
+
*/
|
|
183
|
+
create_agent_voice_draft_agent_sessions_voice_draft_post: {
|
|
184
|
+
input: {
|
|
185
|
+
headers?: {
|
|
186
|
+
"X-Target-Org-Id"?: string | null;
|
|
187
|
+
};
|
|
188
|
+
body: VoiceDraftRequest;
|
|
189
|
+
};
|
|
190
|
+
output: ApiResponse_AgentSessionStatePayload_;
|
|
191
|
+
};
|
|
192
|
+
/**
|
|
193
|
+
* POST /agent/work-items
|
|
194
|
+
* Create Agent Work Item
|
|
195
|
+
* tier: billable · scope: workflows:run
|
|
196
|
+
*/
|
|
197
|
+
create_agent_work_item_agent_work_items_post: {
|
|
198
|
+
input: {
|
|
199
|
+
headers?: {
|
|
200
|
+
"X-Target-Org-Id"?: string | null;
|
|
201
|
+
};
|
|
202
|
+
body: AgentWorkItemCreateRequest;
|
|
203
|
+
};
|
|
204
|
+
output: ApiResponse_AgentWorkItem_;
|
|
205
|
+
};
|
|
206
|
+
/**
|
|
207
|
+
* POST /agent/operators/{operator}/approvals/{task_id}/decide
|
|
208
|
+
* Decide Agent Operator Approval
|
|
209
|
+
* tier: billable · scope: workflows:run
|
|
210
|
+
*/
|
|
211
|
+
decide_agent_operator_approval_agent_operators__operator__approvals__task_id__decide_post: {
|
|
212
|
+
input: {
|
|
213
|
+
path: {
|
|
214
|
+
operator: string;
|
|
215
|
+
/** The approval task id. */
|
|
216
|
+
task_id: string;
|
|
217
|
+
};
|
|
218
|
+
headers?: {
|
|
219
|
+
"X-Target-Org-Id"?: string | null;
|
|
220
|
+
};
|
|
221
|
+
body: OperatorApprovalDecisionRequest;
|
|
222
|
+
};
|
|
223
|
+
output: ApiResponse_OperatorPayload_;
|
|
224
|
+
};
|
|
225
|
+
/**
|
|
226
|
+
* DELETE /agent/sessions/{session_id}
|
|
227
|
+
* Delete Agent Session
|
|
228
|
+
* tier: destructive · scope: workflows:delete
|
|
229
|
+
*/
|
|
230
|
+
delete_agent_session_agent_sessions__session_id__delete: {
|
|
231
|
+
input: {
|
|
232
|
+
path: {
|
|
233
|
+
/** Session id. */
|
|
234
|
+
session_id: string;
|
|
235
|
+
};
|
|
236
|
+
headers?: {
|
|
237
|
+
"X-Target-Org-Id"?: string | null;
|
|
238
|
+
};
|
|
239
|
+
};
|
|
240
|
+
output: ApiResponse_dict_;
|
|
241
|
+
};
|
|
242
|
+
/**
|
|
243
|
+
* DELETE /agent/sessions/{session_id}/voice/{voice_id}
|
|
244
|
+
* End Agent Session Voice
|
|
245
|
+
* tier: destructive · scope: workflows:delete
|
|
246
|
+
*/
|
|
247
|
+
end_agent_session_voice_agent_sessions__session_id__voice__voice_id__delete: {
|
|
248
|
+
input: {
|
|
249
|
+
path: {
|
|
250
|
+
/** Session id (UUID). */
|
|
251
|
+
session_id: string;
|
|
252
|
+
/** Voice session id (UUID) from the start call. */
|
|
253
|
+
voice_id: string;
|
|
254
|
+
};
|
|
255
|
+
headers?: {
|
|
256
|
+
"X-Target-Org-Id"?: string | null;
|
|
257
|
+
};
|
|
258
|
+
};
|
|
259
|
+
output: ApiResponse_AgentSessionStatePayload_;
|
|
260
|
+
};
|
|
261
|
+
/**
|
|
262
|
+
* GET /agent/onboarding/discovery
|
|
263
|
+
* Get Agent Discovery
|
|
264
|
+
* tier: read · scope: workflows:read
|
|
265
|
+
*/
|
|
266
|
+
get_agent_discovery_agent_onboarding_discovery_get: {
|
|
267
|
+
input: {
|
|
268
|
+
headers?: {
|
|
269
|
+
"X-Target-Org-Id"?: string | null;
|
|
270
|
+
};
|
|
271
|
+
};
|
|
272
|
+
output: ApiResponse_OnboardingPayload_;
|
|
273
|
+
};
|
|
274
|
+
/**
|
|
275
|
+
* GET /agent/onboarding/discovery/campaign-brief
|
|
276
|
+
* Get Agent Discovery Campaign Brief
|
|
277
|
+
* tier: read · scope: workflows:read
|
|
278
|
+
*/
|
|
279
|
+
get_agent_discovery_campaign_brief_agent_onboarding_discovery_campaign_brief_get: {
|
|
280
|
+
input: {
|
|
281
|
+
headers?: {
|
|
282
|
+
"X-Target-Org-Id"?: string | null;
|
|
283
|
+
};
|
|
284
|
+
};
|
|
285
|
+
output: ApiResponse_OnboardingPayload_;
|
|
286
|
+
};
|
|
287
|
+
/**
|
|
288
|
+
* GET /agent/onboarding/discovery/report
|
|
289
|
+
* Get Agent Discovery Report
|
|
290
|
+
* tier: read · scope: workflows:read
|
|
291
|
+
*/
|
|
292
|
+
get_agent_discovery_report_agent_onboarding_discovery_report_get: {
|
|
293
|
+
input: {
|
|
294
|
+
headers?: {
|
|
295
|
+
"X-Target-Org-Id"?: string | null;
|
|
296
|
+
};
|
|
297
|
+
};
|
|
298
|
+
output: ApiResponse_OnboardingPayload_;
|
|
299
|
+
};
|
|
300
|
+
/**
|
|
301
|
+
* GET /agent/memory
|
|
302
|
+
* Get Agent Memory
|
|
303
|
+
* tier: read · scope: workflows:read
|
|
304
|
+
*/
|
|
305
|
+
get_agent_memory_agent_memory_get: {
|
|
306
|
+
input: {
|
|
307
|
+
headers?: {
|
|
308
|
+
"X-Target-Org-Id"?: string | null;
|
|
309
|
+
};
|
|
310
|
+
};
|
|
311
|
+
output: ApiResponse_AgentPayload_;
|
|
312
|
+
};
|
|
313
|
+
/**
|
|
314
|
+
* GET /agent/operators/operating-model
|
|
315
|
+
* Get Agent Operating Model
|
|
316
|
+
* tier: read · scope: workflows:read
|
|
317
|
+
*/
|
|
318
|
+
get_agent_operating_model_agent_operators_operating_model_get: {
|
|
319
|
+
input: {
|
|
320
|
+
headers?: {
|
|
321
|
+
"X-Target-Org-Id"?: string | null;
|
|
322
|
+
};
|
|
323
|
+
};
|
|
324
|
+
output: ApiResponse_OperatorPayload_;
|
|
325
|
+
};
|
|
326
|
+
/**
|
|
327
|
+
* GET /agent/operators/{operator}/catalog
|
|
328
|
+
* Get Agent Operator Catalog
|
|
329
|
+
* tier: read · scope: workflows:read
|
|
330
|
+
*/
|
|
331
|
+
get_agent_operator_catalog_agent_operators__operator__catalog_get: {
|
|
332
|
+
input: {
|
|
333
|
+
path: {
|
|
334
|
+
operator: string;
|
|
335
|
+
};
|
|
336
|
+
headers?: {
|
|
337
|
+
"X-Target-Org-Id"?: string | null;
|
|
338
|
+
};
|
|
339
|
+
};
|
|
340
|
+
output: ApiResponse_OperatorPayload_;
|
|
341
|
+
};
|
|
342
|
+
/**
|
|
343
|
+
* GET /agent/operators/{operator}/feedback/summary
|
|
344
|
+
* Get Agent Operator Feedback Summary
|
|
345
|
+
* tier: read · scope: workflows:read
|
|
346
|
+
*/
|
|
347
|
+
get_agent_operator_feedback_summary_agent_operators__operator__feedback_summary_get: {
|
|
348
|
+
input: {
|
|
349
|
+
path: {
|
|
350
|
+
operator: string;
|
|
351
|
+
};
|
|
352
|
+
headers?: {
|
|
353
|
+
"X-Target-Org-Id"?: string | null;
|
|
354
|
+
};
|
|
355
|
+
};
|
|
356
|
+
output: ApiResponse_OperatorPayload_;
|
|
357
|
+
};
|
|
358
|
+
/**
|
|
359
|
+
* GET /agent/operators/approvals/{task_id}/operator
|
|
360
|
+
* Get Agent Operator For Approval Task
|
|
361
|
+
* tier: read · scope: workflows:read
|
|
362
|
+
*/
|
|
363
|
+
get_agent_operator_for_approval_task_agent_operators_approvals__task_id__operator_get: {
|
|
364
|
+
input: {
|
|
365
|
+
path: {
|
|
366
|
+
/** Operator approval task id. */
|
|
367
|
+
task_id: string;
|
|
368
|
+
};
|
|
369
|
+
headers?: {
|
|
370
|
+
"X-Target-Org-Id"?: string | null;
|
|
371
|
+
};
|
|
372
|
+
};
|
|
373
|
+
output: ApiResponse_OperatorPayload_;
|
|
374
|
+
};
|
|
375
|
+
/**
|
|
376
|
+
* GET /agent/operators/{operator}/health
|
|
377
|
+
* Get Agent Operator Health
|
|
378
|
+
* tier: read · scope: workflows:read
|
|
379
|
+
*/
|
|
380
|
+
get_agent_operator_health_agent_operators__operator__health_get: {
|
|
381
|
+
input: {
|
|
382
|
+
path: {
|
|
383
|
+
operator: string;
|
|
384
|
+
};
|
|
385
|
+
headers?: {
|
|
386
|
+
"X-Target-Org-Id"?: string | null;
|
|
387
|
+
};
|
|
388
|
+
};
|
|
389
|
+
output: ApiResponse_OperatorPayload_;
|
|
390
|
+
};
|
|
391
|
+
/**
|
|
392
|
+
* GET /agent/operators/{operator}/recipient
|
|
393
|
+
* Get Agent Operator Recipient
|
|
394
|
+
* tier: read · scope: workflows:read
|
|
395
|
+
*/
|
|
396
|
+
get_agent_operator_recipient_agent_operators__operator__recipient_get: {
|
|
397
|
+
input: {
|
|
398
|
+
path: {
|
|
399
|
+
operator: string;
|
|
400
|
+
};
|
|
401
|
+
headers?: {
|
|
402
|
+
"X-Target-Org-Id"?: string | null;
|
|
403
|
+
};
|
|
404
|
+
};
|
|
405
|
+
output: ApiResponse_OperatorPayload_;
|
|
406
|
+
};
|
|
407
|
+
/**
|
|
408
|
+
* GET /agent/operators/{operator}/scorecard
|
|
409
|
+
* Get Agent Operator Scorecard
|
|
410
|
+
* tier: read · scope: workflows:read
|
|
411
|
+
*/
|
|
412
|
+
get_agent_operator_scorecard_agent_operators__operator__scorecard_get: {
|
|
413
|
+
input: {
|
|
414
|
+
path: {
|
|
415
|
+
operator: string;
|
|
416
|
+
};
|
|
417
|
+
headers?: {
|
|
418
|
+
"X-Target-Org-Id"?: string | null;
|
|
419
|
+
};
|
|
420
|
+
};
|
|
421
|
+
output: ApiResponse_OperatorPayload_;
|
|
422
|
+
};
|
|
423
|
+
/**
|
|
424
|
+
* GET /agent/operators/{operator}/status
|
|
425
|
+
* Get Agent Operator Status
|
|
426
|
+
* tier: read · scope: workflows:read
|
|
427
|
+
*/
|
|
428
|
+
get_agent_operator_status_agent_operators__operator__status_get: {
|
|
429
|
+
input: {
|
|
430
|
+
path: {
|
|
431
|
+
operator: string;
|
|
432
|
+
};
|
|
433
|
+
headers?: {
|
|
434
|
+
"X-Target-Org-Id"?: string | null;
|
|
435
|
+
};
|
|
436
|
+
};
|
|
437
|
+
output: ApiResponse_OperatorPayload_;
|
|
438
|
+
};
|
|
439
|
+
/**
|
|
440
|
+
* GET /agent/operators/summary
|
|
441
|
+
* Get Agent Operators Summary
|
|
442
|
+
* tier: read · scope: workflows:read
|
|
443
|
+
*/
|
|
444
|
+
get_agent_operators_summary_agent_operators_summary_get: {
|
|
445
|
+
input: {
|
|
446
|
+
headers?: {
|
|
447
|
+
"X-Target-Org-Id"?: string | null;
|
|
448
|
+
};
|
|
449
|
+
};
|
|
450
|
+
output: ApiResponse_OperatorPayload_;
|
|
451
|
+
};
|
|
452
|
+
/**
|
|
453
|
+
* GET /agent/oversight
|
|
454
|
+
* Get Agent Oversight
|
|
455
|
+
* tier: read · scope: workflows:read
|
|
456
|
+
*/
|
|
457
|
+
get_agent_oversight_agent_oversight_get: {
|
|
458
|
+
input: {
|
|
459
|
+
query?: {
|
|
460
|
+
/** Max rows PER GROUP. */
|
|
461
|
+
limit?: number;
|
|
462
|
+
/** How far back autonomous fixes are read. */
|
|
463
|
+
fix_window_hours?: number;
|
|
464
|
+
};
|
|
465
|
+
headers?: {
|
|
466
|
+
"X-Target-Org-Id"?: string | null;
|
|
467
|
+
};
|
|
468
|
+
};
|
|
469
|
+
output: ApiResponse_AgentConversationPayload_;
|
|
470
|
+
};
|
|
471
|
+
/**
|
|
472
|
+
* GET /agent/proactive-opener
|
|
473
|
+
* Get Agent Proactive Opener
|
|
474
|
+
* tier: read · scope: workflows:read
|
|
475
|
+
*/
|
|
476
|
+
get_agent_proactive_opener_agent_proactive_opener_get: {
|
|
477
|
+
input: {
|
|
478
|
+
headers?: {
|
|
479
|
+
"X-Target-Org-Id"?: string | null;
|
|
480
|
+
};
|
|
481
|
+
};
|
|
482
|
+
output: ApiResponse_AgentPayload_;
|
|
483
|
+
};
|
|
484
|
+
/**
|
|
485
|
+
* GET /agent/evidence/pushback
|
|
486
|
+
* Get Agent Pushback Evidence
|
|
487
|
+
* tier: read · scope: workflows:read
|
|
488
|
+
*/
|
|
489
|
+
get_agent_pushback_evidence_agent_evidence_pushback_get: {
|
|
490
|
+
input: {
|
|
491
|
+
query?: {
|
|
492
|
+
/** Lookback window in days. */
|
|
493
|
+
window_days?: number;
|
|
494
|
+
};
|
|
495
|
+
headers?: {
|
|
496
|
+
"X-Target-Org-Id"?: string | null;
|
|
497
|
+
};
|
|
498
|
+
};
|
|
499
|
+
output: ApiResponse_AgentPayload_;
|
|
500
|
+
};
|
|
501
|
+
/**
|
|
502
|
+
* GET /agent/sessions/{session_id}
|
|
503
|
+
* Get Agent Session
|
|
504
|
+
* tier: read · scope: workflows:read
|
|
505
|
+
*/
|
|
506
|
+
get_agent_session_agent_sessions__session_id__get: {
|
|
507
|
+
input: {
|
|
508
|
+
path: {
|
|
509
|
+
/** Session id. */
|
|
510
|
+
session_id: string;
|
|
511
|
+
};
|
|
512
|
+
headers?: {
|
|
513
|
+
"X-Target-Org-Id"?: string | null;
|
|
514
|
+
};
|
|
515
|
+
};
|
|
516
|
+
output: ApiResponse_AgentSession_;
|
|
517
|
+
};
|
|
518
|
+
/**
|
|
519
|
+
* GET /agent/sessions/{session_id}/state
|
|
520
|
+
* Get Agent Session State
|
|
521
|
+
* tier: read · scope: workflows:read
|
|
522
|
+
*/
|
|
523
|
+
get_agent_session_state_agent_sessions__session_id__state_get: {
|
|
524
|
+
input: {
|
|
525
|
+
path: {
|
|
526
|
+
/** Session id (UUID). */
|
|
527
|
+
session_id: string;
|
|
528
|
+
};
|
|
529
|
+
headers?: {
|
|
530
|
+
"X-Target-Org-Id"?: string | null;
|
|
531
|
+
};
|
|
532
|
+
};
|
|
533
|
+
output: ApiResponse_AgentSessionStatePayload_;
|
|
534
|
+
};
|
|
535
|
+
/**
|
|
536
|
+
* GET /agent/sessions/{session_id}/voice
|
|
537
|
+
* Get Agent Session Voice Capability
|
|
538
|
+
* tier: read · scope: workflows:read
|
|
539
|
+
*/
|
|
540
|
+
get_agent_session_voice_capability_agent_sessions__session_id__voice_get: {
|
|
541
|
+
input: {
|
|
542
|
+
path: {
|
|
543
|
+
/** Session id (UUID). */
|
|
544
|
+
session_id: string;
|
|
545
|
+
};
|
|
546
|
+
headers?: {
|
|
547
|
+
"X-Target-Org-Id"?: string | null;
|
|
548
|
+
};
|
|
549
|
+
};
|
|
550
|
+
output: ApiResponse_AgentSessionStatePayload_;
|
|
551
|
+
};
|
|
552
|
+
/**
|
|
553
|
+
* GET /agent/sessions/voice/capability
|
|
554
|
+
* Get Agent Voice Capability
|
|
555
|
+
* tier: read · scope: workflows:read
|
|
556
|
+
*/
|
|
557
|
+
get_agent_voice_capability_agent_sessions_voice_capability_get: {
|
|
558
|
+
input: {
|
|
559
|
+
headers?: {
|
|
560
|
+
"X-Target-Org-Id"?: string | null;
|
|
561
|
+
};
|
|
562
|
+
};
|
|
563
|
+
output: ApiResponse_AgentSessionStatePayload_;
|
|
564
|
+
};
|
|
565
|
+
/**
|
|
566
|
+
* GET /agent/operators/{operator}/actions
|
|
567
|
+
* List Agent Operator Actions
|
|
568
|
+
* tier: read · scope: workflows:read
|
|
569
|
+
*/
|
|
570
|
+
list_agent_operator_actions_agent_operators__operator__actions_get: {
|
|
571
|
+
input: {
|
|
572
|
+
path: {
|
|
573
|
+
operator: string;
|
|
574
|
+
};
|
|
575
|
+
headers?: {
|
|
576
|
+
"X-Target-Org-Id"?: string | null;
|
|
577
|
+
};
|
|
578
|
+
};
|
|
579
|
+
output: ApiResponse_OperatorListPayload_;
|
|
580
|
+
};
|
|
581
|
+
/**
|
|
582
|
+
* GET /agent/operators/{operator}/activity
|
|
583
|
+
* List Agent Operator Activity
|
|
584
|
+
* tier: read · scope: workflows:read
|
|
585
|
+
*/
|
|
586
|
+
list_agent_operator_activity_agent_operators__operator__activity_get: {
|
|
587
|
+
input: {
|
|
588
|
+
path: {
|
|
589
|
+
operator: string;
|
|
590
|
+
};
|
|
591
|
+
query?: {
|
|
592
|
+
/** How many history rows to return. The app's own default is 50 and it declares no ceiling; a bound is added here because an unbounded limit on a public contract is a denial-of-service parameter. */
|
|
593
|
+
limit?: number;
|
|
594
|
+
};
|
|
595
|
+
headers?: {
|
|
596
|
+
"X-Target-Org-Id"?: string | null;
|
|
597
|
+
};
|
|
598
|
+
};
|
|
599
|
+
output: ApiResponse_OperatorListPayload_;
|
|
600
|
+
};
|
|
601
|
+
/**
|
|
602
|
+
* GET /agent/operators/{operator}/activity/{task_id}/records
|
|
603
|
+
* List Agent Operator Activity Records
|
|
604
|
+
* tier: read · scope: workflows:read
|
|
605
|
+
*/
|
|
606
|
+
list_agent_operator_activity_records_agent_operators__operator__activity__task_id__records_get: {
|
|
607
|
+
input: {
|
|
608
|
+
path: {
|
|
609
|
+
operator: string;
|
|
610
|
+
/** Task id from the activity list. */
|
|
611
|
+
task_id: string;
|
|
612
|
+
};
|
|
613
|
+
headers?: {
|
|
614
|
+
"X-Target-Org-Id"?: string | null;
|
|
615
|
+
};
|
|
616
|
+
};
|
|
617
|
+
output: ApiResponse_OperatorListPayload_;
|
|
618
|
+
};
|
|
619
|
+
/**
|
|
620
|
+
* GET /agent/operators/approvals/sources
|
|
621
|
+
* List Agent Operator Approval Sources
|
|
622
|
+
* tier: read · scope: workflows:read
|
|
623
|
+
*/
|
|
624
|
+
list_agent_operator_approval_sources_agent_operators_approvals_sources_get: {
|
|
625
|
+
input: {
|
|
626
|
+
headers?: {
|
|
627
|
+
"X-Target-Org-Id"?: string | null;
|
|
628
|
+
};
|
|
629
|
+
};
|
|
630
|
+
output: ApiResponse_OperatorListPayload_;
|
|
631
|
+
};
|
|
632
|
+
/**
|
|
633
|
+
* GET /agent/operators/{operator}/collections
|
|
634
|
+
* List Agent Operator Collections
|
|
635
|
+
* tier: read · scope: workflows:read
|
|
636
|
+
*/
|
|
637
|
+
list_agent_operator_collections_agent_operators__operator__collections_get: {
|
|
638
|
+
input: {
|
|
639
|
+
path: {
|
|
640
|
+
operator: string;
|
|
641
|
+
};
|
|
642
|
+
headers?: {
|
|
643
|
+
"X-Target-Org-Id"?: string | null;
|
|
644
|
+
};
|
|
645
|
+
};
|
|
646
|
+
output: ApiResponse_OperatorListPayload_;
|
|
647
|
+
};
|
|
648
|
+
/**
|
|
649
|
+
* GET /agent/operators/{operator}/findings
|
|
650
|
+
* List Agent Operator Findings
|
|
651
|
+
* tier: read · scope: workflows:read
|
|
652
|
+
*/
|
|
653
|
+
list_agent_operator_findings_agent_operators__operator__findings_get: {
|
|
654
|
+
input: {
|
|
655
|
+
path: {
|
|
656
|
+
operator: string;
|
|
657
|
+
};
|
|
658
|
+
headers?: {
|
|
659
|
+
"X-Target-Org-Id"?: string | null;
|
|
660
|
+
};
|
|
661
|
+
};
|
|
662
|
+
output: ApiResponse_OperatorListPayload_;
|
|
663
|
+
};
|
|
664
|
+
/**
|
|
665
|
+
* GET /agent/operators/{operator}/skills
|
|
666
|
+
* List Agent Operator Skills
|
|
667
|
+
* tier: read · scope: workflows:read
|
|
668
|
+
*/
|
|
669
|
+
list_agent_operator_skills_agent_operators__operator__skills_get: {
|
|
670
|
+
input: {
|
|
671
|
+
path: {
|
|
672
|
+
operator: string;
|
|
673
|
+
};
|
|
674
|
+
headers?: {
|
|
675
|
+
"X-Target-Org-Id"?: string | null;
|
|
676
|
+
};
|
|
677
|
+
};
|
|
678
|
+
output: ApiResponse_OperatorListPayload_;
|
|
679
|
+
};
|
|
680
|
+
/**
|
|
681
|
+
* GET /agent/operators
|
|
682
|
+
* List Agent Operators
|
|
683
|
+
* tier: read · scope: workflows:read
|
|
684
|
+
*/
|
|
685
|
+
list_agent_operators_agent_operators_get: {
|
|
686
|
+
input: {
|
|
687
|
+
headers?: {
|
|
688
|
+
"X-Target-Org-Id"?: string | null;
|
|
689
|
+
};
|
|
690
|
+
};
|
|
691
|
+
output: ApiResponse_OperatorListPayload_;
|
|
692
|
+
};
|
|
693
|
+
/**
|
|
694
|
+
* GET /agent/sessions
|
|
695
|
+
* List Agent Sessions
|
|
696
|
+
* tier: read · scope: workflows:read
|
|
697
|
+
*/
|
|
698
|
+
list_agent_sessions_agent_sessions_get: {
|
|
699
|
+
input: {
|
|
700
|
+
query?: {
|
|
701
|
+
/** Filter to one session mode. */
|
|
702
|
+
mode?: string | null;
|
|
703
|
+
/** Page size (max 200). */
|
|
704
|
+
limit?: number;
|
|
705
|
+
/** Rows to skip. */
|
|
706
|
+
offset?: number;
|
|
707
|
+
};
|
|
708
|
+
headers?: {
|
|
709
|
+
"X-Target-Org-Id"?: string | null;
|
|
710
|
+
};
|
|
711
|
+
};
|
|
712
|
+
output: ApiResponse_AgentSessionListResponse_;
|
|
713
|
+
};
|
|
714
|
+
/**
|
|
715
|
+
* GET /agent/specialists
|
|
716
|
+
* List Agent Specialists
|
|
717
|
+
* tier: read · scope: workflows:read
|
|
718
|
+
*/
|
|
719
|
+
list_agent_specialists_agent_specialists_get: {
|
|
720
|
+
input: {
|
|
721
|
+
headers?: {
|
|
722
|
+
"X-Target-Org-Id"?: string | null;
|
|
723
|
+
};
|
|
724
|
+
};
|
|
725
|
+
output: ApiResponse_AgentBenchListPayload_;
|
|
726
|
+
};
|
|
727
|
+
/**
|
|
728
|
+
* GET /agent/work-items
|
|
729
|
+
* List Agent Work Items
|
|
730
|
+
* tier: read · scope: workflows:read
|
|
731
|
+
*/
|
|
732
|
+
list_agent_work_items_agent_work_items_get: {
|
|
733
|
+
input: {
|
|
734
|
+
query?: {
|
|
735
|
+
/** Status filter, REPEATABLE: `?statuses=running&statuses=queued`. Repeated rather than comma-joined, matching the app - a comma in a status would otherwise split it. */
|
|
736
|
+
statuses?: Array<string> | null;
|
|
737
|
+
/** Filter to one agent. */
|
|
738
|
+
agent_id?: string | null;
|
|
739
|
+
/** Include org-wide shared items as well as the caller's own. True by default, matching the app - set false to see only your own. */
|
|
740
|
+
include_shared?: boolean;
|
|
741
|
+
limit?: number;
|
|
742
|
+
offset?: number;
|
|
743
|
+
};
|
|
744
|
+
headers?: {
|
|
745
|
+
"X-Target-Org-Id"?: string | null;
|
|
746
|
+
};
|
|
747
|
+
};
|
|
748
|
+
output: ApiResponse_AgentWorkItemList_;
|
|
749
|
+
};
|
|
750
|
+
/**
|
|
751
|
+
* POST /copilot/context/load
|
|
752
|
+
* Load Copilot Intent Context
|
|
753
|
+
* tier: write · scope: workflows:write
|
|
754
|
+
*/
|
|
755
|
+
load_copilot_intent_context_copilot_context_load_post: {
|
|
756
|
+
input: {
|
|
757
|
+
headers?: {
|
|
758
|
+
"X-Target-Org-Id"?: string | null;
|
|
759
|
+
};
|
|
760
|
+
body: CopilotContextLoadRequest;
|
|
761
|
+
};
|
|
762
|
+
output: ApiResponse_AgentConversationPayload_;
|
|
763
|
+
};
|
|
764
|
+
/**
|
|
765
|
+
* PUT /agent/sessions/{session_id}/read
|
|
766
|
+
* Mark Agent Session Read
|
|
767
|
+
* tier: write · scope: workflows:write
|
|
768
|
+
*/
|
|
769
|
+
mark_agent_session_read_agent_sessions__session_id__read_put: {
|
|
770
|
+
input: {
|
|
771
|
+
path: {
|
|
772
|
+
/** Session id (UUID). */
|
|
773
|
+
session_id: string;
|
|
774
|
+
};
|
|
775
|
+
headers?: {
|
|
776
|
+
"X-Target-Org-Id"?: string | null;
|
|
777
|
+
};
|
|
778
|
+
body: SessionReadRequest;
|
|
779
|
+
};
|
|
780
|
+
output: ApiResponse_AgentSessionStatePayload_;
|
|
781
|
+
};
|
|
782
|
+
/**
|
|
783
|
+
* POST /agent/onboarding/discovery/open
|
|
784
|
+
* Open Agent Discovery
|
|
785
|
+
* tier: write · scope: workflows:write
|
|
786
|
+
*/
|
|
787
|
+
open_agent_discovery_agent_onboarding_discovery_open_post: {
|
|
788
|
+
input: {
|
|
789
|
+
headers?: {
|
|
790
|
+
"X-Target-Org-Id"?: string | null;
|
|
791
|
+
};
|
|
792
|
+
};
|
|
793
|
+
output: ApiResponse_OnboardingPayload_;
|
|
794
|
+
};
|
|
795
|
+
/**
|
|
796
|
+
* POST /agent/sessions/{session_id}/pin
|
|
797
|
+
* Pin Agent Session
|
|
798
|
+
* tier: write · scope: workflows:write
|
|
799
|
+
*/
|
|
800
|
+
pin_agent_session_agent_sessions__session_id__pin_post: {
|
|
801
|
+
input: {
|
|
802
|
+
path: {
|
|
803
|
+
/** Session id. */
|
|
804
|
+
session_id: string;
|
|
805
|
+
};
|
|
806
|
+
headers?: {
|
|
807
|
+
"X-Target-Org-Id"?: string | null;
|
|
808
|
+
};
|
|
809
|
+
body: AgentSessionPinRequest;
|
|
810
|
+
};
|
|
811
|
+
output: ApiResponse_AgentSession_;
|
|
812
|
+
};
|
|
813
|
+
/**
|
|
814
|
+
* POST /agent/chat
|
|
815
|
+
* Post Agent Chat
|
|
816
|
+
* tier: billable · scope: workflows:run
|
|
817
|
+
*/
|
|
818
|
+
post_agent_chat_agent_chat_post: {
|
|
819
|
+
input: {
|
|
820
|
+
headers?: {
|
|
821
|
+
"X-Target-Org-Id"?: string | null;
|
|
822
|
+
};
|
|
823
|
+
body: AgentChatRequest;
|
|
824
|
+
};
|
|
825
|
+
output: ApiResponse_AgentConversationPayload_;
|
|
826
|
+
};
|
|
827
|
+
/**
|
|
828
|
+
* POST /agent/onboarding/catchup
|
|
829
|
+
* Post Agent Onboarding Catchup
|
|
830
|
+
* tier: write · scope: workflows:write
|
|
831
|
+
*/
|
|
832
|
+
post_agent_onboarding_catchup_agent_onboarding_catchup_post: {
|
|
833
|
+
input: {
|
|
834
|
+
headers?: {
|
|
835
|
+
"X-Target-Org-Id"?: string | null;
|
|
836
|
+
};
|
|
837
|
+
body: OnboardingCatchupRequest;
|
|
838
|
+
};
|
|
839
|
+
output: ApiResponse_OnboardingPayload_;
|
|
840
|
+
};
|
|
841
|
+
/**
|
|
842
|
+
* POST /agent/sessions/{session_id}/messages
|
|
843
|
+
* Post Agent Session Message
|
|
844
|
+
* tier: write · scope: workflows:write
|
|
845
|
+
*/
|
|
846
|
+
post_agent_session_message_agent_sessions__session_id__messages_post: {
|
|
847
|
+
input: {
|
|
848
|
+
path: {
|
|
849
|
+
/** Session id (UUID). */
|
|
850
|
+
session_id: string;
|
|
851
|
+
};
|
|
852
|
+
headers?: {
|
|
853
|
+
"X-Target-Org-Id"?: string | null;
|
|
854
|
+
};
|
|
855
|
+
body: AgentSessionMessageRequest;
|
|
856
|
+
};
|
|
857
|
+
output: ApiResponse_AgentConversationPayload_;
|
|
858
|
+
};
|
|
859
|
+
/**
|
|
860
|
+
* POST /agent/onboarding/discovery/project
|
|
861
|
+
* Project Agent Discovery
|
|
862
|
+
* tier: write · scope: workflows:write
|
|
863
|
+
*/
|
|
864
|
+
project_agent_discovery_agent_onboarding_discovery_project_post: {
|
|
865
|
+
input: {
|
|
866
|
+
headers?: {
|
|
867
|
+
"X-Target-Org-Id"?: string | null;
|
|
868
|
+
};
|
|
869
|
+
};
|
|
870
|
+
output: ApiResponse_OnboardingPayload_;
|
|
871
|
+
};
|
|
872
|
+
/**
|
|
873
|
+
* PUT /agent/operators/operating-model
|
|
874
|
+
* Put Agent Operating Model
|
|
875
|
+
* tier: write · scope: workflows:write
|
|
876
|
+
*/
|
|
877
|
+
put_agent_operating_model_agent_operators_operating_model_put: {
|
|
878
|
+
input: {
|
|
879
|
+
headers?: {
|
|
880
|
+
"X-Target-Org-Id"?: string | null;
|
|
881
|
+
};
|
|
882
|
+
body: OperatingModelRequest;
|
|
883
|
+
};
|
|
884
|
+
output: ApiResponse_OperatorPayload_;
|
|
885
|
+
};
|
|
886
|
+
/**
|
|
887
|
+
* POST /agent/sessions/{session_id}/voice/quote
|
|
888
|
+
* Quote Agent Session Voice
|
|
889
|
+
* tier: read · scope: workflows:read
|
|
890
|
+
*/
|
|
891
|
+
quote_agent_session_voice_agent_sessions__session_id__voice_quote_post: {
|
|
892
|
+
input: {
|
|
893
|
+
path: {
|
|
894
|
+
/** Session id (UUID). */
|
|
895
|
+
session_id: string;
|
|
896
|
+
};
|
|
897
|
+
headers?: {
|
|
898
|
+
"X-Target-Org-Id"?: string | null;
|
|
899
|
+
};
|
|
900
|
+
body: VoiceQuoteRequest;
|
|
901
|
+
};
|
|
902
|
+
output: ApiResponse_AgentSessionStatePayload_;
|
|
903
|
+
};
|
|
904
|
+
/**
|
|
905
|
+
* POST /agent/onboarding/discovery/ratify
|
|
906
|
+
* Ratify Agent Discovery
|
|
907
|
+
* tier: write · scope: workflows:write
|
|
908
|
+
*/
|
|
909
|
+
ratify_agent_discovery_agent_onboarding_discovery_ratify_post: {
|
|
910
|
+
input: {
|
|
911
|
+
headers?: {
|
|
912
|
+
"X-Target-Org-Id"?: string | null;
|
|
913
|
+
};
|
|
914
|
+
body: DiscoveryRatifyRequest;
|
|
915
|
+
};
|
|
916
|
+
output: ApiResponse_OnboardingPayload_;
|
|
917
|
+
};
|
|
918
|
+
/**
|
|
919
|
+
* POST /agent/sessions/{session_id}/rename
|
|
920
|
+
* Rename Agent Session
|
|
921
|
+
* tier: write · scope: workflows:write
|
|
922
|
+
*/
|
|
923
|
+
rename_agent_session_agent_sessions__session_id__rename_post: {
|
|
924
|
+
input: {
|
|
925
|
+
path: {
|
|
926
|
+
/** Session id. */
|
|
927
|
+
session_id: string;
|
|
928
|
+
};
|
|
929
|
+
headers?: {
|
|
930
|
+
"X-Target-Org-Id"?: string | null;
|
|
931
|
+
};
|
|
932
|
+
body: AgentSessionRenameRequest;
|
|
933
|
+
};
|
|
934
|
+
output: ApiResponse_AgentSession_;
|
|
935
|
+
};
|
|
936
|
+
/**
|
|
937
|
+
* POST /agent/approvals/{approval_id}/request-changes
|
|
938
|
+
* Request Agent Approval Changes
|
|
939
|
+
* tier: write · scope: workflows:write
|
|
940
|
+
*/
|
|
941
|
+
request_agent_approval_changes_agent_approvals__approval_id__request_changes_post: {
|
|
942
|
+
input: {
|
|
943
|
+
path: {
|
|
944
|
+
/** Approval id (UUID). */
|
|
945
|
+
approval_id: string;
|
|
946
|
+
};
|
|
947
|
+
headers?: {
|
|
948
|
+
"X-Target-Org-Id"?: string | null;
|
|
949
|
+
};
|
|
950
|
+
body: ApprovalChangeRequest;
|
|
951
|
+
};
|
|
952
|
+
output: ApiResponse_AgentBenchPayload_;
|
|
953
|
+
};
|
|
954
|
+
/**
|
|
955
|
+
* POST /agent/mention-search
|
|
956
|
+
* Search Agent Mentions
|
|
957
|
+
* tier: read · scope: workflows:read
|
|
958
|
+
*/
|
|
959
|
+
search_agent_mentions_agent_mention_search_post: {
|
|
960
|
+
input: {
|
|
961
|
+
headers?: {
|
|
962
|
+
"X-Target-Org-Id"?: string | null;
|
|
963
|
+
};
|
|
964
|
+
body: MentionSearchRequest;
|
|
965
|
+
};
|
|
966
|
+
output: ApiResponse_AgentBenchListPayload_;
|
|
967
|
+
};
|
|
968
|
+
/**
|
|
969
|
+
* PUT /agent/operators/{operator}/enabled
|
|
970
|
+
* Set Agent Operator Enabled
|
|
971
|
+
* tier: billable · scope: workflows:run
|
|
972
|
+
*/
|
|
973
|
+
set_agent_operator_enabled_agent_operators__operator__enabled_put: {
|
|
974
|
+
input: {
|
|
975
|
+
path: {
|
|
976
|
+
operator: string;
|
|
977
|
+
};
|
|
978
|
+
headers?: {
|
|
979
|
+
"X-Target-Org-Id"?: string | null;
|
|
980
|
+
};
|
|
981
|
+
body: OperatorEnabledRequest;
|
|
982
|
+
};
|
|
983
|
+
output: ApiResponse_OperatorPayload_;
|
|
984
|
+
};
|
|
985
|
+
/**
|
|
986
|
+
* PUT /agent/operators/{operator}/recipient
|
|
987
|
+
* Set Agent Operator Recipient
|
|
988
|
+
* tier: write · scope: workflows:write
|
|
989
|
+
*/
|
|
990
|
+
set_agent_operator_recipient_agent_operators__operator__recipient_put: {
|
|
991
|
+
input: {
|
|
992
|
+
path: {
|
|
993
|
+
operator: string;
|
|
994
|
+
};
|
|
995
|
+
headers?: {
|
|
996
|
+
"X-Target-Org-Id"?: string | null;
|
|
997
|
+
};
|
|
998
|
+
body: OperatorRecipientRequest;
|
|
999
|
+
};
|
|
1000
|
+
output: ApiResponse_OperatorPayload_;
|
|
1001
|
+
};
|
|
1002
|
+
/**
|
|
1003
|
+
* PUT /agent/operators/{operator}/skills/{skill_key}
|
|
1004
|
+
* Set Agent Operator Trust Dial
|
|
1005
|
+
* tier: billable · scope: workflows:run
|
|
1006
|
+
*/
|
|
1007
|
+
set_agent_operator_trust_dial_agent_operators__operator__skills__skill_key__put: {
|
|
1008
|
+
input: {
|
|
1009
|
+
path: {
|
|
1010
|
+
operator: string;
|
|
1011
|
+
/** Skill key from `GET /agent/operators/{operator}/skills`. */
|
|
1012
|
+
skill_key: string;
|
|
1013
|
+
};
|
|
1014
|
+
headers?: {
|
|
1015
|
+
"X-Target-Org-Id"?: string | null;
|
|
1016
|
+
};
|
|
1017
|
+
body: OperatorTrustDialRequest;
|
|
1018
|
+
};
|
|
1019
|
+
output: ApiResponse_OperatorPayload_;
|
|
1020
|
+
};
|
|
1021
|
+
/**
|
|
1022
|
+
* POST /agent/onboarding/discovery/signals
|
|
1023
|
+
* Setup Agent Discovery Signals
|
|
1024
|
+
* tier: write · scope: workflows:write
|
|
1025
|
+
*/
|
|
1026
|
+
setup_agent_discovery_signals_agent_onboarding_discovery_signals_post: {
|
|
1027
|
+
input: {
|
|
1028
|
+
headers?: {
|
|
1029
|
+
"X-Target-Org-Id"?: string | null;
|
|
1030
|
+
};
|
|
1031
|
+
};
|
|
1032
|
+
output: ApiResponse_OnboardingPayload_;
|
|
1033
|
+
};
|
|
1034
|
+
/**
|
|
1035
|
+
* POST /agent/sessions/{session_id}/voice
|
|
1036
|
+
* Start Agent Session Voice
|
|
1037
|
+
* tier: billable · scope: workflows:run
|
|
1038
|
+
*/
|
|
1039
|
+
start_agent_session_voice_agent_sessions__session_id__voice_post: {
|
|
1040
|
+
input: {
|
|
1041
|
+
path: {
|
|
1042
|
+
/** Session id (UUID). */
|
|
1043
|
+
session_id: string;
|
|
1044
|
+
};
|
|
1045
|
+
headers?: {
|
|
1046
|
+
"X-Target-Org-Id"?: string | null;
|
|
1047
|
+
};
|
|
1048
|
+
body: VoiceSessionRequest;
|
|
1049
|
+
};
|
|
1050
|
+
output: ApiResponse_AgentSessionStatePayload_;
|
|
1051
|
+
};
|
|
1052
|
+
/**
|
|
1053
|
+
* POST /agent/work-items/{work_item_id}/steer
|
|
1054
|
+
* Steer Agent Work Item
|
|
1055
|
+
* tier: write · scope: workflows:write
|
|
1056
|
+
*/
|
|
1057
|
+
steer_agent_work_item_agent_work_items__work_item_id__steer_post: {
|
|
1058
|
+
input: {
|
|
1059
|
+
path: {
|
|
1060
|
+
/** Work item id (UUID). */
|
|
1061
|
+
work_item_id: string;
|
|
1062
|
+
};
|
|
1063
|
+
headers?: {
|
|
1064
|
+
"X-Target-Org-Id"?: string | null;
|
|
1065
|
+
};
|
|
1066
|
+
body: AgentWorkItemSteerRequest;
|
|
1067
|
+
};
|
|
1068
|
+
output: ApiResponse_dict_;
|
|
1069
|
+
};
|
|
1070
|
+
/**
|
|
1071
|
+
* POST /agent/onboarding/domain-response
|
|
1072
|
+
* Submit Agent Domain Response
|
|
1073
|
+
* tier: write · scope: workflows:write
|
|
1074
|
+
*/
|
|
1075
|
+
submit_agent_domain_response_agent_onboarding_domain_response_post: {
|
|
1076
|
+
input: {
|
|
1077
|
+
headers?: {
|
|
1078
|
+
"X-Target-Org-Id"?: string | null;
|
|
1079
|
+
};
|
|
1080
|
+
body: DomainConfirmationRequest;
|
|
1081
|
+
};
|
|
1082
|
+
output: ApiResponse_OnboardingPayload_;
|
|
1083
|
+
};
|
|
1084
|
+
/**
|
|
1085
|
+
* POST /agent/onboarding/discovery/turn
|
|
1086
|
+
* Take Agent Discovery Turn
|
|
1087
|
+
* tier: billable · scope: workflows:run
|
|
1088
|
+
*/
|
|
1089
|
+
take_agent_discovery_turn_agent_onboarding_discovery_turn_post: {
|
|
1090
|
+
input: {
|
|
1091
|
+
headers?: {
|
|
1092
|
+
"X-Target-Org-Id"?: string | null;
|
|
1093
|
+
};
|
|
1094
|
+
body: DiscoveryTurnRequest;
|
|
1095
|
+
};
|
|
1096
|
+
output: ApiResponse_OnboardingPayload_;
|
|
1097
|
+
};
|
|
1098
|
+
/**
|
|
1099
|
+
* PATCH /agent/sessions/{session_id}
|
|
1100
|
+
* Update Agent Session
|
|
1101
|
+
* tier: write · scope: workflows:write
|
|
1102
|
+
*/
|
|
1103
|
+
update_agent_session_agent_sessions__session_id__patch: {
|
|
1104
|
+
input: {
|
|
1105
|
+
path: {
|
|
1106
|
+
/** Session id. */
|
|
1107
|
+
session_id: string;
|
|
1108
|
+
};
|
|
1109
|
+
headers?: {
|
|
1110
|
+
"X-Target-Org-Id"?: string | null;
|
|
1111
|
+
};
|
|
1112
|
+
body: AgentSessionUpdateRequest;
|
|
1113
|
+
};
|
|
1114
|
+
output: ApiResponse_AgentSession_;
|
|
1115
|
+
};
|
|
1116
|
+
}
|
|
1117
|
+
|
|
1118
|
+
// 54 schemas referenced above (the same as G8Contract.<Name>).
|
|
1119
|
+
|
|
1120
|
+
/** An open envelope for a LIST answer, so a bare list keeps its shape. */
|
|
1121
|
+
export interface AgentBenchListPayload {
|
|
1122
|
+
items?: Array<unknown>;
|
|
1123
|
+
[key: string]: unknown;
|
|
1124
|
+
}
|
|
1125
|
+
|
|
1126
|
+
/**
|
|
1127
|
+
* An open envelope for one approval answer.
|
|
1128
|
+
*
|
|
1129
|
+
* Open because an approval carries the plan digest it is bound to, its expiry
|
|
1130
|
+
* and its provenance receipts, and that set has grown twice already. On a
|
|
1131
|
+
* human-in-the-loop surface a dropped field is a guarantee the caller does not
|
|
1132
|
+
* know they lost.
|
|
1133
|
+
*/
|
|
1134
|
+
export type AgentBenchPayload = Record<string, unknown>;
|
|
1135
|
+
|
|
1136
|
+
/** Mirror of `wow_confirm_router.WowConfirmRequest`. */
|
|
1137
|
+
export interface AgentCardConfirmationRequest {
|
|
1138
|
+
/** Per-field overrides for an `edited` card. The shape is the card's own and varies by card kind. */
|
|
1139
|
+
edits?: Record<string, unknown> | null;
|
|
1140
|
+
/** Why, in your words. */
|
|
1141
|
+
note?: string | null;
|
|
1142
|
+
/** `approved` accepts the card as proposed, `edited` accepts it with your `edits`, `rejected` sends it back. Re-sending the same state is a no-op; a different state overwrites. */
|
|
1143
|
+
state: "approved" | "edited" | "rejected";
|
|
1144
|
+
}
|
|
1145
|
+
|
|
1146
|
+
/** Mirror of `agent_runtime.interfaces.routers.chat_router.ChatRequest`. */
|
|
1147
|
+
export interface AgentChatRequest {
|
|
1148
|
+
/** Uploaded file ids to attach, each at most once. */
|
|
1149
|
+
attachment_ids?: Array<string>;
|
|
1150
|
+
/** Your own id for this turn, so a retry is recognised as the same turn rather than said twice. Needs an existing `session_id`. */
|
|
1151
|
+
client_turn_id?: string | null;
|
|
1152
|
+
/** @-mentions from `POST /agent/mention-search`, passed through as returned (`id`, `category`, `display_name`, ...). */
|
|
1153
|
+
mentions?: Array<Record<string, unknown>> | null;
|
|
1154
|
+
/** What you say to the agent. Required unless you attach a file. */
|
|
1155
|
+
message?: string;
|
|
1156
|
+
/** Bias the agent: `web_search`, `deep_thinking` or `research`. Left open, as the app leaves it: an unknown mode is ignored rather than refused. */
|
|
1157
|
+
mode?: string | null;
|
|
1158
|
+
/** Where the user is in your product, so 'this' and 'here' resolve. */
|
|
1159
|
+
page?: string | null;
|
|
1160
|
+
/** Continue this session. Omit to start a new one; the answer carries its `session_id`. */
|
|
1161
|
+
session_id?: string | null;
|
|
1162
|
+
/** Bind a NEW session to this account. Ignored for an existing one. */
|
|
1163
|
+
subject_account_id?: string | null;
|
|
1164
|
+
/** Bind a NEW session to this campaign. Ignored for an existing one. */
|
|
1165
|
+
subject_campaign_id?: string | null;
|
|
1166
|
+
}
|
|
1167
|
+
|
|
1168
|
+
/**
|
|
1169
|
+
* An open envelope for the app's answer.
|
|
1170
|
+
*
|
|
1171
|
+
* Open because the chat answer (`kind`, `message`, `chips`, `sources`,
|
|
1172
|
+
* `work_item_id`, ...) and the oversight feed (`approvals`, `blockers`,
|
|
1173
|
+
* `autonomous_fixes`, `states`, `bounds`) are both still growing, and a
|
|
1174
|
+
* dropped field on an agent surface is one the caller does not know they
|
|
1175
|
+
* lost.
|
|
1176
|
+
*/
|
|
1177
|
+
export type AgentConversationPayload = Record<string, unknown>;
|
|
1178
|
+
|
|
1179
|
+
/**
|
|
1180
|
+
* An open envelope for memory, evidence and the proactive opener.
|
|
1181
|
+
*
|
|
1182
|
+
* Each carries planner or analysis state that changes as the agent platform
|
|
1183
|
+
* does. On an oversight surface a dropped field reads as an agent doing less
|
|
1184
|
+
* than it did, so nothing here is pinned.
|
|
1185
|
+
*/
|
|
1186
|
+
export type AgentPayload = Record<string, unknown>;
|
|
1187
|
+
|
|
1188
|
+
/** One agent chat session. */
|
|
1189
|
+
export interface AgentSession {
|
|
1190
|
+
created_at?: string | null;
|
|
1191
|
+
id?: string | null;
|
|
1192
|
+
is_pinned?: boolean | null;
|
|
1193
|
+
/** Session mode, e.g. `general`. */
|
|
1194
|
+
mode?: string | null;
|
|
1195
|
+
title?: string | null;
|
|
1196
|
+
updated_at?: string | null;
|
|
1197
|
+
[key: string]: unknown;
|
|
1198
|
+
}
|
|
1199
|
+
|
|
1200
|
+
export interface AgentSessionCreateRequest {
|
|
1201
|
+
/** Optional seed messages to open the session with. */
|
|
1202
|
+
messages?: Array<Record<string, unknown>> | null;
|
|
1203
|
+
/** Session mode. */
|
|
1204
|
+
mode?: string;
|
|
1205
|
+
/** Optional title; the app derives one when omitted. */
|
|
1206
|
+
title?: string | null;
|
|
1207
|
+
}
|
|
1208
|
+
|
|
1209
|
+
/** Sessions owned by, or shared with, the principal behind the key. */
|
|
1210
|
+
export interface AgentSessionListResponse {
|
|
1211
|
+
sessions?: Array<AgentSession>;
|
|
1212
|
+
total?: number;
|
|
1213
|
+
[key: string]: unknown;
|
|
1214
|
+
}
|
|
1215
|
+
|
|
1216
|
+
/** Mirror of `messages_router.PostMessageRequest`. */
|
|
1217
|
+
export interface AgentSessionMessageRequest {
|
|
1218
|
+
/** The message text. */
|
|
1219
|
+
content: string;
|
|
1220
|
+
}
|
|
1221
|
+
|
|
1222
|
+
export interface AgentSessionPinRequest {
|
|
1223
|
+
/** True to pin, false to unpin. */
|
|
1224
|
+
is_pinned: boolean;
|
|
1225
|
+
}
|
|
1226
|
+
|
|
1227
|
+
export interface AgentSessionRenameRequest {
|
|
1228
|
+
/** New title. */
|
|
1229
|
+
title: string;
|
|
1230
|
+
}
|
|
1231
|
+
|
|
1232
|
+
/**
|
|
1233
|
+
* An open envelope for a hydration or voice answer.
|
|
1234
|
+
*
|
|
1235
|
+
* Open because session hydration returns the agent's STEPS as well as its
|
|
1236
|
+
* messages, and a step's `detail` is whatever the tool that produced it
|
|
1237
|
+
* reported. That set grows with every tool the platform gains, and a pinned
|
|
1238
|
+
* mirror would drop the detail of exactly the newest ones - which on a
|
|
1239
|
+
* transcript surface reads as the agent having done less than it did.
|
|
1240
|
+
*/
|
|
1241
|
+
export type AgentSessionStatePayload = Record<string, unknown>;
|
|
1242
|
+
|
|
1243
|
+
/** Both fields are optional; omit one to leave it untouched. */
|
|
1244
|
+
export interface AgentSessionUpdateRequest {
|
|
1245
|
+
messages?: Array<Record<string, unknown>> | null;
|
|
1246
|
+
title?: string | null;
|
|
1247
|
+
}
|
|
1248
|
+
|
|
1249
|
+
/** One unit of autonomous work. */
|
|
1250
|
+
export interface AgentWorkItem {
|
|
1251
|
+
agent_id?: string | null;
|
|
1252
|
+
created_at?: string | null;
|
|
1253
|
+
goal?: string | null;
|
|
1254
|
+
id?: string | null;
|
|
1255
|
+
session_id?: string | null;
|
|
1256
|
+
status?: string | null;
|
|
1257
|
+
title?: string | null;
|
|
1258
|
+
updated_at?: string | null;
|
|
1259
|
+
visibility?: string | null;
|
|
1260
|
+
work_item_id?: string | null;
|
|
1261
|
+
[key: string]: unknown;
|
|
1262
|
+
}
|
|
1263
|
+
|
|
1264
|
+
/** Start a unit of autonomous work. */
|
|
1265
|
+
export interface AgentWorkItemCreateRequest {
|
|
1266
|
+
/** Which agent owns it. A known id the planner has a template for - `onboarding`, `dialer_setup`, `sequencer_setup`, `campaign_run`, `voice_setup`, `marketplace`, `dev_setup` - or a free-form value, for which the planner falls back to its `full` template. Left as an open string for that reason: an enum here would reject the ad-hoc case the planner explicitly supports. */
|
|
1267
|
+
agent_id: string;
|
|
1268
|
+
/** Per-session override. Unset, the planner reads the org's own signup entry point as the long-term truth - so omitting this is usually right. */
|
|
1269
|
+
entry_point?: string | null;
|
|
1270
|
+
/** What the agent should achieve. */
|
|
1271
|
+
goal: string;
|
|
1272
|
+
page?: string | null;
|
|
1273
|
+
platform?: ("whatsapp" | "slack" | "roam" | "imessage") | null;
|
|
1274
|
+
/** First user message, so the session opens on the real request. */
|
|
1275
|
+
seed_message?: string | null;
|
|
1276
|
+
/** Sidebar title. Defaults to `title`. */
|
|
1277
|
+
session_title?: string | null;
|
|
1278
|
+
/** `web_search`, `deep_thinking` or `research`. Biases the planner prompt and model tier. Unknown values are IGNORED by the planner rather than rejected, which is why this is not an enum. */
|
|
1279
|
+
skill_mode?: string | null;
|
|
1280
|
+
source?: ("canvas" | "bridge") | null;
|
|
1281
|
+
/** Bind the session to a company. */
|
|
1282
|
+
subject_account_id?: string | null;
|
|
1283
|
+
/** Bind the session to a campaign. */
|
|
1284
|
+
subject_campaign_id?: string | null;
|
|
1285
|
+
title: string;
|
|
1286
|
+
/** Whose work item this is. Defaults to the identity the key was minted under. */
|
|
1287
|
+
user_email?: string | null;
|
|
1288
|
+
/** `private` (default) or `shared` org-wide. The default is the safe one: work started through an API key is not visible to the whole org unless asked for. */
|
|
1289
|
+
visibility?: "shared" | "private";
|
|
1290
|
+
}
|
|
1291
|
+
|
|
1292
|
+
export interface AgentWorkItemList {
|
|
1293
|
+
total?: number;
|
|
1294
|
+
work_items?: Array<AgentWorkItem>;
|
|
1295
|
+
[key: string]: unknown;
|
|
1296
|
+
}
|
|
1297
|
+
|
|
1298
|
+
/**
|
|
1299
|
+
* Redirect a RUNNING work item at its next safe step boundary.
|
|
1300
|
+
*
|
|
1301
|
+
* `extra="forbid"` mirrors the app: an unknown key here is a typo in an
|
|
1302
|
+
* instruction payload, and dropping it silently would let a caller believe
|
|
1303
|
+
* they had steered when they had not.
|
|
1304
|
+
*/
|
|
1305
|
+
export interface AgentWorkItemSteerRequest {
|
|
1306
|
+
/** Caller-generated idempotency key. REQUIRED, and the reason steering is safe to retry: the same id twice comes back `duplicate` rather than queueing a second instruction into a running agent. */
|
|
1307
|
+
client_turn_id: string;
|
|
1308
|
+
/** What to do differently. Applied at the next safe step boundary, not mid-step. */
|
|
1309
|
+
instruction: string;
|
|
1310
|
+
}
|
|
1311
|
+
|
|
1312
|
+
export interface ApiResponse_AgentBenchListPayload_ {
|
|
1313
|
+
data: AgentBenchListPayload;
|
|
1314
|
+
pagination?: PaginationMeta | null;
|
|
1315
|
+
}
|
|
1316
|
+
|
|
1317
|
+
export interface ApiResponse_AgentBenchPayload_ {
|
|
1318
|
+
data: AgentBenchPayload;
|
|
1319
|
+
pagination?: PaginationMeta | null;
|
|
1320
|
+
}
|
|
1321
|
+
|
|
1322
|
+
export interface ApiResponse_AgentConversationPayload_ {
|
|
1323
|
+
data: AgentConversationPayload;
|
|
1324
|
+
pagination?: PaginationMeta | null;
|
|
1325
|
+
}
|
|
1326
|
+
|
|
1327
|
+
export interface ApiResponse_AgentPayload_ {
|
|
1328
|
+
data: AgentPayload;
|
|
1329
|
+
pagination?: PaginationMeta | null;
|
|
1330
|
+
}
|
|
1331
|
+
|
|
1332
|
+
export interface ApiResponse_AgentSessionListResponse_ {
|
|
1333
|
+
data: AgentSessionListResponse;
|
|
1334
|
+
pagination?: PaginationMeta | null;
|
|
1335
|
+
}
|
|
1336
|
+
|
|
1337
|
+
export interface ApiResponse_AgentSessionStatePayload_ {
|
|
1338
|
+
data: AgentSessionStatePayload;
|
|
1339
|
+
pagination?: PaginationMeta | null;
|
|
1340
|
+
}
|
|
1341
|
+
|
|
1342
|
+
export interface ApiResponse_AgentSession_ {
|
|
1343
|
+
data: AgentSession;
|
|
1344
|
+
pagination?: PaginationMeta | null;
|
|
1345
|
+
}
|
|
1346
|
+
|
|
1347
|
+
export interface ApiResponse_AgentWorkItemList_ {
|
|
1348
|
+
data: AgentWorkItemList;
|
|
1349
|
+
pagination?: PaginationMeta | null;
|
|
1350
|
+
}
|
|
1351
|
+
|
|
1352
|
+
export interface ApiResponse_AgentWorkItem_ {
|
|
1353
|
+
data: AgentWorkItem;
|
|
1354
|
+
pagination?: PaginationMeta | null;
|
|
1355
|
+
}
|
|
1356
|
+
|
|
1357
|
+
export interface ApiResponse_OnboardingPayload_ {
|
|
1358
|
+
data: OnboardingPayload;
|
|
1359
|
+
pagination?: PaginationMeta | null;
|
|
1360
|
+
}
|
|
1361
|
+
|
|
1362
|
+
export interface ApiResponse_OperatorListPayload_ {
|
|
1363
|
+
data: OperatorListPayload;
|
|
1364
|
+
pagination?: PaginationMeta | null;
|
|
1365
|
+
}
|
|
1366
|
+
|
|
1367
|
+
export interface ApiResponse_OperatorPayload_ {
|
|
1368
|
+
data: OperatorPayload;
|
|
1369
|
+
pagination?: PaginationMeta | null;
|
|
1370
|
+
}
|
|
1371
|
+
|
|
1372
|
+
export interface ApiResponse_dict_ {
|
|
1373
|
+
data: Record<string, unknown>;
|
|
1374
|
+
pagination?: PaginationMeta | null;
|
|
1375
|
+
}
|
|
1376
|
+
|
|
1377
|
+
/** Mirror of `RequestChangesBody`. */
|
|
1378
|
+
export interface ApprovalChangeRequest {
|
|
1379
|
+
/** Why the proposal is wrong, and what to do instead. REQUIRED and not decoration: it is stored on the rejection and is what the next plan is built from, so an empty-handed rejection produces the same plan again. */
|
|
1380
|
+
feedback: string;
|
|
1381
|
+
}
|
|
1382
|
+
|
|
1383
|
+
/** Mirror of `load_intent_context.router.LoadIntentContextRequest`. */
|
|
1384
|
+
export interface CopilotContextLoadRequest {
|
|
1385
|
+
/** Narrow the context to one company. */
|
|
1386
|
+
company_id?: number | null;
|
|
1387
|
+
/** Narrow the context to one contact. */
|
|
1388
|
+
contact_id?: number | null;
|
|
1389
|
+
/** The buyer-intent keyword to open a conversation about. */
|
|
1390
|
+
keyword_id: string;
|
|
1391
|
+
}
|
|
1392
|
+
|
|
1393
|
+
/**
|
|
1394
|
+
* Mirror of `DiscoveryAnswerRequest`.
|
|
1395
|
+
*
|
|
1396
|
+
* `grade` is the customer's own confidence in the answer and it is REQUIRED
|
|
1397
|
+
* on the app model - it has no default there, so omitting it would raise
|
|
1398
|
+
* inside the proxy rather than 422 here.
|
|
1399
|
+
*/
|
|
1400
|
+
export interface DiscoveryAnswerRequest {
|
|
1401
|
+
/** Which discovery field this answers. */
|
|
1402
|
+
field_key: string;
|
|
1403
|
+
/** Confidence in the answer: `green` (certain), `amber` (a working assumption) or `red` (a guess). Amber and red answers come back in `coverage.amber_fields` so they can be revisited. */
|
|
1404
|
+
grade: string;
|
|
1405
|
+
/** Interview move this answers. */
|
|
1406
|
+
move_number?: number | null;
|
|
1407
|
+
/** Canvas session to report into. */
|
|
1408
|
+
session_id?: string | null;
|
|
1409
|
+
/** Who supplied it. Defaults to `user`. */
|
|
1410
|
+
source?: string;
|
|
1411
|
+
/** The answer. Shape depends on the field. */
|
|
1412
|
+
value?: unknown;
|
|
1413
|
+
}
|
|
1414
|
+
|
|
1415
|
+
/**
|
|
1416
|
+
* Mirror of `DiscoveryRatifyRequest`.
|
|
1417
|
+
*
|
|
1418
|
+
* Both collections default to empty, matching the app: ratifying nothing is a
|
|
1419
|
+
* legal no-op rather than a 422, which is what makes the call safe to retry.
|
|
1420
|
+
*/
|
|
1421
|
+
export interface DiscoveryRatifyRequest {
|
|
1422
|
+
/** Field keys the customer accepts as the agent inferred them. */
|
|
1423
|
+
confirmed?: Array<string>;
|
|
1424
|
+
/** Field key -> corrected value, for answers the agent got wrong. */
|
|
1425
|
+
edits?: Record<string, unknown>;
|
|
1426
|
+
/** Canvas session to report the ratification into. */
|
|
1427
|
+
session_id?: string | null;
|
|
1428
|
+
}
|
|
1429
|
+
|
|
1430
|
+
/**
|
|
1431
|
+
* Mirror of `DiscoveryTurnRequest`.
|
|
1432
|
+
*
|
|
1433
|
+
* There is deliberately NO `history` field, and that is load-bearing rather
|
|
1434
|
+
* than an omission. The app removed one: the panel used to keep the
|
|
1435
|
+
* transcript in browser state and ship it back on every turn, so a reload
|
|
1436
|
+
* destroyed the customer's whole kickoff. The server re-grounds from the
|
|
1437
|
+
* durable record instead. A caller-supplied transcript is not something the
|
|
1438
|
+
* server can verify, and accepting one here would re-open exactly that hole.
|
|
1439
|
+
*/
|
|
1440
|
+
export interface DiscoveryTurnRequest {
|
|
1441
|
+
message: string;
|
|
1442
|
+
/** Canvas session to report into. */
|
|
1443
|
+
session_id?: string | null;
|
|
1444
|
+
}
|
|
1445
|
+
|
|
1446
|
+
/** Mirror of `DomainResponseRequest`. */
|
|
1447
|
+
export interface DomainConfirmationRequest {
|
|
1448
|
+
/** The `domain_confirmation` card id. */
|
|
1449
|
+
card_id: string;
|
|
1450
|
+
/** True = the pre-filled domain is correct as it stands. */
|
|
1451
|
+
confirmed: boolean;
|
|
1452
|
+
/** The corrected company domain. REQUIRED when `confirmed` is false; ignored when it is true. */
|
|
1453
|
+
domain?: string | null;
|
|
1454
|
+
/** The proactive-setup canvas session id. */
|
|
1455
|
+
session_id: string;
|
|
1456
|
+
}
|
|
1457
|
+
|
|
1458
|
+
/** Mirror of `CaptureEntryPointRequest`. */
|
|
1459
|
+
export interface EntryPointCaptureRequest {
|
|
1460
|
+
/** The signup entry point. Maps 1:1 to a plan template, so this chooses what the agent will propose doing first. FIRST WRITER WINS: if the org already has one captured, this call reports the existing value and changes nothing. */
|
|
1461
|
+
entry_point: "dialer" | "sequencer" | "marketplace" | "dev" | "calendar" | "email_inbox" | "full";
|
|
1462
|
+
}
|
|
1463
|
+
|
|
1464
|
+
/** Mirror of `MentionSearchRequest`. */
|
|
1465
|
+
export interface MentionSearchRequest {
|
|
1466
|
+
/** Bias results toward one campaign's people and documents. */
|
|
1467
|
+
campaign_id?: string | null;
|
|
1468
|
+
/** Which mention vocabulary to search. Left open rather than closed to a Literal: the app treats an unrecognised mode as 'no filter' instead of an error, so closing it here would turn a working call into a 422. */
|
|
1469
|
+
mode?: string | null;
|
|
1470
|
+
/** Substring to match. Empty - the default - returns the default suggestions rather than nothing, matching the app's own composer. */
|
|
1471
|
+
query?: string;
|
|
1472
|
+
}
|
|
1473
|
+
|
|
1474
|
+
/** Mirror of `OnboardingCatchupRequest`. */
|
|
1475
|
+
export interface OnboardingCatchupRequest {
|
|
1476
|
+
/** The proactive-setup canvas session id. */
|
|
1477
|
+
session_id: string;
|
|
1478
|
+
}
|
|
1479
|
+
|
|
1480
|
+
/**
|
|
1481
|
+
* An open envelope for an onboarding or discovery result.
|
|
1482
|
+
*
|
|
1483
|
+
* Open on purpose. Discovery state carries a per-field coverage matrix whose
|
|
1484
|
+
* field set is the product's own onboarding questionnaire - it changes as the
|
|
1485
|
+
* questionnaire does, and a pinned mirror would silently DROP a field the
|
|
1486
|
+
* customer had answered. On a surface whose whole job is "what do we still
|
|
1487
|
+
* not know about you", a dropped field reads as an answered question.
|
|
1488
|
+
*/
|
|
1489
|
+
export type OnboardingPayload = Record<string, unknown>;
|
|
1490
|
+
|
|
1491
|
+
/**
|
|
1492
|
+
* Mirror of `OperatingModelUpdate`.
|
|
1493
|
+
*
|
|
1494
|
+
* `override` is an open object and stays that way. It is the organisation's
|
|
1495
|
+
* operating-model document - which motions it runs, what it calls them - and
|
|
1496
|
+
* it is validated by the service against the live model definition rather
|
|
1497
|
+
* than by a shape frozen into this contract. Pinning it would refuse a key a
|
|
1498
|
+
* newer platform version understands.
|
|
1499
|
+
*/
|
|
1500
|
+
export interface OperatingModelRequest {
|
|
1501
|
+
/** The organisation's operating-model override, REPLACED WHOLE. This is a PUT: keys absent from the body are removed, not left alone. Read `GET /agent/operators/operating-model` first and send it back modified. */
|
|
1502
|
+
override: Record<string, unknown>;
|
|
1503
|
+
}
|
|
1504
|
+
|
|
1505
|
+
/**
|
|
1506
|
+
* Mirror of `ApprovalDecision`.
|
|
1507
|
+
*
|
|
1508
|
+
* `resolution` is closed to the two values the app accepts. The app answers
|
|
1509
|
+
* anything else with a 400 after lower-casing it; closing it here makes a bad
|
|
1510
|
+
* value a 422 that names the valid ones.
|
|
1511
|
+
*/
|
|
1512
|
+
export interface OperatorApprovalDecisionRequest {
|
|
1513
|
+
/** Values a fix needs that the operator could not decide for you, e.g. `{"target_user": "<user id>"}`. Omit for a fully-specified fix. A value the fix refuses is a 400 naming the field, and the task stays open. */
|
|
1514
|
+
params?: Record<string, string> | null;
|
|
1515
|
+
/** `approved` EXECUTES the finding's proposed fix against your data; `rejected` records the decision and executes nothing. */
|
|
1516
|
+
resolution: "approved" | "rejected";
|
|
1517
|
+
}
|
|
1518
|
+
|
|
1519
|
+
/** Mirror of `EnabledUpdate`. */
|
|
1520
|
+
export interface OperatorEnabledRequest {
|
|
1521
|
+
/** Whether this operator runs for the organisation. TURNING IT ON STARTS UNATTENDED WORK: the operator's monitors run on their own schedule from then on, without a person asking. Explicit rather than a toggle, so a retried request is idempotent instead of flipping the state back. */
|
|
1522
|
+
enabled: boolean;
|
|
1523
|
+
}
|
|
1524
|
+
|
|
1525
|
+
/** An open envelope for a LIST answer, so a bare list keeps its shape. */
|
|
1526
|
+
export interface OperatorListPayload {
|
|
1527
|
+
items?: Array<unknown>;
|
|
1528
|
+
[key: string]: unknown;
|
|
1529
|
+
}
|
|
1530
|
+
|
|
1531
|
+
/**
|
|
1532
|
+
* An open envelope for one operator answer.
|
|
1533
|
+
*
|
|
1534
|
+
* Open because an operator's health snapshot, scorecard and catalog are
|
|
1535
|
+
* per-operator documents whose shape follows what that operator monitors -
|
|
1536
|
+
* the revenue operator reports different checks from the deliverability one,
|
|
1537
|
+
* and both grow. On an OVERSIGHT surface a dropped field reads as "nothing to
|
|
1538
|
+
* worry about" rather than "we did not tell you", which is the failure mode
|
|
1539
|
+
* worth designing against.
|
|
1540
|
+
*/
|
|
1541
|
+
export type OperatorPayload = Record<string, unknown>;
|
|
1542
|
+
|
|
1543
|
+
/** Mirror of `RecipientUpdate`. */
|
|
1544
|
+
export interface OperatorRecipientRequest {
|
|
1545
|
+
/** The person who receives this operator's alerts and owns its approval tasks. One recipient per operator: setting it REPLACES whoever was there. */
|
|
1546
|
+
user_id: string;
|
|
1547
|
+
}
|
|
1548
|
+
|
|
1549
|
+
/** Mirror of `TrustDialUpdate`, with `autonomy` closed to the shipped set. */
|
|
1550
|
+
export interface OperatorTrustDialRequest {
|
|
1551
|
+
/** How far this skill may go on its own. `OFF` - do not run it. `DETECT` - look, and record what it finds. `PROPOSE` - look, and raise an approval task a person decides. `AUTO` - act and log, with no human in the loop. THIS IS A REQUEST, NOT A GUARANTEE: the effective level is the MINIMUM of this dial, the skill's own graph8-managed risk cap and the platform ceiling, so a skill capped at `PROPOSE` stays at `PROPOSE` however this is set. Read the response, and `GET /agent/operators/{operator}/skills`, for what the dial actually resolved to. */
|
|
1552
|
+
autonomy: "OFF" | "DETECT" | "PROPOSE" | "AUTO";
|
|
1553
|
+
}
|
|
1554
|
+
|
|
1555
|
+
export interface PaginationMeta {
|
|
1556
|
+
/** Whether there are more pages */
|
|
1557
|
+
has_next: boolean;
|
|
1558
|
+
/** Items per page */
|
|
1559
|
+
limit: number;
|
|
1560
|
+
/** Opaque cursor for the next page; null when there are no more items. Pass it back as the `cursor` query param to fetch the following page without computing page numbers. */
|
|
1561
|
+
next_cursor?: string | null;
|
|
1562
|
+
/** Current page number (1-indexed) */
|
|
1563
|
+
page: number;
|
|
1564
|
+
/** Total number of items */
|
|
1565
|
+
total: number;
|
|
1566
|
+
}
|
|
1567
|
+
|
|
1568
|
+
/** Mirror of `SessionReadRequest`. */
|
|
1569
|
+
export interface SessionReadRequest {
|
|
1570
|
+
/** How many messages the caller has actually seen. NOT a flag: the server refuses a count higher than the session holds with a 409, because a client claiming to have read messages that do not exist yet is a stale client, and silently accepting it would mark a later real message read before anyone saw it. */
|
|
1571
|
+
message_count: number;
|
|
1572
|
+
}
|
|
1573
|
+
|
|
1574
|
+
/**
|
|
1575
|
+
* Mirror of `CaptureAttributionRequest`.
|
|
1576
|
+
*
|
|
1577
|
+
* Every field is optional and every length cap is the app's, so a value this
|
|
1578
|
+
* contract accepts is one the handler accepts too.
|
|
1579
|
+
*/
|
|
1580
|
+
export interface SignupAttributionRequest {
|
|
1581
|
+
/** Signup entry-point slug. */
|
|
1582
|
+
entry_point?: string | null;
|
|
1583
|
+
fbclid?: string | null;
|
|
1584
|
+
gbraid?: string | null;
|
|
1585
|
+
gclid?: string | null;
|
|
1586
|
+
landing_at?: string | null;
|
|
1587
|
+
landing_page_url?: string | null;
|
|
1588
|
+
signup_referrer?: string | null;
|
|
1589
|
+
utm_campaign?: string | null;
|
|
1590
|
+
utm_content?: string | null;
|
|
1591
|
+
utm_id?: string | null;
|
|
1592
|
+
utm_medium?: string | null;
|
|
1593
|
+
utm_source?: string | null;
|
|
1594
|
+
utm_term?: string | null;
|
|
1595
|
+
wbraid?: string | null;
|
|
1596
|
+
}
|
|
1597
|
+
|
|
1598
|
+
/** Mirror of `VoiceDraftRequest`. */
|
|
1599
|
+
export interface VoiceDraftRequest {
|
|
1600
|
+
/** The id the new session will have - CALLER-GENERATED, not server-assigned. That is what lets a client open the socket and create the row without a round trip between them. Reusing an id does not create a second session. */
|
|
1601
|
+
session_id: string;
|
|
1602
|
+
}
|
|
1603
|
+
|
|
1604
|
+
/** Mirror of `VoiceQuoteRequest`, including its `extra="forbid"`. */
|
|
1605
|
+
export interface VoiceQuoteRequest {
|
|
1606
|
+
/** Ceiling on spoken input to price for. */
|
|
1607
|
+
max_input_seconds?: number;
|
|
1608
|
+
/** Ceiling on synthesised output to price for. */
|
|
1609
|
+
max_output_characters?: number;
|
|
1610
|
+
/** Which voice to price. */
|
|
1611
|
+
voice_id: string;
|
|
1612
|
+
}
|
|
1613
|
+
|
|
1614
|
+
/** Mirror of `VoiceSessionRequest`, including its `extra="forbid"`. */
|
|
1615
|
+
export interface VoiceSessionRequest {
|
|
1616
|
+
/** HARD CEILING on what this session may spend. Required, with no default: an uncapped voice session is an open-ended charge, and a contract that defaults it would be choosing a spending limit on the customer's behalf. */
|
|
1617
|
+
max_credits: number;
|
|
1618
|
+
/** The rate version the quote was issued against, from `POST /agent/sessions/{session_id}/voice/quote`. The server refuses a stale one rather than charging today's price for yesterday's quote. */
|
|
1619
|
+
rate_version: string;
|
|
1620
|
+
/** Which voice to speak with. */
|
|
1621
|
+
voice_id: string;
|
|
1622
|
+
}
|