@roarkanalytics/cli 0.73.1 → 0.74.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/CHANGELOG.md +11 -0
- package/README.md +191 -148
- package/commands.js +2868 -944
- package/completions.js +4 -4
- package/man/roark-agent-build.1 +3 -3
- package/man/roark-agent-conversation-create.1 +106 -0
- package/man/roark-agent-create.1 +27 -3
- package/man/roark-agent-draft-update.1 +4 -1
- package/man/roark-agent-endpoint-create.1 +5 -5
- package/man/roark-agent-endpoint-get.1 +1 -1
- package/man/roark-agent-get.1 +1 -1
- package/man/roark-autoimprove-job-cancel.1 +1 -1
- package/man/roark-autoimprove-job-dismiss.1 +1 -1
- package/man/roark-autoimprove-job-guidance-send.1 +1 -1
- package/man/roark-autoimprove-job-promote.1 +1 -1
- package/man/roark-benchmark-target-history-list.1 +1 -1
- package/man/roark-call-get.1 +1 -1
- package/man/roark-connections-agent-backfill-cancel.1 +96 -0
- package/man/roark-connections-agent-backfill-create.1 +97 -0
- package/man/roark-connections-agent-backfill-list.1 +93 -0
- package/man/roark-connections-agent-create.1 +124 -0
- package/man/roark-connections-agent-delete.1 +93 -0
- package/man/roark-connections-agent-discover.1 +96 -0
- package/man/roark-connections-agent-get.1 +93 -0
- package/man/roark-connections-agent-list.1 +93 -0
- package/man/roark-connections-agent-provider-list.1 +89 -0
- package/man/roark-connections-agent-update.1 +128 -0
- package/man/roark-connections-calendar-calendar-list.1 +93 -0
- package/man/roark-connections-calendar-calendly-oauth-start.1 +99 -0
- package/man/{roark-calendar-connection-check.1 → roark-connections-calendar-check.1} +5 -5
- package/man/{roark-calendar-connection-create.1 → roark-connections-calendar-create.1} +7 -7
- package/man/{roark-calendar-connection-delete.1 → roark-connections-calendar-delete.1} +5 -5
- package/man/{roark-calendar-connection-get.1 → roark-connections-calendar-get.1} +5 -5
- package/man/roark-connections-calendar-google-oauth-start.1 +102 -0
- package/man/{roark-calendar-connection-list.1 → roark-connections-calendar-list.1} +6 -6
- package/man/roark-connections-calendar-target-create.1 +124 -0
- package/man/roark-connections-calendar-target-delete.1 +96 -0
- package/man/{roark-calendar-connection-target-get.1 → roark-connections-calendar-target-get.1} +5 -5
- package/man/{roark-calendar-connection-target-list.1 → roark-connections-calendar-target-list.1} +5 -5
- package/man/roark-connections-calendar-target-update.1 +124 -0
- package/man/{roark-calendar-connection-update.1 → roark-connections-calendar-update.1} +5 -5
- package/man/roark-connections-mcp-server-create.1 +105 -0
- package/man/roark-connections-mcp-server-delete.1 +93 -0
- package/man/roark-connections-mcp-server-discover.1 +99 -0
- package/man/roark-connections-mcp-server-get.1 +93 -0
- package/man/roark-connections-mcp-server-list.1 +89 -0
- package/man/roark-connections-mcp-server-refresh.1 +93 -0
- package/man/roark-connections-mcp-server-update.1 +100 -0
- package/man/roark-conversation-get.1 +93 -0
- package/man/roark-credential-create.1 +2 -2
- package/man/roark-credential-list.1 +2 -2
- package/man/roark-credential-revoke.1 +2 -2
- package/man/{roark-customer-profile-attribute-delete.1 → roark-customer-attribute-delete.1} +5 -5
- package/man/{roark-customer-profile-attribute-unlock.1 → roark-customer-attribute-unlock.1} +5 -5
- package/man/{roark-customer-profile-attribute-update.1 → roark-customer-attribute-update.1} +5 -5
- package/man/{roark-customer-profile-conversation-list.1 → roark-customer-conversation-list.1} +5 -5
- package/man/{roark-customer-profile-delete.1 → roark-customer-delete.1} +6 -6
- package/man/roark-customer-field-create.1 +105 -0
- package/man/roark-customer-field-delete.1 +93 -0
- package/man/roark-customer-field-list.1 +89 -0
- package/man/roark-customer-field-update.1 +106 -0
- package/man/roark-customer-flow-edge-case-create.1 +1 -1
- package/man/roark-customer-flow-edge-case-update.1 +1 -1
- package/man/roark-customer-flow-folder-create.1 +99 -0
- package/man/roark-customer-flow-folder-delete.1 +93 -0
- package/man/roark-customer-flow-folder-list.1 +89 -0
- package/man/roark-customer-flow-get.1 +1 -1
- package/man/roark-customer-flow-happy-path-update.1 +1 -1
- package/man/roark-customer-flow-list.1 +3 -0
- package/man/roark-customer-flow-update.1 +4 -1
- package/man/{roark-customer-profile-get.1 → roark-customer-get.1} +6 -6
- package/man/{roark-customer-profile-list.1 → roark-customer-list.1} +8 -8
- package/man/{roark-customer-profile-notes-update.1 → roark-customer-notes-update.1} +5 -5
- package/man/roark-dashboard-list.1 +1 -1
- package/man/roark-dashboard-update.1 +1 -1
- package/man/roark-http-request-definition-create.1 +1 -1
- package/man/roark-http-request-definition-get.1 +1 -1
- package/man/roark-http-request-definition-update.1 +1 -1
- package/man/roark-metric-collection-job-get.1 +1 -1
- package/man/roark-metric-definition-create.1 +1 -1
- package/man/roark-metric-definition-update.1 +1 -1
- package/man/roark-metric-policy-create.1 +1 -1
- package/man/roark-metric-policy-get.1 +1 -1
- package/man/roark-metric-variant-list.1 +1 -1
- package/man/roark-metric-variant-update.1 +1 -1
- package/man/roark-project-list.1 +1 -1
- package/man/roark-simulation-environment-create.1 +12 -0
- package/man/roark-simulation-environment-get.1 +1 -1
- package/man/roark-simulation-environment-update.1 +12 -0
- package/man/roark-simulation-group-create.1 +2 -2
- package/man/roark-simulation-group-delete.1 +1 -1
- package/man/roark-simulation-group-get.1 +1 -1
- package/man/roark-simulation-group-list.1 +1 -1
- package/man/roark-simulation-group-run.1 +2 -2
- package/man/roark-simulation-group-update.1 +1 -1
- package/man/roark-simulation-job-get.1 +1 -1
- package/man/roark-simulation-job-lookup.1 +1 -1
- package/man/roark-simulation-persona-create.1 +1 -1
- package/man/roark-simulation-persona-get.1 +1 -1
- package/man/roark-simulation-persona-update.1 +1 -1
- package/man/roark-simulation-plan-get.1 +1 -1
- package/man/roark-simulation-plan-job-cancel.1 +1 -1
- package/man/roark-simulation-plan-job-cost-get.1 +1 -1
- package/man/roark-simulation-plan-job-debrief-create.1 +1 -1
- package/man/roark-simulation-plan-job-delete.1 +1 -1
- package/man/roark-simulation-plan-job-get.1 +1 -1
- package/man/roark-simulation-plan-job-list.1 +1 -1
- package/man/roark-simulation-plan-job-result-get.1 +1 -1
- package/man/roark-simulation-plan-update.1 +7 -1
- package/man/roark-simulation-resource-generate.1 +120 -0
- package/man/roark-simulation-resource-generation-answer.1 +97 -0
- package/man/roark-simulation-resource-generation-cancel.1 +93 -0
- package/man/roark-simulation-resource-generation-get.1 +93 -0
- package/man/roark-simulation-resource-generation-guidance-send.1 +97 -0
- package/man/roark-simulation-resource-generation-list.1 +96 -0
- package/man/roark-simulation-run-group-list.1 +1 -1
- package/man/roark-tool-create.1 +32 -2
- package/man/roark-tool-update.1 +32 -2
- package/man/roark-usage-get.1 +1 -1
- package/man/roark-webhook-create.1 +2 -2
- package/man/roark-webhook-delete.1 +1 -1
- package/man/roark-webhook-get.1 +1 -1
- package/man/roark-whoami.1 +1 -1
- package/man/roark.1 +208 -94
- package/npm-shrinkwrap.json +6 -6
- package/package.json +56 -18
- package/version.d.ts +1 -1
- package/version.js +1 -1
package/man/roark-agent-build.1
CHANGED
|
@@ -24,7 +24,7 @@ Optional display name of the agent's voice. The authored prompt matches its deli
|
|
|
24
24
|
Optional provider voice the hosted agent speaks with Optional.
|
|
25
25
|
.TP
|
|
26
26
|
\fB\-\-tts.provider\fR \fI<value>\fR
|
|
27
|
-
Text\-to\-speech provider, for example ELEVENLABS One of: CARTESIA, ELEVENLABS, OPENAI, RIME. Required.
|
|
27
|
+
Text\-to\-speech provider, for example ELEVENLABS One of: CARTESIA, ELEVENLABS, OPENAI, RIME, ASSEMBLYAI, DEEPGRAM, FISH_AUDIO. Required.
|
|
28
28
|
.TP
|
|
29
29
|
\fB\-\-tts.voice\-id\fR \fI<value>\fR
|
|
30
30
|
The provider's id for the voice Required.
|
|
@@ -36,7 +36,7 @@ The provider's voice model, for example eleven_flash_v2_5. Its current one when
|
|
|
36
36
|
Optional transcriber the hosted agent hears with. Roark's default when omitted Optional.
|
|
37
37
|
.TP
|
|
38
38
|
\fB\-\-stt.provider\fR \fI<value>\fR
|
|
39
|
-
Speech\-to\-text provider, for example DEEPGRAM One of: DEEPGRAM, OPENAI_WHISPER, SPEECHMATICS, ASSEMBLYAI, ELEVENLABS. Required.
|
|
39
|
+
Speech\-to\-text provider, for example DEEPGRAM One of: DEEPGRAM, OPENAI_WHISPER, SPEECHMATICS, ASSEMBLYAI, ELEVENLABS, SONIOX. Required.
|
|
40
40
|
.TP
|
|
41
41
|
\fB\-\-stt.model\fR \fI<value>\fR
|
|
42
42
|
The provider's model id, for example nova\-3 Required.
|
|
@@ -45,7 +45,7 @@ The provider's model id, for example nova\-3 Required.
|
|
|
45
45
|
Optional text model the hosted agent thinks with. Roark's default when omitted Optional.
|
|
46
46
|
.TP
|
|
47
47
|
\fB\-\-llm.provider\fR \fI<value>\fR
|
|
48
|
-
Text model provider, for example OPENAI One of: OPENAI, ANTHROPIC, GOOGLE, XAI, ULTRAVOX, AWS, ELEVENLABS. Required.
|
|
48
|
+
Text model provider, for example OPENAI One of: OPENAI, ANTHROPIC, GOOGLE, XAI, ULTRAVOX, AWS, ELEVENLABS, GROQ, META, RIME, PHONIC. Required.
|
|
49
49
|
.TP
|
|
50
50
|
\fB\-\-llm.model\fR \fI<value>\fR
|
|
51
51
|
The provider's model id, for example gpt\-4.1 Required.
|
|
@@ -0,0 +1,106 @@
|
|
|
1
|
+
.\" File generated from our OpenAPI spec by app-agent-codegen. Do not edit.
|
|
2
|
+
.TH "ROARK\-AGENT\-CONVERSATION\-CREATE" "1" "" "roark-agent-conversation-create" "Roark Analytics API Manual"
|
|
3
|
+
.SH "NAME"
|
|
4
|
+
roark\-agent\-conversation\-create \- Start a conversation with an agent
|
|
5
|
+
.SH "SYNOPSIS"
|
|
6
|
+
.B roark agent conversation create
|
|
7
|
+
\fIagent\-id\fR [\fIoptions\fR]
|
|
8
|
+
.SH "DESCRIPTION"
|
|
9
|
+
Starts a voice conversation (`modality: voice`) or chat (`modality: chat`) with this Roark\-hosted agent and returns its id right away. `channel: web` is a conversation in a browser on your site. Call this endpoint from your server, never the browser: it needs your API key. Give the page only `web.clientToken`; the web SDK spends it to join from one of `allowedOrigins` before `web.clientTokenExpiresAt`. Read it back with `GET /v1/conversation/{conversationId}` straight away: `PENDING` until the browser joins, `IN_PROGRESS`, then `ENDED`. One nobody joins ends without ever starting and is never billed. Starting a voice conversation needs `call:create`, a chat `chat:create`, and the agent a published version that takes that kind.
|
|
10
|
+
.SH "API"
|
|
11
|
+
POST /v1/agent/{agentId}/conversations
|
|
12
|
+
.SH "ARGUMENTS"
|
|
13
|
+
.TP
|
|
14
|
+
\fIagent\-id\fR
|
|
15
|
+
The agent\-id.
|
|
16
|
+
.SH "OPTIONS"
|
|
17
|
+
.TP
|
|
18
|
+
\fB\-\-modality\fR \fI<value>\fR
|
|
19
|
+
`voice` or `chat`. The agent must have that modality turned on. One of: voice, chat, call. Required.
|
|
20
|
+
.TP
|
|
21
|
+
\fB\-\-channel\fR \fI<value>\fR
|
|
22
|
+
How it is reached. `web`: in a browser on one of `allowedOrigins`, joined with the web SDK. One of: web. Required.
|
|
23
|
+
.TP
|
|
24
|
+
\fB\-\-allowed\-origins\fR \fI<value>\fR
|
|
25
|
+
The origins your page may join from, exactly as the browser sends them: https only (http on localhost for development), no paths or wildcards. Repeatable. Required.
|
|
26
|
+
.TP
|
|
27
|
+
\fB\-\-client\-token\-ttl\-seconds\fR \fI<value>\fR
|
|
28
|
+
How long the browser has to join, in seconds. Default 120. Optional.
|
|
29
|
+
.SH "GLOBAL OPTIONS"
|
|
30
|
+
.TP
|
|
31
|
+
\fB\-\-data\fR \fI<json>\fR
|
|
32
|
+
Request body as JSON, or @file to read one (@\- for stdin).
|
|
33
|
+
.TP
|
|
34
|
+
\fB\-y\fR, \fB\-\-yes\fR
|
|
35
|
+
Skip confirmation prompts.
|
|
36
|
+
.TP
|
|
37
|
+
\fB\-\-no\-input\fR
|
|
38
|
+
Never prompt; fail instead.
|
|
39
|
+
.TP
|
|
40
|
+
\fB\-\-base\-url\fR \fI<url>\fR
|
|
41
|
+
API base URL.
|
|
42
|
+
.TP
|
|
43
|
+
\fB\-\-token\fR \fI<token>\fR
|
|
44
|
+
Bearer token. Prefer ROARK_API_BEARER_TOKEN or the stored credential.
|
|
45
|
+
.TP
|
|
46
|
+
\fB\-\-timeout\fR \fI<ms>\fR
|
|
47
|
+
Request timeout in milliseconds.
|
|
48
|
+
.TP
|
|
49
|
+
\fB\-\-max\-retries\fR \fI<count>\fR
|
|
50
|
+
Retries for retryable failures.
|
|
51
|
+
.TP
|
|
52
|
+
\fB\-\-format\fR \fI<format>\fR
|
|
53
|
+
Output format: auto, json, jsonl, plain.
|
|
54
|
+
.TP
|
|
55
|
+
\fB\-\-json\fR
|
|
56
|
+
Shorthand for \-\-format json.
|
|
57
|
+
.TP
|
|
58
|
+
\fB\-\-no\-color\fR
|
|
59
|
+
Disable colour.
|
|
60
|
+
.TP
|
|
61
|
+
\fB\-q\fR, \fB\-\-quiet\fR
|
|
62
|
+
Suppress non\-essential output.
|
|
63
|
+
.TP
|
|
64
|
+
\fB\-\-allow\-project\-base\-url\fR
|
|
65
|
+
Send the stored credential to a base URL set by a project .roark.json. Refused by default.
|
|
66
|
+
.SH "EXAMPLES"
|
|
67
|
+
.PP
|
|
68
|
+
.RS 4
|
|
69
|
+
.nf
|
|
70
|
+
roark agent conversation create <agent\-id> \-\-modality <value> \-\-channel <value> \-\-allowed\-origins <value>
|
|
71
|
+
.fi
|
|
72
|
+
.RE
|
|
73
|
+
.SH "ENVIRONMENT"
|
|
74
|
+
.TP
|
|
75
|
+
\fBROARK_API_BEARER_TOKEN\fR
|
|
76
|
+
Bearer token used when \-\-token is not given.
|
|
77
|
+
.TP
|
|
78
|
+
\fBROARK_BASE_URL\fR
|
|
79
|
+
API base URL.
|
|
80
|
+
.TP
|
|
81
|
+
\fBROARK_ALLOW_PROJECT_BASE_URL\fR
|
|
82
|
+
Trusts a base URL set by a project .roark.json, like \-\-allow\-project\-base\-url.
|
|
83
|
+
.TP
|
|
84
|
+
\fBNO_COLOR\fR
|
|
85
|
+
Disables colour when set to any value.
|
|
86
|
+
.SH "EXIT STATUS"
|
|
87
|
+
.TP
|
|
88
|
+
\fB0\fR
|
|
89
|
+
The command succeeded.
|
|
90
|
+
.TP
|
|
91
|
+
\fB1\fR
|
|
92
|
+
The API rejected the request.
|
|
93
|
+
.TP
|
|
94
|
+
\fB2\fR
|
|
95
|
+
The command line was wrong.
|
|
96
|
+
.TP
|
|
97
|
+
\fB3\fR
|
|
98
|
+
No credential, or the credential was refused.
|
|
99
|
+
.TP
|
|
100
|
+
\fB4\fR
|
|
101
|
+
The addressed resource does not exist.
|
|
102
|
+
.TP
|
|
103
|
+
\fB5\fR
|
|
104
|
+
The request never completed: connection, timeout, or abort.
|
|
105
|
+
.SH "SEE ALSO"
|
|
106
|
+
.BR roark (1)
|
package/man/roark-agent-create.1
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
.\" File generated from our OpenAPI spec by app-agent-codegen. Do not edit.
|
|
2
2
|
.TH "ROARK\-AGENT\-CREATE" "1" "" "roark-agent-create" "Roark Analytics API Manual"
|
|
3
3
|
.SH "NAME"
|
|
4
|
-
roark\-agent\-create \- Create
|
|
4
|
+
roark\-agent\-create \- Create an agent
|
|
5
5
|
.SH "SYNOPSIS"
|
|
6
6
|
.B roark agent create
|
|
7
7
|
[\fIoptions\fR]
|
|
@@ -18,7 +18,31 @@ Name of the agent Required.
|
|
|
18
18
|
Description of the agent Optional.
|
|
19
19
|
.TP
|
|
20
20
|
\fB\-\-custom\-id\fR \fI<value>\fR
|
|
21
|
-
Custom identifier for the agent Optional.
|
|
21
|
+
Custom identifier for the agent. Must be unique in the project. Optional.
|
|
22
|
+
.TP
|
|
23
|
+
\fB\-\-industry\fR \fI<value>\fR
|
|
24
|
+
The industry the agent serves. One of: HEALTHCARE, FINANCIAL_SERVICES, INSURANCE, DEBT_COLLECTION, RETAIL, TRAVEL_AND_HOSPITALITY, TELECOMMUNICATIONS, TECHNOLOGY, PUBLIC_SECTOR, UTILITIES, LOGISTICS, AUTOMOTIVE, HOME_SERVICES, RESTAURANTS, EDUCATION, OTHER. Optional.
|
|
25
|
+
.TP
|
|
26
|
+
\fB\-\-prompt\fR \fI<value>\fR
|
|
27
|
+
The agent's system prompt. Optional.
|
|
28
|
+
.TP
|
|
29
|
+
\fB\-\-endpoint\fR \fI<value>\fR
|
|
30
|
+
The phone number or connection Roark calls to test the agent Optional.
|
|
31
|
+
.TP
|
|
32
|
+
\fB\-\-endpoint.value\fR \fI<value>\fR
|
|
33
|
+
Phone number in E.164 format (e.g., +12345678900). Optional when direction is OUTGOING, for an agent that calls from numbers you do not know up front. Optional.
|
|
34
|
+
.TP
|
|
35
|
+
\fB\-\-endpoint.environment\fR \fI<value>\fR
|
|
36
|
+
Environment name (default: production) Optional.
|
|
37
|
+
.TP
|
|
38
|
+
\fB\-\-endpoint.direction\fR \fI<value>\fR
|
|
39
|
+
Call direction: INCOMING, OUTGOING, or INCOMING_AND_OUTGOING One of: INCOMING, OUTGOING, INCOMING_AND_OUTGOING. Required.
|
|
40
|
+
.TP
|
|
41
|
+
\fB\-\-endpoint.outbound\-dial\-type\fR \fI<value>\fR
|
|
42
|
+
Outbound dial type: NONE or HTTP_REQUEST (default: NONE) One of: NONE, HTTP_REQUEST. Optional.
|
|
43
|
+
.TP
|
|
44
|
+
\fB\-\-endpoint.outbound\-dial\-http\-request\-definition\-id\fR \fI<value>\fR
|
|
45
|
+
ID of the HTTP request definition for outbound dialing (required when outboundDialType is HTTP_REQUEST) Optional.
|
|
22
46
|
.SH "GLOBAL OPTIONS"
|
|
23
47
|
.TP
|
|
24
48
|
\fB\-\-data\fR \fI<json>\fR
|
|
@@ -60,7 +84,7 @@ Send the stored credential to a base URL set by a project .roark.json. Refused b
|
|
|
60
84
|
.PP
|
|
61
85
|
.RS 4
|
|
62
86
|
.nf
|
|
63
|
-
roark agent create \-\-name <value>
|
|
87
|
+
roark agent create \-\-name <value> \-\-endpoint.direction <value>
|
|
64
88
|
.fi
|
|
65
89
|
.RE
|
|
66
90
|
.SH "ENVIRONMENT"
|
|
@@ -22,7 +22,7 @@ The draft's revision when you read it. When sent, the edit is refused if the dra
|
|
|
22
22
|
The settings to change. Omitted settings stay as they are; null clears one to the runtime default. subAgents replaces every speaker, model configs included, and must include `main`; in a model config, omitted fields use the runtime default. Required.
|
|
23
23
|
.TP
|
|
24
24
|
\fB\-\-settings.modalities\fR \fI<value>\fR
|
|
25
|
-
One of:
|
|
25
|
+
One of: voice, chat, call. Repeatable. Optional.
|
|
26
26
|
.TP
|
|
27
27
|
\fB\-\-settings.language\fR \fI<value>\fR
|
|
28
28
|
Optional.
|
|
@@ -45,6 +45,9 @@ Optional.
|
|
|
45
45
|
\fB\-\-settings.vad\-stop\-secs\fR \fI<value>\fR
|
|
46
46
|
Optional.
|
|
47
47
|
.TP
|
|
48
|
+
\fB\-\-settings.vad\-max\-silence\-secs\fR \fI<value>\fR
|
|
49
|
+
Optional.
|
|
50
|
+
.TP
|
|
48
51
|
\fB\-\-settings.call\-max\-duration\-seconds\fR \fI<value>\fR
|
|
49
52
|
Optional.
|
|
50
53
|
.TP
|
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
.\" File generated from our OpenAPI spec by app-agent-codegen. Do not edit.
|
|
2
2
|
.TH "ROARK\-AGENT\-ENDPOINT\-CREATE" "1" "" "roark-agent-endpoint-create" "Roark Analytics API Manual"
|
|
3
3
|
.SH "NAME"
|
|
4
|
-
roark\-agent\-endpoint\-create \- Create
|
|
4
|
+
roark\-agent\-endpoint\-create \- Create an agent endpoint
|
|
5
5
|
.SH "SYNOPSIS"
|
|
6
6
|
.B roark agent endpoint create
|
|
7
7
|
[\fIoptions\fR]
|
|
@@ -11,9 +11,6 @@ Creates a new agent endpoint for the authenticated project.
|
|
|
11
11
|
POST /v1/agent/endpoint
|
|
12
12
|
.SH "OPTIONS"
|
|
13
13
|
.TP
|
|
14
|
-
\fB\-\-agent\-id\fR \fI<value>\fR
|
|
15
|
-
Agent ID to associate this endpoint with Required.
|
|
16
|
-
.TP
|
|
17
14
|
\fB\-\-value\fR \fI<value>\fR
|
|
18
15
|
Phone number in E.164 format (e.g., +12345678900). Optional when direction is OUTGOING, for an agent that calls from numbers you do not know up front. Optional.
|
|
19
16
|
.TP
|
|
@@ -28,6 +25,9 @@ Outbound dial type: NONE or HTTP_REQUEST (default: NONE) One of: NONE, HTTP_REQU
|
|
|
28
25
|
.TP
|
|
29
26
|
\fB\-\-outbound\-dial\-http\-request\-definition\-id\fR \fI<value>\fR
|
|
30
27
|
ID of the HTTP request definition for outbound dialing (required when outboundDialType is HTTP_REQUEST) Optional.
|
|
28
|
+
.TP
|
|
29
|
+
\fB\-\-agent\-id\fR \fI<value>\fR
|
|
30
|
+
Agent ID to associate this endpoint with Required.
|
|
31
31
|
.SH "GLOBAL OPTIONS"
|
|
32
32
|
.TP
|
|
33
33
|
\fB\-\-data\fR \fI<json>\fR
|
|
@@ -69,7 +69,7 @@ Send the stored credential to a base URL set by a project .roark.json. Refused b
|
|
|
69
69
|
.PP
|
|
70
70
|
.RS 4
|
|
71
71
|
.nf
|
|
72
|
-
roark agent endpoint create \-\-
|
|
72
|
+
roark agent endpoint create \-\-direction <value> \-\-agent\-id <value>
|
|
73
73
|
.fi
|
|
74
74
|
.RE
|
|
75
75
|
.SH "ENVIRONMENT"
|
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
.\" File generated from our OpenAPI spec by app-agent-codegen. Do not edit.
|
|
2
2
|
.TH "ROARK\-AGENT\-ENDPOINT\-GET" "1" "" "roark-agent-endpoint-get" "Roark Analytics API Manual"
|
|
3
3
|
.SH "NAME"
|
|
4
|
-
roark\-agent\-endpoint\-get \- Get agent endpoint
|
|
4
|
+
roark\-agent\-endpoint\-get \- Get an agent endpoint
|
|
5
5
|
.SH "SYNOPSIS"
|
|
6
6
|
.B roark agent endpoint get
|
|
7
7
|
\fIendpoint\-id\fR [\fIoptions\fR]
|
package/man/roark-agent-get.1
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
.\" File generated from our OpenAPI spec by app-agent-codegen. Do not edit.
|
|
2
2
|
.TH "ROARK\-AGENT\-GET" "1" "" "roark-agent-get" "Roark Analytics API Manual"
|
|
3
3
|
.SH "NAME"
|
|
4
|
-
roark\-agent\-get \- Get agent
|
|
4
|
+
roark\-agent\-get \- Get an agent
|
|
5
5
|
.SH "SYNOPSIS"
|
|
6
6
|
.B roark agent get
|
|
7
7
|
\fIagent\-id\fR [\fIoptions\fR]
|
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
.\" File generated from our OpenAPI spec by app-agent-codegen. Do not edit.
|
|
2
2
|
.TH "ROARK\-AUTOIMPROVE\-JOB\-CANCEL" "1" "" "roark-autoimprove-job-cancel" "Roark Analytics API Manual"
|
|
3
3
|
.SH "NAME"
|
|
4
|
-
roark\-autoimprove\-job\-cancel \- Cancel
|
|
4
|
+
roark\-autoimprove\-job\-cancel \- Cancel an Autoimprove job
|
|
5
5
|
.SH "SYNOPSIS"
|
|
6
6
|
.B roark autoimprove job cancel
|
|
7
7
|
\fIjob\-id\fR [\fIoptions\fR]
|
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
.\" File generated from our OpenAPI spec by app-agent-codegen. Do not edit.
|
|
2
2
|
.TH "ROARK\-AUTOIMPROVE\-JOB\-DISMISS" "1" "" "roark-autoimprove-job-dismiss" "Roark Analytics API Manual"
|
|
3
3
|
.SH "NAME"
|
|
4
|
-
roark\-autoimprove\-job\-dismiss \- Dismiss
|
|
4
|
+
roark\-autoimprove\-job\-dismiss \- Dismiss an Autoimprove job
|
|
5
5
|
.SH "SYNOPSIS"
|
|
6
6
|
.B roark autoimprove job dismiss
|
|
7
7
|
\fIjob\-id\fR [\fIoptions\fR]
|
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
.\" File generated from our OpenAPI spec by app-agent-codegen. Do not edit.
|
|
2
2
|
.TH "ROARK\-AUTOIMPROVE\-JOB\-GUIDANCE\-SEND" "1" "" "roark-autoimprove-job-guidance-send" "Roark Analytics API Manual"
|
|
3
3
|
.SH "NAME"
|
|
4
|
-
roark\-autoimprove\-job\-guidance\-send \-
|
|
4
|
+
roark\-autoimprove\-job\-guidance\-send \- Guide a running Autoimprove job
|
|
5
5
|
.SH "SYNOPSIS"
|
|
6
6
|
.B roark autoimprove job guidance send
|
|
7
7
|
\fIjob\-id\fR [\fIoptions\fR]
|
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
.\" File generated from our OpenAPI spec by app-agent-codegen. Do not edit.
|
|
2
2
|
.TH "ROARK\-AUTOIMPROVE\-JOB\-PROMOTE" "1" "" "roark-autoimprove-job-promote" "Roark Analytics API Manual"
|
|
3
3
|
.SH "NAME"
|
|
4
|
-
roark\-autoimprove\-job\-promote \- Promote
|
|
4
|
+
roark\-autoimprove\-job\-promote \- Promote an Autoimprove job to production
|
|
5
5
|
.SH "SYNOPSIS"
|
|
6
6
|
.B roark autoimprove job promote
|
|
7
7
|
\fIjob\-id\fR [\fIoptions\fR]
|
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
.\" File generated from our OpenAPI spec by app-agent-codegen. Do not edit.
|
|
2
2
|
.TH "ROARK\-BENCHMARK\-TARGET\-HISTORY\-LIST" "1" "" "roark-benchmark-target-history-list" "Roark Analytics API Manual"
|
|
3
3
|
.SH "NAME"
|
|
4
|
-
roark\-benchmark\-target\-history\-list \- List a target
|
|
4
|
+
roark\-benchmark\-target\-history\-list \- List a benchmark target's published generations
|
|
5
5
|
.SH "SYNOPSIS"
|
|
6
6
|
.B roark benchmark target history list
|
|
7
7
|
\fItarget\-key\fR [\fIoptions\fR]
|
package/man/roark-call-get.1
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
.\" File generated from our OpenAPI spec by app-agent-codegen. Do not edit.
|
|
2
2
|
.TH "ROARK\-CALL\-GET" "1" "" "roark-call-get" "Roark Analytics API Manual"
|
|
3
3
|
.SH "NAME"
|
|
4
|
-
roark\-call\-get \- Get a call
|
|
4
|
+
roark\-call\-get \- Get a call
|
|
5
5
|
.SH "SYNOPSIS"
|
|
6
6
|
.B roark call get
|
|
7
7
|
\fIcall\-id\fR [\fIoptions\fR]
|
|
@@ -0,0 +1,96 @@
|
|
|
1
|
+
.\" File generated from our OpenAPI spec by app-agent-codegen. Do not edit.
|
|
2
|
+
.TH "ROARK\-CONNECTIONS\-AGENT\-BACKFILL\-CANCEL" "1" "" "roark-connections-agent-backfill-cancel" "Roark Analytics API Manual"
|
|
3
|
+
.SH "NAME"
|
|
4
|
+
roark\-connections\-agent\-backfill\-cancel \- Cancel a backfill
|
|
5
|
+
.SH "SYNOPSIS"
|
|
6
|
+
.B roark connections agent backfill cancel
|
|
7
|
+
\fIconnection\-id\fR \fIbackfill\-id\fR [\fIoptions\fR]
|
|
8
|
+
.SH "DESCRIPTION"
|
|
9
|
+
Stops a running backfill. Calls it already imported stay.
|
|
10
|
+
.SH "API"
|
|
11
|
+
POST /v1/connections/agent/{connectionId}/backfills/{backfillId}/cancel
|
|
12
|
+
.SH "ARGUMENTS"
|
|
13
|
+
.TP
|
|
14
|
+
\fIconnection\-id\fR
|
|
15
|
+
The connection\-id.
|
|
16
|
+
.TP
|
|
17
|
+
\fIbackfill\-id\fR
|
|
18
|
+
The backfill\-id.
|
|
19
|
+
.SH "GLOBAL OPTIONS"
|
|
20
|
+
.TP
|
|
21
|
+
\fB\-\-data\fR \fI<json>\fR
|
|
22
|
+
Request body as JSON, or @file to read one (@\- for stdin).
|
|
23
|
+
.TP
|
|
24
|
+
\fB\-y\fR, \fB\-\-yes\fR
|
|
25
|
+
Skip confirmation prompts.
|
|
26
|
+
.TP
|
|
27
|
+
\fB\-\-no\-input\fR
|
|
28
|
+
Never prompt; fail instead.
|
|
29
|
+
.TP
|
|
30
|
+
\fB\-\-base\-url\fR \fI<url>\fR
|
|
31
|
+
API base URL.
|
|
32
|
+
.TP
|
|
33
|
+
\fB\-\-token\fR \fI<token>\fR
|
|
34
|
+
Bearer token. Prefer ROARK_API_BEARER_TOKEN or the stored credential.
|
|
35
|
+
.TP
|
|
36
|
+
\fB\-\-timeout\fR \fI<ms>\fR
|
|
37
|
+
Request timeout in milliseconds.
|
|
38
|
+
.TP
|
|
39
|
+
\fB\-\-max\-retries\fR \fI<count>\fR
|
|
40
|
+
Retries for retryable failures.
|
|
41
|
+
.TP
|
|
42
|
+
\fB\-\-format\fR \fI<format>\fR
|
|
43
|
+
Output format: auto, json, jsonl, plain.
|
|
44
|
+
.TP
|
|
45
|
+
\fB\-\-json\fR
|
|
46
|
+
Shorthand for \-\-format json.
|
|
47
|
+
.TP
|
|
48
|
+
\fB\-\-no\-color\fR
|
|
49
|
+
Disable colour.
|
|
50
|
+
.TP
|
|
51
|
+
\fB\-q\fR, \fB\-\-quiet\fR
|
|
52
|
+
Suppress non\-essential output.
|
|
53
|
+
.TP
|
|
54
|
+
\fB\-\-allow\-project\-base\-url\fR
|
|
55
|
+
Send the stored credential to a base URL set by a project .roark.json. Refused by default.
|
|
56
|
+
.SH "EXAMPLES"
|
|
57
|
+
.PP
|
|
58
|
+
.RS 4
|
|
59
|
+
.nf
|
|
60
|
+
roark connections agent backfill cancel <connection\-id> <backfill\-id>
|
|
61
|
+
.fi
|
|
62
|
+
.RE
|
|
63
|
+
.SH "ENVIRONMENT"
|
|
64
|
+
.TP
|
|
65
|
+
\fBROARK_API_BEARER_TOKEN\fR
|
|
66
|
+
Bearer token used when \-\-token is not given.
|
|
67
|
+
.TP
|
|
68
|
+
\fBROARK_BASE_URL\fR
|
|
69
|
+
API base URL.
|
|
70
|
+
.TP
|
|
71
|
+
\fBROARK_ALLOW_PROJECT_BASE_URL\fR
|
|
72
|
+
Trusts a base URL set by a project .roark.json, like \-\-allow\-project\-base\-url.
|
|
73
|
+
.TP
|
|
74
|
+
\fBNO_COLOR\fR
|
|
75
|
+
Disables colour when set to any value.
|
|
76
|
+
.SH "EXIT STATUS"
|
|
77
|
+
.TP
|
|
78
|
+
\fB0\fR
|
|
79
|
+
The command succeeded.
|
|
80
|
+
.TP
|
|
81
|
+
\fB1\fR
|
|
82
|
+
The API rejected the request.
|
|
83
|
+
.TP
|
|
84
|
+
\fB2\fR
|
|
85
|
+
The command line was wrong.
|
|
86
|
+
.TP
|
|
87
|
+
\fB3\fR
|
|
88
|
+
No credential, or the credential was refused.
|
|
89
|
+
.TP
|
|
90
|
+
\fB4\fR
|
|
91
|
+
The addressed resource does not exist.
|
|
92
|
+
.TP
|
|
93
|
+
\fB5\fR
|
|
94
|
+
The request never completed: connection, timeout, or abort.
|
|
95
|
+
.SH "SEE ALSO"
|
|
96
|
+
.BR roark (1)
|
|
@@ -0,0 +1,97 @@
|
|
|
1
|
+
.\" File generated from our OpenAPI spec by app-agent-codegen. Do not edit.
|
|
2
|
+
.TH "ROARK\-CONNECTIONS\-AGENT\-BACKFILL\-CREATE" "1" "" "roark-connections-agent-backfill-create" "Roark Analytics API Manual"
|
|
3
|
+
.SH "NAME"
|
|
4
|
+
roark\-connections\-agent\-backfill\-create \- Import past calls
|
|
5
|
+
.SH "SYNOPSIS"
|
|
6
|
+
.B roark connections agent backfill create
|
|
7
|
+
\fIconnection\-id\fR [\fIoptions\fR]
|
|
8
|
+
.SH "DESCRIPTION"
|
|
9
|
+
Starts a backfill that imports up to `maxCalls` of the most recent past calls from a Retell, Vapi, ElevenLabs or Leaping connection. Other platforms return 400.
|
|
10
|
+
.SH "API"
|
|
11
|
+
POST /v1/connections/agent/{connectionId}/backfills
|
|
12
|
+
.SH "ARGUMENTS"
|
|
13
|
+
.TP
|
|
14
|
+
\fIconnection\-id\fR
|
|
15
|
+
The connection\-id.
|
|
16
|
+
.SH "OPTIONS"
|
|
17
|
+
.TP
|
|
18
|
+
\fB\-\-max\-calls\fR \fI<value>\fR
|
|
19
|
+
How many of the most recent past calls to import, up to 1000. Required.
|
|
20
|
+
.SH "GLOBAL OPTIONS"
|
|
21
|
+
.TP
|
|
22
|
+
\fB\-\-data\fR \fI<json>\fR
|
|
23
|
+
Request body as JSON, or @file to read one (@\- for stdin).
|
|
24
|
+
.TP
|
|
25
|
+
\fB\-y\fR, \fB\-\-yes\fR
|
|
26
|
+
Skip confirmation prompts.
|
|
27
|
+
.TP
|
|
28
|
+
\fB\-\-no\-input\fR
|
|
29
|
+
Never prompt; fail instead.
|
|
30
|
+
.TP
|
|
31
|
+
\fB\-\-base\-url\fR \fI<url>\fR
|
|
32
|
+
API base URL.
|
|
33
|
+
.TP
|
|
34
|
+
\fB\-\-token\fR \fI<token>\fR
|
|
35
|
+
Bearer token. Prefer ROARK_API_BEARER_TOKEN or the stored credential.
|
|
36
|
+
.TP
|
|
37
|
+
\fB\-\-timeout\fR \fI<ms>\fR
|
|
38
|
+
Request timeout in milliseconds.
|
|
39
|
+
.TP
|
|
40
|
+
\fB\-\-max\-retries\fR \fI<count>\fR
|
|
41
|
+
Retries for retryable failures.
|
|
42
|
+
.TP
|
|
43
|
+
\fB\-\-format\fR \fI<format>\fR
|
|
44
|
+
Output format: auto, json, jsonl, plain.
|
|
45
|
+
.TP
|
|
46
|
+
\fB\-\-json\fR
|
|
47
|
+
Shorthand for \-\-format json.
|
|
48
|
+
.TP
|
|
49
|
+
\fB\-\-no\-color\fR
|
|
50
|
+
Disable colour.
|
|
51
|
+
.TP
|
|
52
|
+
\fB\-q\fR, \fB\-\-quiet\fR
|
|
53
|
+
Suppress non\-essential output.
|
|
54
|
+
.TP
|
|
55
|
+
\fB\-\-allow\-project\-base\-url\fR
|
|
56
|
+
Send the stored credential to a base URL set by a project .roark.json. Refused by default.
|
|
57
|
+
.SH "EXAMPLES"
|
|
58
|
+
.PP
|
|
59
|
+
.RS 4
|
|
60
|
+
.nf
|
|
61
|
+
roark connections agent backfill create <connection\-id> \-\-max\-calls <value>
|
|
62
|
+
.fi
|
|
63
|
+
.RE
|
|
64
|
+
.SH "ENVIRONMENT"
|
|
65
|
+
.TP
|
|
66
|
+
\fBROARK_API_BEARER_TOKEN\fR
|
|
67
|
+
Bearer token used when \-\-token is not given.
|
|
68
|
+
.TP
|
|
69
|
+
\fBROARK_BASE_URL\fR
|
|
70
|
+
API base URL.
|
|
71
|
+
.TP
|
|
72
|
+
\fBROARK_ALLOW_PROJECT_BASE_URL\fR
|
|
73
|
+
Trusts a base URL set by a project .roark.json, like \-\-allow\-project\-base\-url.
|
|
74
|
+
.TP
|
|
75
|
+
\fBNO_COLOR\fR
|
|
76
|
+
Disables colour when set to any value.
|
|
77
|
+
.SH "EXIT STATUS"
|
|
78
|
+
.TP
|
|
79
|
+
\fB0\fR
|
|
80
|
+
The command succeeded.
|
|
81
|
+
.TP
|
|
82
|
+
\fB1\fR
|
|
83
|
+
The API rejected the request.
|
|
84
|
+
.TP
|
|
85
|
+
\fB2\fR
|
|
86
|
+
The command line was wrong.
|
|
87
|
+
.TP
|
|
88
|
+
\fB3\fR
|
|
89
|
+
No credential, or the credential was refused.
|
|
90
|
+
.TP
|
|
91
|
+
\fB4\fR
|
|
92
|
+
The addressed resource does not exist.
|
|
93
|
+
.TP
|
|
94
|
+
\fB5\fR
|
|
95
|
+
The request never completed: connection, timeout, or abort.
|
|
96
|
+
.SH "SEE ALSO"
|
|
97
|
+
.BR roark (1)
|
|
@@ -0,0 +1,93 @@
|
|
|
1
|
+
.\" File generated from our OpenAPI spec by app-agent-codegen. Do not edit.
|
|
2
|
+
.TH "ROARK\-CONNECTIONS\-AGENT\-BACKFILL\-LIST" "1" "" "roark-connections-agent-backfill-list" "Roark Analytics API Manual"
|
|
3
|
+
.SH "NAME"
|
|
4
|
+
roark\-connections\-agent\-backfill\-list \- List backfills
|
|
5
|
+
.SH "SYNOPSIS"
|
|
6
|
+
.B roark connections agent backfill list
|
|
7
|
+
\fIconnection\-id\fR [\fIoptions\fR]
|
|
8
|
+
.SH "DESCRIPTION"
|
|
9
|
+
A connection's imports of past calls, newest first.
|
|
10
|
+
.SH "API"
|
|
11
|
+
GET /v1/connections/agent/{connectionId}/backfills
|
|
12
|
+
.SH "ARGUMENTS"
|
|
13
|
+
.TP
|
|
14
|
+
\fIconnection\-id\fR
|
|
15
|
+
The connection\-id.
|
|
16
|
+
.SH "GLOBAL OPTIONS"
|
|
17
|
+
.TP
|
|
18
|
+
\fB\-\-data\fR \fI<json>\fR
|
|
19
|
+
Request body as JSON, or @file to read one (@\- for stdin).
|
|
20
|
+
.TP
|
|
21
|
+
\fB\-y\fR, \fB\-\-yes\fR
|
|
22
|
+
Skip confirmation prompts.
|
|
23
|
+
.TP
|
|
24
|
+
\fB\-\-no\-input\fR
|
|
25
|
+
Never prompt; fail instead.
|
|
26
|
+
.TP
|
|
27
|
+
\fB\-\-base\-url\fR \fI<url>\fR
|
|
28
|
+
API base URL.
|
|
29
|
+
.TP
|
|
30
|
+
\fB\-\-token\fR \fI<token>\fR
|
|
31
|
+
Bearer token. Prefer ROARK_API_BEARER_TOKEN or the stored credential.
|
|
32
|
+
.TP
|
|
33
|
+
\fB\-\-timeout\fR \fI<ms>\fR
|
|
34
|
+
Request timeout in milliseconds.
|
|
35
|
+
.TP
|
|
36
|
+
\fB\-\-max\-retries\fR \fI<count>\fR
|
|
37
|
+
Retries for retryable failures.
|
|
38
|
+
.TP
|
|
39
|
+
\fB\-\-format\fR \fI<format>\fR
|
|
40
|
+
Output format: auto, json, jsonl, plain.
|
|
41
|
+
.TP
|
|
42
|
+
\fB\-\-json\fR
|
|
43
|
+
Shorthand for \-\-format json.
|
|
44
|
+
.TP
|
|
45
|
+
\fB\-\-no\-color\fR
|
|
46
|
+
Disable colour.
|
|
47
|
+
.TP
|
|
48
|
+
\fB\-q\fR, \fB\-\-quiet\fR
|
|
49
|
+
Suppress non\-essential output.
|
|
50
|
+
.TP
|
|
51
|
+
\fB\-\-allow\-project\-base\-url\fR
|
|
52
|
+
Send the stored credential to a base URL set by a project .roark.json. Refused by default.
|
|
53
|
+
.SH "EXAMPLES"
|
|
54
|
+
.PP
|
|
55
|
+
.RS 4
|
|
56
|
+
.nf
|
|
57
|
+
roark connections agent backfill list <connection\-id>
|
|
58
|
+
.fi
|
|
59
|
+
.RE
|
|
60
|
+
.SH "ENVIRONMENT"
|
|
61
|
+
.TP
|
|
62
|
+
\fBROARK_API_BEARER_TOKEN\fR
|
|
63
|
+
Bearer token used when \-\-token is not given.
|
|
64
|
+
.TP
|
|
65
|
+
\fBROARK_BASE_URL\fR
|
|
66
|
+
API base URL.
|
|
67
|
+
.TP
|
|
68
|
+
\fBROARK_ALLOW_PROJECT_BASE_URL\fR
|
|
69
|
+
Trusts a base URL set by a project .roark.json, like \-\-allow\-project\-base\-url.
|
|
70
|
+
.TP
|
|
71
|
+
\fBNO_COLOR\fR
|
|
72
|
+
Disables colour when set to any value.
|
|
73
|
+
.SH "EXIT STATUS"
|
|
74
|
+
.TP
|
|
75
|
+
\fB0\fR
|
|
76
|
+
The command succeeded.
|
|
77
|
+
.TP
|
|
78
|
+
\fB1\fR
|
|
79
|
+
The API rejected the request.
|
|
80
|
+
.TP
|
|
81
|
+
\fB2\fR
|
|
82
|
+
The command line was wrong.
|
|
83
|
+
.TP
|
|
84
|
+
\fB3\fR
|
|
85
|
+
No credential, or the credential was refused.
|
|
86
|
+
.TP
|
|
87
|
+
\fB4\fR
|
|
88
|
+
The addressed resource does not exist.
|
|
89
|
+
.TP
|
|
90
|
+
\fB5\fR
|
|
91
|
+
The request never completed: connection, timeout, or abort.
|
|
92
|
+
.SH "SEE ALSO"
|
|
93
|
+
.BR roark (1)
|