@roarkanalytics/cli 0.58.0 → 0.59.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +14 -0
- package/README.md +8 -0
- package/commands.js +562 -1
- package/completions.js +4 -4
- package/man/roark-agent-build.1 +1 -1
- package/man/roark-agent-draft-create.1 +97 -0
- package/man/roark-agent-draft-delete.1 +93 -0
- package/man/roark-agent-draft-get.1 +93 -0
- package/man/roark-agent-draft-publish.1 +100 -0
- package/man/roark-agent-draft-update.1 +202 -0
- package/man/roark-agent-version-get.1 +96 -0
- package/man/roark-agent-version-list.1 +100 -0
- package/man/roark-agent-version-restore.1 +103 -0
- package/man/roark.1 +24 -0
- package/npm-shrinkwrap.json +6 -6
- package/package.json +10 -2
- 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
|
|
27
|
+
Text\-to\-speech provider, for example ELEVENLABS One of: CARTESIA, ELEVENLABS, OPENAI, RIME. Required.
|
|
28
28
|
.TP
|
|
29
29
|
\fB\-\-tts.voice\-id\fR \fI<value>\fR
|
|
30
30
|
The provider's id for the voice Required.
|
|
@@ -0,0 +1,97 @@
|
|
|
1
|
+
.\" File generated from our OpenAPI spec by app-agent-codegen. Do not edit.
|
|
2
|
+
.TH "ROARK\-AGENT\-DRAFT\-CREATE" "1" "" "roark-agent-draft-create" "Roark Analytics API Manual"
|
|
3
|
+
.SH "NAME"
|
|
4
|
+
roark\-agent\-draft\-create \- Start a draft
|
|
5
|
+
.SH "SYNOPSIS"
|
|
6
|
+
.B roark agent draft create
|
|
7
|
+
\fIagent\-id\fR [\fIoptions\fR]
|
|
8
|
+
.SH "DESCRIPTION"
|
|
9
|
+
Opens the agent's one shared draft, a copy of the live version or of an older published version. Fails with 409 when a draft is already open.
|
|
10
|
+
.SH "API"
|
|
11
|
+
POST /v1/agent/{agentId}/draft
|
|
12
|
+
.SH "ARGUMENTS"
|
|
13
|
+
.TP
|
|
14
|
+
\fIagent\-id\fR
|
|
15
|
+
The agent\-id.
|
|
16
|
+
.SH "OPTIONS"
|
|
17
|
+
.TP
|
|
18
|
+
\fB\-\-from\-version\-id\fR \fI<value>\fR
|
|
19
|
+
Start from this published version instead of the live one. Optional.
|
|
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 agent draft create <agent\-id>
|
|
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\-AGENT\-DRAFT\-DELETE" "1" "" "roark-agent-draft-delete" "Roark Analytics API Manual"
|
|
3
|
+
.SH "NAME"
|
|
4
|
+
roark\-agent\-draft\-delete \- Discard the draft
|
|
5
|
+
.SH "SYNOPSIS"
|
|
6
|
+
.B roark agent draft delete
|
|
7
|
+
\fIagent\-id\fR [\fIoptions\fR]
|
|
8
|
+
.SH "DESCRIPTION"
|
|
9
|
+
Throws the open draft away and returns it. The live version is unchanged.
|
|
10
|
+
.SH "API"
|
|
11
|
+
DELETE /v1/agent/{agentId}/draft
|
|
12
|
+
.SH "ARGUMENTS"
|
|
13
|
+
.TP
|
|
14
|
+
\fIagent\-id\fR
|
|
15
|
+
The agent\-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 agent draft delete <agent\-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)
|
|
@@ -0,0 +1,93 @@
|
|
|
1
|
+
.\" File generated from our OpenAPI spec by app-agent-codegen. Do not edit.
|
|
2
|
+
.TH "ROARK\-AGENT\-DRAFT\-GET" "1" "" "roark-agent-draft-get" "Roark Analytics API Manual"
|
|
3
|
+
.SH "NAME"
|
|
4
|
+
roark\-agent\-draft\-get \- Get an agent's draft
|
|
5
|
+
.SH "SYNOPSIS"
|
|
6
|
+
.B roark agent draft get
|
|
7
|
+
\fIagent\-id\fR [\fIoptions\fR]
|
|
8
|
+
.SH "DESCRIPTION"
|
|
9
|
+
The agent's open draft, with the issues that would stop it from being published.
|
|
10
|
+
.SH "API"
|
|
11
|
+
GET /v1/agent/{agentId}/draft
|
|
12
|
+
.SH "ARGUMENTS"
|
|
13
|
+
.TP
|
|
14
|
+
\fIagent\-id\fR
|
|
15
|
+
The agent\-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 agent draft get <agent\-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)
|
|
@@ -0,0 +1,100 @@
|
|
|
1
|
+
.\" File generated from our OpenAPI spec by app-agent-codegen. Do not edit.
|
|
2
|
+
.TH "ROARK\-AGENT\-DRAFT\-PUBLISH" "1" "" "roark-agent-draft-publish" "Roark Analytics API Manual"
|
|
3
|
+
.SH "NAME"
|
|
4
|
+
roark\-agent\-draft\-publish \- Publish the draft
|
|
5
|
+
.SH "SYNOPSIS"
|
|
6
|
+
.B roark agent draft publish
|
|
7
|
+
\fIagent\-id\fR [\fIoptions\fR]
|
|
8
|
+
.SH "DESCRIPTION"
|
|
9
|
+
Makes the draft the live version, numbered v1, v2, ... Fails with 409 if the draft was edited after expectedRevision, if another version was published since the draft started, or if it changes nothing; with 400 and the issues if the version cannot run.
|
|
10
|
+
.SH "API"
|
|
11
|
+
POST /v1/agent/{agentId}/draft/publish
|
|
12
|
+
.SH "ARGUMENTS"
|
|
13
|
+
.TP
|
|
14
|
+
\fIagent\-id\fR
|
|
15
|
+
The agent\-id.
|
|
16
|
+
.SH "OPTIONS"
|
|
17
|
+
.TP
|
|
18
|
+
\fB\-\-expected\-revision\fR \fI<value>\fR
|
|
19
|
+
The draft revision you reviewed. Required.
|
|
20
|
+
.TP
|
|
21
|
+
\fB\-\-summary\fR \fI<value>\fR
|
|
22
|
+
What changed. Optional.
|
|
23
|
+
.SH "GLOBAL OPTIONS"
|
|
24
|
+
.TP
|
|
25
|
+
\fB\-\-data\fR \fI<json>\fR
|
|
26
|
+
Request body as JSON, or @file to read one (@\- for stdin).
|
|
27
|
+
.TP
|
|
28
|
+
\fB\-y\fR, \fB\-\-yes\fR
|
|
29
|
+
Skip confirmation prompts.
|
|
30
|
+
.TP
|
|
31
|
+
\fB\-\-no\-input\fR
|
|
32
|
+
Never prompt; fail instead.
|
|
33
|
+
.TP
|
|
34
|
+
\fB\-\-base\-url\fR \fI<url>\fR
|
|
35
|
+
API base URL.
|
|
36
|
+
.TP
|
|
37
|
+
\fB\-\-token\fR \fI<token>\fR
|
|
38
|
+
Bearer token. Prefer ROARK_API_BEARER_TOKEN or the stored credential.
|
|
39
|
+
.TP
|
|
40
|
+
\fB\-\-timeout\fR \fI<ms>\fR
|
|
41
|
+
Request timeout in milliseconds.
|
|
42
|
+
.TP
|
|
43
|
+
\fB\-\-max\-retries\fR \fI<count>\fR
|
|
44
|
+
Retries for retryable failures.
|
|
45
|
+
.TP
|
|
46
|
+
\fB\-\-format\fR \fI<format>\fR
|
|
47
|
+
Output format: auto, json, jsonl, plain.
|
|
48
|
+
.TP
|
|
49
|
+
\fB\-\-json\fR
|
|
50
|
+
Shorthand for \-\-format json.
|
|
51
|
+
.TP
|
|
52
|
+
\fB\-\-no\-color\fR
|
|
53
|
+
Disable colour.
|
|
54
|
+
.TP
|
|
55
|
+
\fB\-q\fR, \fB\-\-quiet\fR
|
|
56
|
+
Suppress non\-essential output.
|
|
57
|
+
.TP
|
|
58
|
+
\fB\-\-allow\-project\-base\-url\fR
|
|
59
|
+
Send the stored credential to a base URL set by a project .roark.json. Refused by default.
|
|
60
|
+
.SH "EXAMPLES"
|
|
61
|
+
.PP
|
|
62
|
+
.RS 4
|
|
63
|
+
.nf
|
|
64
|
+
roark agent draft publish <agent\-id> \-\-expected\-revision <value>
|
|
65
|
+
.fi
|
|
66
|
+
.RE
|
|
67
|
+
.SH "ENVIRONMENT"
|
|
68
|
+
.TP
|
|
69
|
+
\fBROARK_API_BEARER_TOKEN\fR
|
|
70
|
+
Bearer token used when \-\-token is not given.
|
|
71
|
+
.TP
|
|
72
|
+
\fBROARK_BASE_URL\fR
|
|
73
|
+
API base URL.
|
|
74
|
+
.TP
|
|
75
|
+
\fBROARK_ALLOW_PROJECT_BASE_URL\fR
|
|
76
|
+
Trusts a base URL set by a project .roark.json, like \-\-allow\-project\-base\-url.
|
|
77
|
+
.TP
|
|
78
|
+
\fBNO_COLOR\fR
|
|
79
|
+
Disables colour when set to any value.
|
|
80
|
+
.SH "EXIT STATUS"
|
|
81
|
+
.TP
|
|
82
|
+
\fB0\fR
|
|
83
|
+
The command succeeded.
|
|
84
|
+
.TP
|
|
85
|
+
\fB1\fR
|
|
86
|
+
The API rejected the request.
|
|
87
|
+
.TP
|
|
88
|
+
\fB2\fR
|
|
89
|
+
The command line was wrong.
|
|
90
|
+
.TP
|
|
91
|
+
\fB3\fR
|
|
92
|
+
No credential, or the credential was refused.
|
|
93
|
+
.TP
|
|
94
|
+
\fB4\fR
|
|
95
|
+
The addressed resource does not exist.
|
|
96
|
+
.TP
|
|
97
|
+
\fB5\fR
|
|
98
|
+
The request never completed: connection, timeout, or abort.
|
|
99
|
+
.SH "SEE ALSO"
|
|
100
|
+
.BR roark (1)
|
|
@@ -0,0 +1,202 @@
|
|
|
1
|
+
.\" File generated from our OpenAPI spec by app-agent-codegen. Do not edit.
|
|
2
|
+
.TH "ROARK\-AGENT\-DRAFT\-UPDATE" "1" "" "roark-agent-draft-update" "Roark Analytics API Manual"
|
|
3
|
+
.SH "NAME"
|
|
4
|
+
roark\-agent\-draft\-update \- Edit the draft
|
|
5
|
+
.SH "SYNOPSIS"
|
|
6
|
+
.B roark agent draft update
|
|
7
|
+
\fIagent\-id\fR [\fIoptions\fR]
|
|
8
|
+
.SH "DESCRIPTION"
|
|
9
|
+
Changes settings on the draft. Omitted settings stay as they are. Pass the revision you read as expectedRevision to fail with 409 if anyone edited the draft since, instead of applying on top of their edit.
|
|
10
|
+
.SH "API"
|
|
11
|
+
PATCH /v1/agent/{agentId}/draft
|
|
12
|
+
.SH "ARGUMENTS"
|
|
13
|
+
.TP
|
|
14
|
+
\fIagent\-id\fR
|
|
15
|
+
The agent\-id.
|
|
16
|
+
.SH "OPTIONS"
|
|
17
|
+
.TP
|
|
18
|
+
\fB\-\-expected\-revision\fR \fI<value>\fR
|
|
19
|
+
The draft's revision when you read it. When sent, the edit is refused if the draft changed since; when omitted, it applies on top of the latest edit. Optional.
|
|
20
|
+
.TP
|
|
21
|
+
\fB\-\-settings\fR \fI<value>\fR
|
|
22
|
+
The settings to change. Omitted settings stay as they are; null clears one to the runtime default. subAgents replaces every speaker and must include `main`. Required.
|
|
23
|
+
.TP
|
|
24
|
+
\fB\-\-settings.modalities\fR \fI<value>\fR
|
|
25
|
+
One of: call, chat. Repeatable. Optional.
|
|
26
|
+
.TP
|
|
27
|
+
\fB\-\-settings.language\fR \fI<value>\fR
|
|
28
|
+
Optional.
|
|
29
|
+
.TP
|
|
30
|
+
\fB\-\-settings.first\-message\-mode\fR \fI<value>\fR
|
|
31
|
+
One of: SPEAK_TEXT, PLAY_AUDIO, WAIT_FOR_CALLER. Optional.
|
|
32
|
+
.TP
|
|
33
|
+
\fB\-\-settings.first\-message\fR \fI<value>\fR
|
|
34
|
+
Optional.
|
|
35
|
+
.TP
|
|
36
|
+
\fB\-\-settings.first\-message\-audio\-url\fR \fI<value>\fR
|
|
37
|
+
Optional.
|
|
38
|
+
.TP
|
|
39
|
+
\fB\-\-settings.llm\-provider\fR \fI<value>\fR
|
|
40
|
+
One of: OPENAI, ANTHROPIC, GOOGLE, XAI, ULTRAVOX, AWS, ELEVENLABS. Optional.
|
|
41
|
+
.TP
|
|
42
|
+
\fB\-\-settings.llm\-model\fR \fI<value>\fR
|
|
43
|
+
Optional.
|
|
44
|
+
.TP
|
|
45
|
+
\fB\-\-settings.llm\-temperature\fR \fI<value>\fR
|
|
46
|
+
Optional.
|
|
47
|
+
.TP
|
|
48
|
+
\fB\-\-settings.llm\-max\-tokens\fR \fI<value>\fR
|
|
49
|
+
Optional.
|
|
50
|
+
.TP
|
|
51
|
+
\fB\-\-settings.llm\-backend\-model\fR \fI<value>\fR
|
|
52
|
+
Optional.
|
|
53
|
+
.TP
|
|
54
|
+
\fB\-\-settings.llm\-voice\fR \fI<value>\fR
|
|
55
|
+
Optional.
|
|
56
|
+
.TP
|
|
57
|
+
\fB\-\-settings.stt\-provider\fR \fI<value>\fR
|
|
58
|
+
One of: DEEPGRAM, OPENAI_WHISPER, SPEECHMATICS, ASSEMBLYAI, ELEVENLABS. Optional.
|
|
59
|
+
.TP
|
|
60
|
+
\fB\-\-settings.stt\-model\fR \fI<value>\fR
|
|
61
|
+
Optional.
|
|
62
|
+
.TP
|
|
63
|
+
\fB\-\-settings.stt\-keyterms\fR \fI<value>\fR
|
|
64
|
+
Repeatable. Optional.
|
|
65
|
+
.TP
|
|
66
|
+
\fB\-\-settings.stt\-smart\-format\fR
|
|
67
|
+
Optional.
|
|
68
|
+
.TP
|
|
69
|
+
\fB\-\-settings.stt\-endpointing\-ms\fR \fI<value>\fR
|
|
70
|
+
Optional.
|
|
71
|
+
.TP
|
|
72
|
+
\fB\-\-settings.stt\-turn\-detection\fR \fI<value>\fR
|
|
73
|
+
One of: pipeline, provider. Optional.
|
|
74
|
+
.TP
|
|
75
|
+
\fB\-\-settings.interruption\-mode\fR \fI<value>\fR
|
|
76
|
+
One of: ALLOW, BLOCK. Optional.
|
|
77
|
+
.TP
|
|
78
|
+
\fB\-\-settings.vad\-start\-secs\fR \fI<value>\fR
|
|
79
|
+
Optional.
|
|
80
|
+
.TP
|
|
81
|
+
\fB\-\-settings.vad\-stop\-secs\fR \fI<value>\fR
|
|
82
|
+
Optional.
|
|
83
|
+
.TP
|
|
84
|
+
\fB\-\-settings.call\-max\-duration\-seconds\fR \fI<value>\fR
|
|
85
|
+
Optional.
|
|
86
|
+
.TP
|
|
87
|
+
\fB\-\-settings.call\-silence\-timeout\-seconds\fR \fI<value>\fR
|
|
88
|
+
Optional.
|
|
89
|
+
.TP
|
|
90
|
+
\fB\-\-settings.idle\-timeout\-seconds\fR \fI<value>\fR
|
|
91
|
+
Optional.
|
|
92
|
+
.TP
|
|
93
|
+
\fB\-\-settings.idle\-max\-count\fR \fI<value>\fR
|
|
94
|
+
Optional.
|
|
95
|
+
.TP
|
|
96
|
+
\fB\-\-settings.idle\-messages\fR \fI<value>\fR
|
|
97
|
+
Repeatable. Optional.
|
|
98
|
+
.TP
|
|
99
|
+
\fB\-\-settings.end\-detection\-phrases\fR \fI<value>\fR
|
|
100
|
+
Repeatable. Optional.
|
|
101
|
+
.TP
|
|
102
|
+
\fB\-\-settings.end\-detection\-reasons\fR \fI<value>\fR
|
|
103
|
+
Repeatable. Optional.
|
|
104
|
+
.TP
|
|
105
|
+
\fB\-\-settings.end\-call\-goodbye\-message\fR \fI<value>\fR
|
|
106
|
+
Optional.
|
|
107
|
+
.TP
|
|
108
|
+
\fB\-\-settings.background\-noise\fR \fI<value>\fR
|
|
109
|
+
One of: NONE, AIRPORT, CHILDREN_PLAYING, CITY, COFFEE_SHOP, CONSTRUCTION, CRYING_BABY, DRIVING, LIBRARY, OFFICE, THUNDERSTORM, TRAIN. Optional.
|
|
110
|
+
.TP
|
|
111
|
+
\fB\-\-settings.background\-noise\-url\fR \fI<value>\fR
|
|
112
|
+
Optional.
|
|
113
|
+
.TP
|
|
114
|
+
\fB\-\-settings.background\-noise\-volume\fR \fI<value>\fR
|
|
115
|
+
Optional.
|
|
116
|
+
.TP
|
|
117
|
+
\fB\-\-settings.chat\-max\-duration\-seconds\fR \fI<value>\fR
|
|
118
|
+
Optional.
|
|
119
|
+
.TP
|
|
120
|
+
\fB\-\-settings.chat\-inactivity\-timeout\-seconds\fR \fI<value>\fR
|
|
121
|
+
Optional.
|
|
122
|
+
.TP
|
|
123
|
+
\fB\-\-settings.sub\-agents\fR \fI<value>\fR
|
|
124
|
+
Optional.
|
|
125
|
+
.SH "GLOBAL OPTIONS"
|
|
126
|
+
.TP
|
|
127
|
+
\fB\-\-data\fR \fI<json>\fR
|
|
128
|
+
Request body as JSON, or @file to read one (@\- for stdin).
|
|
129
|
+
.TP
|
|
130
|
+
\fB\-y\fR, \fB\-\-yes\fR
|
|
131
|
+
Skip confirmation prompts.
|
|
132
|
+
.TP
|
|
133
|
+
\fB\-\-no\-input\fR
|
|
134
|
+
Never prompt; fail instead.
|
|
135
|
+
.TP
|
|
136
|
+
\fB\-\-base\-url\fR \fI<url>\fR
|
|
137
|
+
API base URL.
|
|
138
|
+
.TP
|
|
139
|
+
\fB\-\-token\fR \fI<token>\fR
|
|
140
|
+
Bearer token. Prefer ROARK_API_BEARER_TOKEN or the stored credential.
|
|
141
|
+
.TP
|
|
142
|
+
\fB\-\-timeout\fR \fI<ms>\fR
|
|
143
|
+
Request timeout in milliseconds.
|
|
144
|
+
.TP
|
|
145
|
+
\fB\-\-max\-retries\fR \fI<count>\fR
|
|
146
|
+
Retries for retryable failures.
|
|
147
|
+
.TP
|
|
148
|
+
\fB\-\-format\fR \fI<format>\fR
|
|
149
|
+
Output format: auto, json, jsonl, plain.
|
|
150
|
+
.TP
|
|
151
|
+
\fB\-\-json\fR
|
|
152
|
+
Shorthand for \-\-format json.
|
|
153
|
+
.TP
|
|
154
|
+
\fB\-\-no\-color\fR
|
|
155
|
+
Disable colour.
|
|
156
|
+
.TP
|
|
157
|
+
\fB\-q\fR, \fB\-\-quiet\fR
|
|
158
|
+
Suppress non\-essential output.
|
|
159
|
+
.TP
|
|
160
|
+
\fB\-\-allow\-project\-base\-url\fR
|
|
161
|
+
Send the stored credential to a base URL set by a project .roark.json. Refused by default.
|
|
162
|
+
.SH "EXAMPLES"
|
|
163
|
+
.PP
|
|
164
|
+
.RS 4
|
|
165
|
+
.nf
|
|
166
|
+
roark agent draft update <agent\-id> \-\-settings <value>
|
|
167
|
+
.fi
|
|
168
|
+
.RE
|
|
169
|
+
.SH "ENVIRONMENT"
|
|
170
|
+
.TP
|
|
171
|
+
\fBROARK_API_BEARER_TOKEN\fR
|
|
172
|
+
Bearer token used when \-\-token is not given.
|
|
173
|
+
.TP
|
|
174
|
+
\fBROARK_BASE_URL\fR
|
|
175
|
+
API base URL.
|
|
176
|
+
.TP
|
|
177
|
+
\fBROARK_ALLOW_PROJECT_BASE_URL\fR
|
|
178
|
+
Trusts a base URL set by a project .roark.json, like \-\-allow\-project\-base\-url.
|
|
179
|
+
.TP
|
|
180
|
+
\fBNO_COLOR\fR
|
|
181
|
+
Disables colour when set to any value.
|
|
182
|
+
.SH "EXIT STATUS"
|
|
183
|
+
.TP
|
|
184
|
+
\fB0\fR
|
|
185
|
+
The command succeeded.
|
|
186
|
+
.TP
|
|
187
|
+
\fB1\fR
|
|
188
|
+
The API rejected the request.
|
|
189
|
+
.TP
|
|
190
|
+
\fB2\fR
|
|
191
|
+
The command line was wrong.
|
|
192
|
+
.TP
|
|
193
|
+
\fB3\fR
|
|
194
|
+
No credential, or the credential was refused.
|
|
195
|
+
.TP
|
|
196
|
+
\fB4\fR
|
|
197
|
+
The addressed resource does not exist.
|
|
198
|
+
.TP
|
|
199
|
+
\fB5\fR
|
|
200
|
+
The request never completed: connection, timeout, or abort.
|
|
201
|
+
.SH "SEE ALSO"
|
|
202
|
+
.BR roark (1)
|
|
@@ -0,0 +1,96 @@
|
|
|
1
|
+
.\" File generated from our OpenAPI spec by app-agent-codegen. Do not edit.
|
|
2
|
+
.TH "ROARK\-AGENT\-VERSION\-GET" "1" "" "roark-agent-version-get" "Roark Analytics API Manual"
|
|
3
|
+
.SH "NAME"
|
|
4
|
+
roark\-agent\-version\-get \- Get an agent version
|
|
5
|
+
.SH "SYNOPSIS"
|
|
6
|
+
.B roark agent version get
|
|
7
|
+
\fIagent\-id\fR \fIversion\-id\fR [\fIoptions\fR]
|
|
8
|
+
.SH "DESCRIPTION"
|
|
9
|
+
One version with every setting, plus the issues that stop it from running, if any.
|
|
10
|
+
.SH "API"
|
|
11
|
+
GET /v1/agent/{agentId}/versions/{versionId}
|
|
12
|
+
.SH "ARGUMENTS"
|
|
13
|
+
.TP
|
|
14
|
+
\fIagent\-id\fR
|
|
15
|
+
The agent\-id.
|
|
16
|
+
.TP
|
|
17
|
+
\fIversion\-id\fR
|
|
18
|
+
The version\-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 agent version get <agent\-id> <version\-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)
|