JavaScript
import Roark from '@roarkanalytics/sdk';
const client = new Roark({
bearerToken: process.env['ROARK_API_BEARER_TOKEN'], // This is the default and can be omitted
});
const agentDraft = await client.agentDraft.update('182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e', {
settings: {},
});
console.log(agentDraft.data);import os
from roark_analytics import Roark
client = Roark(
bearer_token=os.environ.get("ROARK_API_BEARER_TOKEN"), # This is the default and can be omitted
)
agent_draft = client.agent_draft.update(
agent_id="182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
settings={},
)
print(agent_draft.data)curl --request PATCH \
--url https://api.roark.ai/v1/agent/{agentId}/draft \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"settings": {
"modalities": [],
"language": "<string>",
"firstMessage": "<string>",
"firstMessageAudioUrl": "<string>",
"llmModel": "<string>",
"llmTemperature": 1,
"llmMaxTokens": 64000,
"llmBackendModel": "<string>",
"llmVoice": "<string>",
"sttModel": "<string>",
"sttKeyterms": [
"<string>"
],
"sttSmartFormat": true,
"sttEndpointingMs": 2505,
"vadStartSecs": 2.5,
"vadStopSecs": 2.5,
"callMaxDurationSeconds": 1815,
"callSilenceTimeoutSeconds": 62,
"idleTimeoutSeconds": 30,
"idleMaxCount": 5,
"idleMessages": [
"<string>"
],
"endDetectionPhrases": [
"<string>"
],
"endDetectionReasons": [
"<string>"
],
"endCallGoodbyeMessage": "<string>",
"backgroundNoiseUrl": "<string>",
"backgroundNoiseVolume": 0.5,
"chatMaxDurationSeconds": 43215,
"chatInactivityTimeoutSeconds": 43230,
"subAgents": [
{
"key": "main",
"name": "<string>",
"systemPrompt": "<string>",
"isInitial": true,
"ttsModel": "<string>",
"ttsVoiceId": "<string>",
"ttsSpeed": 1.25,
"ttsStability": 0.5,
"ttsSimilarityBoost": 0.5,
"tools": [
{
"toolDefinitionId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"pinnedVersion": 2
}
],
"handoffs": [
{
"to": "main",
"description": "<string>",
"once": true,
"note": "<string>"
}
]
}
]
},
"expectedRevision": 2
}
'<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.roark.ai/v1/agent/{agentId}/draft",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'settings' => [
'modalities' => [
],
'language' => '<string>',
'firstMessage' => '<string>',
'firstMessageAudioUrl' => '<string>',
'llmModel' => '<string>',
'llmTemperature' => 1,
'llmMaxTokens' => 64000,
'llmBackendModel' => '<string>',
'llmVoice' => '<string>',
'sttModel' => '<string>',
'sttKeyterms' => [
'<string>'
],
'sttSmartFormat' => true,
'sttEndpointingMs' => 2505,
'vadStartSecs' => 2.5,
'vadStopSecs' => 2.5,
'callMaxDurationSeconds' => 1815,
'callSilenceTimeoutSeconds' => 62,
'idleTimeoutSeconds' => 30,
'idleMaxCount' => 5,
'idleMessages' => [
'<string>'
],
'endDetectionPhrases' => [
'<string>'
],
'endDetectionReasons' => [
'<string>'
],
'endCallGoodbyeMessage' => '<string>',
'backgroundNoiseUrl' => '<string>',
'backgroundNoiseVolume' => 0.5,
'chatMaxDurationSeconds' => 43215,
'chatInactivityTimeoutSeconds' => 43230,
'subAgents' => [
[
'key' => 'main',
'name' => '<string>',
'systemPrompt' => '<string>',
'isInitial' => true,
'ttsModel' => '<string>',
'ttsVoiceId' => '<string>',
'ttsSpeed' => 1.25,
'ttsStability' => 0.5,
'ttsSimilarityBoost' => 0.5,
'tools' => [
[
'toolDefinitionId' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'pinnedVersion' => 2
]
],
'handoffs' => [
[
'to' => 'main',
'description' => '<string>',
'once' => true,
'note' => '<string>'
]
]
]
]
],
'expectedRevision' => 2
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.roark.ai/v1/agent/{agentId}/draft"
payload := strings.NewReader("{\n \"settings\": {\n \"modalities\": [],\n \"language\": \"<string>\",\n \"firstMessage\": \"<string>\",\n \"firstMessageAudioUrl\": \"<string>\",\n \"llmModel\": \"<string>\",\n \"llmTemperature\": 1,\n \"llmMaxTokens\": 64000,\n \"llmBackendModel\": \"<string>\",\n \"llmVoice\": \"<string>\",\n \"sttModel\": \"<string>\",\n \"sttKeyterms\": [\n \"<string>\"\n ],\n \"sttSmartFormat\": true,\n \"sttEndpointingMs\": 2505,\n \"vadStartSecs\": 2.5,\n \"vadStopSecs\": 2.5,\n \"callMaxDurationSeconds\": 1815,\n \"callSilenceTimeoutSeconds\": 62,\n \"idleTimeoutSeconds\": 30,\n \"idleMaxCount\": 5,\n \"idleMessages\": [\n \"<string>\"\n ],\n \"endDetectionPhrases\": [\n \"<string>\"\n ],\n \"endDetectionReasons\": [\n \"<string>\"\n ],\n \"endCallGoodbyeMessage\": \"<string>\",\n \"backgroundNoiseUrl\": \"<string>\",\n \"backgroundNoiseVolume\": 0.5,\n \"chatMaxDurationSeconds\": 43215,\n \"chatInactivityTimeoutSeconds\": 43230,\n \"subAgents\": [\n {\n \"key\": \"main\",\n \"name\": \"<string>\",\n \"systemPrompt\": \"<string>\",\n \"isInitial\": true,\n \"ttsModel\": \"<string>\",\n \"ttsVoiceId\": \"<string>\",\n \"ttsSpeed\": 1.25,\n \"ttsStability\": 0.5,\n \"ttsSimilarityBoost\": 0.5,\n \"tools\": [\n {\n \"toolDefinitionId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"pinnedVersion\": 2\n }\n ],\n \"handoffs\": [\n {\n \"to\": \"main\",\n \"description\": \"<string>\",\n \"once\": true,\n \"note\": \"<string>\"\n }\n ]\n }\n ]\n },\n \"expectedRevision\": 2\n}")
req, _ := http.NewRequest("PATCH", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.patch("https://api.roark.ai/v1/agent/{agentId}/draft")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"settings\": {\n \"modalities\": [],\n \"language\": \"<string>\",\n \"firstMessage\": \"<string>\",\n \"firstMessageAudioUrl\": \"<string>\",\n \"llmModel\": \"<string>\",\n \"llmTemperature\": 1,\n \"llmMaxTokens\": 64000,\n \"llmBackendModel\": \"<string>\",\n \"llmVoice\": \"<string>\",\n \"sttModel\": \"<string>\",\n \"sttKeyterms\": [\n \"<string>\"\n ],\n \"sttSmartFormat\": true,\n \"sttEndpointingMs\": 2505,\n \"vadStartSecs\": 2.5,\n \"vadStopSecs\": 2.5,\n \"callMaxDurationSeconds\": 1815,\n \"callSilenceTimeoutSeconds\": 62,\n \"idleTimeoutSeconds\": 30,\n \"idleMaxCount\": 5,\n \"idleMessages\": [\n \"<string>\"\n ],\n \"endDetectionPhrases\": [\n \"<string>\"\n ],\n \"endDetectionReasons\": [\n \"<string>\"\n ],\n \"endCallGoodbyeMessage\": \"<string>\",\n \"backgroundNoiseUrl\": \"<string>\",\n \"backgroundNoiseVolume\": 0.5,\n \"chatMaxDurationSeconds\": 43215,\n \"chatInactivityTimeoutSeconds\": 43230,\n \"subAgents\": [\n {\n \"key\": \"main\",\n \"name\": \"<string>\",\n \"systemPrompt\": \"<string>\",\n \"isInitial\": true,\n \"ttsModel\": \"<string>\",\n \"ttsVoiceId\": \"<string>\",\n \"ttsSpeed\": 1.25,\n \"ttsStability\": 0.5,\n \"ttsSimilarityBoost\": 0.5,\n \"tools\": [\n {\n \"toolDefinitionId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"pinnedVersion\": 2\n }\n ],\n \"handoffs\": [\n {\n \"to\": \"main\",\n \"description\": \"<string>\",\n \"once\": true,\n \"note\": \"<string>\"\n }\n ]\n }\n ]\n },\n \"expectedRevision\": 2\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.roark.ai/v1/agent/{agentId}/draft")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"settings\": {\n \"modalities\": [],\n \"language\": \"<string>\",\n \"firstMessage\": \"<string>\",\n \"firstMessageAudioUrl\": \"<string>\",\n \"llmModel\": \"<string>\",\n \"llmTemperature\": 1,\n \"llmMaxTokens\": 64000,\n \"llmBackendModel\": \"<string>\",\n \"llmVoice\": \"<string>\",\n \"sttModel\": \"<string>\",\n \"sttKeyterms\": [\n \"<string>\"\n ],\n \"sttSmartFormat\": true,\n \"sttEndpointingMs\": 2505,\n \"vadStartSecs\": 2.5,\n \"vadStopSecs\": 2.5,\n \"callMaxDurationSeconds\": 1815,\n \"callSilenceTimeoutSeconds\": 62,\n \"idleTimeoutSeconds\": 30,\n \"idleMaxCount\": 5,\n \"idleMessages\": [\n \"<string>\"\n ],\n \"endDetectionPhrases\": [\n \"<string>\"\n ],\n \"endDetectionReasons\": [\n \"<string>\"\n ],\n \"endCallGoodbyeMessage\": \"<string>\",\n \"backgroundNoiseUrl\": \"<string>\",\n \"backgroundNoiseVolume\": 0.5,\n \"chatMaxDurationSeconds\": 43215,\n \"chatInactivityTimeoutSeconds\": 43230,\n \"subAgents\": [\n {\n \"key\": \"main\",\n \"name\": \"<string>\",\n \"systemPrompt\": \"<string>\",\n \"isInitial\": true,\n \"ttsModel\": \"<string>\",\n \"ttsVoiceId\": \"<string>\",\n \"ttsSpeed\": 1.25,\n \"ttsStability\": 0.5,\n \"ttsSimilarityBoost\": 0.5,\n \"tools\": [\n {\n \"toolDefinitionId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"pinnedVersion\": 2\n }\n ],\n \"handoffs\": [\n {\n \"to\": \"main\",\n \"description\": \"<string>\",\n \"once\": true,\n \"note\": \"<string>\"\n }\n ]\n }\n ]\n },\n \"expectedRevision\": 2\n}"
response = http.request(request)
puts response.read_body{
"data": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"agentId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"status": "DRAFT",
"versionNumber": 123,
"revision": 123,
"baseVersionId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"restoredFromVersionId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"summary": "<string>",
"createdByType": "USER",
"createdById": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"publishedAt": "<string>",
"publishedByType": "USER",
"publishedById": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"createdAt": "<string>",
"updatedAt": "<string>",
"modalities": [
"call"
],
"language": "<string>",
"firstMessageMode": "SPEAK_TEXT",
"firstMessage": "<string>",
"firstMessageAudioUrl": "<string>",
"llmProvider": "OPENAI",
"llmModel": "<string>",
"llmTemperature": 123,
"llmMaxTokens": 123,
"llmBackendModel": "<string>",
"llmVoice": "<string>",
"sttProvider": "DEEPGRAM",
"sttModel": "<string>",
"sttKeyterms": [
"<string>"
],
"sttSmartFormat": true,
"sttEndpointingMs": 123,
"sttTurnDetection": "pipeline",
"interruptionMode": "ALLOW",
"vadStartSecs": 123,
"vadStopSecs": 123,
"callMaxDurationSeconds": 123,
"callSilenceTimeoutSeconds": 123,
"idleTimeoutSeconds": 123,
"idleMaxCount": 123,
"idleMessages": [
"<string>"
],
"endDetectionPhrases": [
"<string>"
],
"endDetectionReasons": [
"<string>"
],
"endCallGoodbyeMessage": "<string>",
"backgroundNoise": "NONE",
"backgroundNoiseUrl": "<string>",
"backgroundNoiseVolume": 123,
"chatMaxDurationSeconds": 123,
"chatInactivityTimeoutSeconds": 123,
"subAgents": [
{
"key": "<string>",
"name": "<string>",
"systemPrompt": "<string>",
"isInitial": true,
"ttsProvider": "CARTESIA",
"ttsModel": "<string>",
"ttsVoiceId": "<string>",
"ttsSpeed": 123,
"ttsStability": 123,
"ttsSimilarityBoost": 123,
"tools": [
{
"toolDefinitionId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"pinnedVersion": 123
}
],
"handoffs": [
{
"to": "<string>",
"description": "<string>",
"once": true,
"history": "SHARED",
"note": "<string>"
}
]
}
],
"issues": [
{
"field": "<string>",
"message": "<string>"
}
]
}
}{
"type": "validation",
"code": "invalid_parameter",
"message": "The request was invalid",
"param": "email"
}{
"type": "authentication",
"code": "unauthorized",
"message": "Authentication required"
}{
"type": "forbidden",
"code": "permission_denied",
"message": "You do not have permission to access this resource"
}{
"type": "not_found",
"code": "resource_not_found",
"message": "The requested resource could not be found"
}{
"type": "conflict",
"code": "resource_in_use",
"message": "The resource is in use and cannot be deleted"
}{
"type": "internal",
"code": "internal_error",
"message": "Internal server error"
}Agent
Edit the draft
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.
PATCH
/
v1
/
agent
/
{agentId}
/
draft
JavaScript
import Roark from '@roarkanalytics/sdk';
const client = new Roark({
bearerToken: process.env['ROARK_API_BEARER_TOKEN'], // This is the default and can be omitted
});
const agentDraft = await client.agentDraft.update('182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e', {
settings: {},
});
console.log(agentDraft.data);import os
from roark_analytics import Roark
client = Roark(
bearer_token=os.environ.get("ROARK_API_BEARER_TOKEN"), # This is the default and can be omitted
)
agent_draft = client.agent_draft.update(
agent_id="182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
settings={},
)
print(agent_draft.data)curl --request PATCH \
--url https://api.roark.ai/v1/agent/{agentId}/draft \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"settings": {
"modalities": [],
"language": "<string>",
"firstMessage": "<string>",
"firstMessageAudioUrl": "<string>",
"llmModel": "<string>",
"llmTemperature": 1,
"llmMaxTokens": 64000,
"llmBackendModel": "<string>",
"llmVoice": "<string>",
"sttModel": "<string>",
"sttKeyterms": [
"<string>"
],
"sttSmartFormat": true,
"sttEndpointingMs": 2505,
"vadStartSecs": 2.5,
"vadStopSecs": 2.5,
"callMaxDurationSeconds": 1815,
"callSilenceTimeoutSeconds": 62,
"idleTimeoutSeconds": 30,
"idleMaxCount": 5,
"idleMessages": [
"<string>"
],
"endDetectionPhrases": [
"<string>"
],
"endDetectionReasons": [
"<string>"
],
"endCallGoodbyeMessage": "<string>",
"backgroundNoiseUrl": "<string>",
"backgroundNoiseVolume": 0.5,
"chatMaxDurationSeconds": 43215,
"chatInactivityTimeoutSeconds": 43230,
"subAgents": [
{
"key": "main",
"name": "<string>",
"systemPrompt": "<string>",
"isInitial": true,
"ttsModel": "<string>",
"ttsVoiceId": "<string>",
"ttsSpeed": 1.25,
"ttsStability": 0.5,
"ttsSimilarityBoost": 0.5,
"tools": [
{
"toolDefinitionId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"pinnedVersion": 2
}
],
"handoffs": [
{
"to": "main",
"description": "<string>",
"once": true,
"note": "<string>"
}
]
}
]
},
"expectedRevision": 2
}
'<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.roark.ai/v1/agent/{agentId}/draft",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'settings' => [
'modalities' => [
],
'language' => '<string>',
'firstMessage' => '<string>',
'firstMessageAudioUrl' => '<string>',
'llmModel' => '<string>',
'llmTemperature' => 1,
'llmMaxTokens' => 64000,
'llmBackendModel' => '<string>',
'llmVoice' => '<string>',
'sttModel' => '<string>',
'sttKeyterms' => [
'<string>'
],
'sttSmartFormat' => true,
'sttEndpointingMs' => 2505,
'vadStartSecs' => 2.5,
'vadStopSecs' => 2.5,
'callMaxDurationSeconds' => 1815,
'callSilenceTimeoutSeconds' => 62,
'idleTimeoutSeconds' => 30,
'idleMaxCount' => 5,
'idleMessages' => [
'<string>'
],
'endDetectionPhrases' => [
'<string>'
],
'endDetectionReasons' => [
'<string>'
],
'endCallGoodbyeMessage' => '<string>',
'backgroundNoiseUrl' => '<string>',
'backgroundNoiseVolume' => 0.5,
'chatMaxDurationSeconds' => 43215,
'chatInactivityTimeoutSeconds' => 43230,
'subAgents' => [
[
'key' => 'main',
'name' => '<string>',
'systemPrompt' => '<string>',
'isInitial' => true,
'ttsModel' => '<string>',
'ttsVoiceId' => '<string>',
'ttsSpeed' => 1.25,
'ttsStability' => 0.5,
'ttsSimilarityBoost' => 0.5,
'tools' => [
[
'toolDefinitionId' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'pinnedVersion' => 2
]
],
'handoffs' => [
[
'to' => 'main',
'description' => '<string>',
'once' => true,
'note' => '<string>'
]
]
]
]
],
'expectedRevision' => 2
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.roark.ai/v1/agent/{agentId}/draft"
payload := strings.NewReader("{\n \"settings\": {\n \"modalities\": [],\n \"language\": \"<string>\",\n \"firstMessage\": \"<string>\",\n \"firstMessageAudioUrl\": \"<string>\",\n \"llmModel\": \"<string>\",\n \"llmTemperature\": 1,\n \"llmMaxTokens\": 64000,\n \"llmBackendModel\": \"<string>\",\n \"llmVoice\": \"<string>\",\n \"sttModel\": \"<string>\",\n \"sttKeyterms\": [\n \"<string>\"\n ],\n \"sttSmartFormat\": true,\n \"sttEndpointingMs\": 2505,\n \"vadStartSecs\": 2.5,\n \"vadStopSecs\": 2.5,\n \"callMaxDurationSeconds\": 1815,\n \"callSilenceTimeoutSeconds\": 62,\n \"idleTimeoutSeconds\": 30,\n \"idleMaxCount\": 5,\n \"idleMessages\": [\n \"<string>\"\n ],\n \"endDetectionPhrases\": [\n \"<string>\"\n ],\n \"endDetectionReasons\": [\n \"<string>\"\n ],\n \"endCallGoodbyeMessage\": \"<string>\",\n \"backgroundNoiseUrl\": \"<string>\",\n \"backgroundNoiseVolume\": 0.5,\n \"chatMaxDurationSeconds\": 43215,\n \"chatInactivityTimeoutSeconds\": 43230,\n \"subAgents\": [\n {\n \"key\": \"main\",\n \"name\": \"<string>\",\n \"systemPrompt\": \"<string>\",\n \"isInitial\": true,\n \"ttsModel\": \"<string>\",\n \"ttsVoiceId\": \"<string>\",\n \"ttsSpeed\": 1.25,\n \"ttsStability\": 0.5,\n \"ttsSimilarityBoost\": 0.5,\n \"tools\": [\n {\n \"toolDefinitionId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"pinnedVersion\": 2\n }\n ],\n \"handoffs\": [\n {\n \"to\": \"main\",\n \"description\": \"<string>\",\n \"once\": true,\n \"note\": \"<string>\"\n }\n ]\n }\n ]\n },\n \"expectedRevision\": 2\n}")
req, _ := http.NewRequest("PATCH", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.patch("https://api.roark.ai/v1/agent/{agentId}/draft")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"settings\": {\n \"modalities\": [],\n \"language\": \"<string>\",\n \"firstMessage\": \"<string>\",\n \"firstMessageAudioUrl\": \"<string>\",\n \"llmModel\": \"<string>\",\n \"llmTemperature\": 1,\n \"llmMaxTokens\": 64000,\n \"llmBackendModel\": \"<string>\",\n \"llmVoice\": \"<string>\",\n \"sttModel\": \"<string>\",\n \"sttKeyterms\": [\n \"<string>\"\n ],\n \"sttSmartFormat\": true,\n \"sttEndpointingMs\": 2505,\n \"vadStartSecs\": 2.5,\n \"vadStopSecs\": 2.5,\n \"callMaxDurationSeconds\": 1815,\n \"callSilenceTimeoutSeconds\": 62,\n \"idleTimeoutSeconds\": 30,\n \"idleMaxCount\": 5,\n \"idleMessages\": [\n \"<string>\"\n ],\n \"endDetectionPhrases\": [\n \"<string>\"\n ],\n \"endDetectionReasons\": [\n \"<string>\"\n ],\n \"endCallGoodbyeMessage\": \"<string>\",\n \"backgroundNoiseUrl\": \"<string>\",\n \"backgroundNoiseVolume\": 0.5,\n \"chatMaxDurationSeconds\": 43215,\n \"chatInactivityTimeoutSeconds\": 43230,\n \"subAgents\": [\n {\n \"key\": \"main\",\n \"name\": \"<string>\",\n \"systemPrompt\": \"<string>\",\n \"isInitial\": true,\n \"ttsModel\": \"<string>\",\n \"ttsVoiceId\": \"<string>\",\n \"ttsSpeed\": 1.25,\n \"ttsStability\": 0.5,\n \"ttsSimilarityBoost\": 0.5,\n \"tools\": [\n {\n \"toolDefinitionId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"pinnedVersion\": 2\n }\n ],\n \"handoffs\": [\n {\n \"to\": \"main\",\n \"description\": \"<string>\",\n \"once\": true,\n \"note\": \"<string>\"\n }\n ]\n }\n ]\n },\n \"expectedRevision\": 2\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.roark.ai/v1/agent/{agentId}/draft")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"settings\": {\n \"modalities\": [],\n \"language\": \"<string>\",\n \"firstMessage\": \"<string>\",\n \"firstMessageAudioUrl\": \"<string>\",\n \"llmModel\": \"<string>\",\n \"llmTemperature\": 1,\n \"llmMaxTokens\": 64000,\n \"llmBackendModel\": \"<string>\",\n \"llmVoice\": \"<string>\",\n \"sttModel\": \"<string>\",\n \"sttKeyterms\": [\n \"<string>\"\n ],\n \"sttSmartFormat\": true,\n \"sttEndpointingMs\": 2505,\n \"vadStartSecs\": 2.5,\n \"vadStopSecs\": 2.5,\n \"callMaxDurationSeconds\": 1815,\n \"callSilenceTimeoutSeconds\": 62,\n \"idleTimeoutSeconds\": 30,\n \"idleMaxCount\": 5,\n \"idleMessages\": [\n \"<string>\"\n ],\n \"endDetectionPhrases\": [\n \"<string>\"\n ],\n \"endDetectionReasons\": [\n \"<string>\"\n ],\n \"endCallGoodbyeMessage\": \"<string>\",\n \"backgroundNoiseUrl\": \"<string>\",\n \"backgroundNoiseVolume\": 0.5,\n \"chatMaxDurationSeconds\": 43215,\n \"chatInactivityTimeoutSeconds\": 43230,\n \"subAgents\": [\n {\n \"key\": \"main\",\n \"name\": \"<string>\",\n \"systemPrompt\": \"<string>\",\n \"isInitial\": true,\n \"ttsModel\": \"<string>\",\n \"ttsVoiceId\": \"<string>\",\n \"ttsSpeed\": 1.25,\n \"ttsStability\": 0.5,\n \"ttsSimilarityBoost\": 0.5,\n \"tools\": [\n {\n \"toolDefinitionId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"pinnedVersion\": 2\n }\n ],\n \"handoffs\": [\n {\n \"to\": \"main\",\n \"description\": \"<string>\",\n \"once\": true,\n \"note\": \"<string>\"\n }\n ]\n }\n ]\n },\n \"expectedRevision\": 2\n}"
response = http.request(request)
puts response.read_body{
"data": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"agentId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"status": "DRAFT",
"versionNumber": 123,
"revision": 123,
"baseVersionId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"restoredFromVersionId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"summary": "<string>",
"createdByType": "USER",
"createdById": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"publishedAt": "<string>",
"publishedByType": "USER",
"publishedById": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"createdAt": "<string>",
"updatedAt": "<string>",
"modalities": [
"call"
],
"language": "<string>",
"firstMessageMode": "SPEAK_TEXT",
"firstMessage": "<string>",
"firstMessageAudioUrl": "<string>",
"llmProvider": "OPENAI",
"llmModel": "<string>",
"llmTemperature": 123,
"llmMaxTokens": 123,
"llmBackendModel": "<string>",
"llmVoice": "<string>",
"sttProvider": "DEEPGRAM",
"sttModel": "<string>",
"sttKeyterms": [
"<string>"
],
"sttSmartFormat": true,
"sttEndpointingMs": 123,
"sttTurnDetection": "pipeline",
"interruptionMode": "ALLOW",
"vadStartSecs": 123,
"vadStopSecs": 123,
"callMaxDurationSeconds": 123,
"callSilenceTimeoutSeconds": 123,
"idleTimeoutSeconds": 123,
"idleMaxCount": 123,
"idleMessages": [
"<string>"
],
"endDetectionPhrases": [
"<string>"
],
"endDetectionReasons": [
"<string>"
],
"endCallGoodbyeMessage": "<string>",
"backgroundNoise": "NONE",
"backgroundNoiseUrl": "<string>",
"backgroundNoiseVolume": 123,
"chatMaxDurationSeconds": 123,
"chatInactivityTimeoutSeconds": 123,
"subAgents": [
{
"key": "<string>",
"name": "<string>",
"systemPrompt": "<string>",
"isInitial": true,
"ttsProvider": "CARTESIA",
"ttsModel": "<string>",
"ttsVoiceId": "<string>",
"ttsSpeed": 123,
"ttsStability": 123,
"ttsSimilarityBoost": 123,
"tools": [
{
"toolDefinitionId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"pinnedVersion": 123
}
],
"handoffs": [
{
"to": "<string>",
"description": "<string>",
"once": true,
"history": "SHARED",
"note": "<string>"
}
]
}
],
"issues": [
{
"field": "<string>",
"message": "<string>"
}
]
}
}{
"type": "validation",
"code": "invalid_parameter",
"message": "The request was invalid",
"param": "email"
}{
"type": "authentication",
"code": "unauthorized",
"message": "Authentication required"
}{
"type": "forbidden",
"code": "permission_denied",
"message": "You do not have permission to access this resource"
}{
"type": "not_found",
"code": "resource_not_found",
"message": "The requested resource could not be found"
}{
"type": "conflict",
"code": "resource_in_use",
"message": "The resource is in use and cannot be deleted"
}{
"type": "internal",
"code": "internal_error",
"message": "Internal server error"
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Path Parameters
Body
application/json
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.
Show child attributes
Show child attributes
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.
Required range:
x >= 1Response
The edited draft.
One version of a Roark-hosted agent's configuration. Null settings use the runtime default.
Show child attributes
Show child attributes