Agents
Update an agent
Updates an agent’s information. Partial updates are supported. You can update only the name, role, description, instructions, personaId, toolIds and knowledge.
PATCH
/
agents
/
{id}
Update an agent
curl --request PATCH \
--url https://api-trial.cognigy.ai/v1/agents/{id} \
--header 'Content-Type: application/json' \
--header 'X-API-Key: <api-key>' \
--data '
{
"description": "<string>",
"disabledToolReferenceIds": [
"<string>"
],
"guardrails": {
"dataPrivacy": {
"contactProfilesOption": "completeProfile",
"selectedProfileFields": [
"<string>"
]
},
"safetySettings": {
"avoidCopyrightInfringements": true,
"avoidHarmfulContent": true,
"avoidUngroundedContent": true,
"preventJailbreakAndManipulation": true
}
},
"hooks": {},
"image": "<string>",
"imageOptimizedFormat": true,
"instructions": "<string>",
"knowledge": {
"cognigyParameters": {
"present": true,
"value": {
"language": {
"present": true,
"value": "<string>"
},
"stores": {
"present": true,
"value": [
"<string>"
]
},
"topK": {
"present": true,
"value": 123
}
}
},
"context": {
"present": true,
"value": "<string>"
},
"onSearchFailure": {
"present": true,
"value": "<string>"
},
"ragMode": {
"present": true,
"value": "<string>"
},
"ragType": {
"present": true,
"value": "<string>"
}
},
"largeLanguageModelReferenceId": "<string>",
"llmConfig": {
"maxOutputTokens": 123,
"reasoningEffort": "<string>",
"temperature": 123
},
"localeReferenceId": "<string>",
"name": "<string>",
"personaReferenceId": "<string>",
"realtimeVoice": "<string>",
"role": "<string>",
"skillReferenceIds": [
"<string>"
],
"toolReferenceIds": [
"<string>"
],
"voiceLargeLanguageModelReferenceId": "<string>",
"voicePromptTemplate": "<string>"
}
'import requests
url = "https://api-trial.cognigy.ai/v1/agents/{id}"
payload = {
"description": "<string>",
"disabledToolReferenceIds": ["<string>"],
"guardrails": {
"dataPrivacy": {
"contactProfilesOption": "completeProfile",
"selectedProfileFields": ["<string>"]
},
"safetySettings": {
"avoidCopyrightInfringements": True,
"avoidHarmfulContent": True,
"avoidUngroundedContent": True,
"preventJailbreakAndManipulation": True
}
},
"hooks": {},
"image": "<string>",
"imageOptimizedFormat": True,
"instructions": "<string>",
"knowledge": {
"cognigyParameters": {
"present": True,
"value": {
"language": {
"present": True,
"value": "<string>"
},
"stores": {
"present": True,
"value": ["<string>"]
},
"topK": {
"present": True,
"value": 123
}
}
},
"context": {
"present": True,
"value": "<string>"
},
"onSearchFailure": {
"present": True,
"value": "<string>"
},
"ragMode": {
"present": True,
"value": "<string>"
},
"ragType": {
"present": True,
"value": "<string>"
}
},
"largeLanguageModelReferenceId": "<string>",
"llmConfig": {
"maxOutputTokens": 123,
"reasoningEffort": "<string>",
"temperature": 123
},
"localeReferenceId": "<string>",
"name": "<string>",
"personaReferenceId": "<string>",
"realtimeVoice": "<string>",
"role": "<string>",
"skillReferenceIds": ["<string>"],
"toolReferenceIds": ["<string>"],
"voiceLargeLanguageModelReferenceId": "<string>",
"voicePromptTemplate": "<string>"
}
headers = {
"X-API-Key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {'X-API-Key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
description: '<string>',
disabledToolReferenceIds: ['<string>'],
guardrails: {
dataPrivacy: {contactProfilesOption: 'completeProfile', selectedProfileFields: ['<string>']},
safetySettings: {
avoidCopyrightInfringements: true,
avoidHarmfulContent: true,
avoidUngroundedContent: true,
preventJailbreakAndManipulation: true
}
},
hooks: {},
image: '<string>',
imageOptimizedFormat: true,
instructions: '<string>',
knowledge: {
cognigyParameters: {
present: true,
value: {
language: {present: true, value: '<string>'},
stores: {present: true, value: ['<string>']},
topK: {present: true, value: 123}
}
},
context: {present: true, value: '<string>'},
onSearchFailure: {present: true, value: '<string>'},
ragMode: {present: true, value: '<string>'},
ragType: {present: true, value: '<string>'}
},
largeLanguageModelReferenceId: '<string>',
llmConfig: {maxOutputTokens: 123, reasoningEffort: '<string>', temperature: 123},
localeReferenceId: '<string>',
name: '<string>',
personaReferenceId: '<string>',
realtimeVoice: '<string>',
role: '<string>',
skillReferenceIds: ['<string>'],
toolReferenceIds: ['<string>'],
voiceLargeLanguageModelReferenceId: '<string>',
voicePromptTemplate: '<string>'
})
};
fetch('https://api-trial.cognigy.ai/v1/agents/{id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api-trial.cognigy.ai/v1/agents/{id}",
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([
'description' => '<string>',
'disabledToolReferenceIds' => [
'<string>'
],
'guardrails' => [
'dataPrivacy' => [
'contactProfilesOption' => 'completeProfile',
'selectedProfileFields' => [
'<string>'
]
],
'safetySettings' => [
'avoidCopyrightInfringements' => true,
'avoidHarmfulContent' => true,
'avoidUngroundedContent' => true,
'preventJailbreakAndManipulation' => true
]
],
'hooks' => [
],
'image' => '<string>',
'imageOptimizedFormat' => true,
'instructions' => '<string>',
'knowledge' => [
'cognigyParameters' => [
'present' => true,
'value' => [
'language' => [
'present' => true,
'value' => '<string>'
],
'stores' => [
'present' => true,
'value' => [
'<string>'
]
],
'topK' => [
'present' => true,
'value' => 123
]
]
],
'context' => [
'present' => true,
'value' => '<string>'
],
'onSearchFailure' => [
'present' => true,
'value' => '<string>'
],
'ragMode' => [
'present' => true,
'value' => '<string>'
],
'ragType' => [
'present' => true,
'value' => '<string>'
]
],
'largeLanguageModelReferenceId' => '<string>',
'llmConfig' => [
'maxOutputTokens' => 123,
'reasoningEffort' => '<string>',
'temperature' => 123
],
'localeReferenceId' => '<string>',
'name' => '<string>',
'personaReferenceId' => '<string>',
'realtimeVoice' => '<string>',
'role' => '<string>',
'skillReferenceIds' => [
'<string>'
],
'toolReferenceIds' => [
'<string>'
],
'voiceLargeLanguageModelReferenceId' => '<string>',
'voicePromptTemplate' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-API-Key: <api-key>"
],
]);
$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-trial.cognigy.ai/v1/agents/{id}"
payload := strings.NewReader("{\n \"description\": \"<string>\",\n \"disabledToolReferenceIds\": [\n \"<string>\"\n ],\n \"guardrails\": {\n \"dataPrivacy\": {\n \"contactProfilesOption\": \"completeProfile\",\n \"selectedProfileFields\": [\n \"<string>\"\n ]\n },\n \"safetySettings\": {\n \"avoidCopyrightInfringements\": true,\n \"avoidHarmfulContent\": true,\n \"avoidUngroundedContent\": true,\n \"preventJailbreakAndManipulation\": true\n }\n },\n \"hooks\": {},\n \"image\": \"<string>\",\n \"imageOptimizedFormat\": true,\n \"instructions\": \"<string>\",\n \"knowledge\": {\n \"cognigyParameters\": {\n \"present\": true,\n \"value\": {\n \"language\": {\n \"present\": true,\n \"value\": \"<string>\"\n },\n \"stores\": {\n \"present\": true,\n \"value\": [\n \"<string>\"\n ]\n },\n \"topK\": {\n \"present\": true,\n \"value\": 123\n }\n }\n },\n \"context\": {\n \"present\": true,\n \"value\": \"<string>\"\n },\n \"onSearchFailure\": {\n \"present\": true,\n \"value\": \"<string>\"\n },\n \"ragMode\": {\n \"present\": true,\n \"value\": \"<string>\"\n },\n \"ragType\": {\n \"present\": true,\n \"value\": \"<string>\"\n }\n },\n \"largeLanguageModelReferenceId\": \"<string>\",\n \"llmConfig\": {\n \"maxOutputTokens\": 123,\n \"reasoningEffort\": \"<string>\",\n \"temperature\": 123\n },\n \"localeReferenceId\": \"<string>\",\n \"name\": \"<string>\",\n \"personaReferenceId\": \"<string>\",\n \"realtimeVoice\": \"<string>\",\n \"role\": \"<string>\",\n \"skillReferenceIds\": [\n \"<string>\"\n ],\n \"toolReferenceIds\": [\n \"<string>\"\n ],\n \"voiceLargeLanguageModelReferenceId\": \"<string>\",\n \"voicePromptTemplate\": \"<string>\"\n}")
req, _ := http.NewRequest("PATCH", url, payload)
req.Header.Add("X-API-Key", "<api-key>")
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-trial.cognigy.ai/v1/agents/{id}")
.header("X-API-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"description\": \"<string>\",\n \"disabledToolReferenceIds\": [\n \"<string>\"\n ],\n \"guardrails\": {\n \"dataPrivacy\": {\n \"contactProfilesOption\": \"completeProfile\",\n \"selectedProfileFields\": [\n \"<string>\"\n ]\n },\n \"safetySettings\": {\n \"avoidCopyrightInfringements\": true,\n \"avoidHarmfulContent\": true,\n \"avoidUngroundedContent\": true,\n \"preventJailbreakAndManipulation\": true\n }\n },\n \"hooks\": {},\n \"image\": \"<string>\",\n \"imageOptimizedFormat\": true,\n \"instructions\": \"<string>\",\n \"knowledge\": {\n \"cognigyParameters\": {\n \"present\": true,\n \"value\": {\n \"language\": {\n \"present\": true,\n \"value\": \"<string>\"\n },\n \"stores\": {\n \"present\": true,\n \"value\": [\n \"<string>\"\n ]\n },\n \"topK\": {\n \"present\": true,\n \"value\": 123\n }\n }\n },\n \"context\": {\n \"present\": true,\n \"value\": \"<string>\"\n },\n \"onSearchFailure\": {\n \"present\": true,\n \"value\": \"<string>\"\n },\n \"ragMode\": {\n \"present\": true,\n \"value\": \"<string>\"\n },\n \"ragType\": {\n \"present\": true,\n \"value\": \"<string>\"\n }\n },\n \"largeLanguageModelReferenceId\": \"<string>\",\n \"llmConfig\": {\n \"maxOutputTokens\": 123,\n \"reasoningEffort\": \"<string>\",\n \"temperature\": 123\n },\n \"localeReferenceId\": \"<string>\",\n \"name\": \"<string>\",\n \"personaReferenceId\": \"<string>\",\n \"realtimeVoice\": \"<string>\",\n \"role\": \"<string>\",\n \"skillReferenceIds\": [\n \"<string>\"\n ],\n \"toolReferenceIds\": [\n \"<string>\"\n ],\n \"voiceLargeLanguageModelReferenceId\": \"<string>\",\n \"voicePromptTemplate\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api-trial.cognigy.ai/v1/agents/{id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["X-API-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"description\": \"<string>\",\n \"disabledToolReferenceIds\": [\n \"<string>\"\n ],\n \"guardrails\": {\n \"dataPrivacy\": {\n \"contactProfilesOption\": \"completeProfile\",\n \"selectedProfileFields\": [\n \"<string>\"\n ]\n },\n \"safetySettings\": {\n \"avoidCopyrightInfringements\": true,\n \"avoidHarmfulContent\": true,\n \"avoidUngroundedContent\": true,\n \"preventJailbreakAndManipulation\": true\n }\n },\n \"hooks\": {},\n \"image\": \"<string>\",\n \"imageOptimizedFormat\": true,\n \"instructions\": \"<string>\",\n \"knowledge\": {\n \"cognigyParameters\": {\n \"present\": true,\n \"value\": {\n \"language\": {\n \"present\": true,\n \"value\": \"<string>\"\n },\n \"stores\": {\n \"present\": true,\n \"value\": [\n \"<string>\"\n ]\n },\n \"topK\": {\n \"present\": true,\n \"value\": 123\n }\n }\n },\n \"context\": {\n \"present\": true,\n \"value\": \"<string>\"\n },\n \"onSearchFailure\": {\n \"present\": true,\n \"value\": \"<string>\"\n },\n \"ragMode\": {\n \"present\": true,\n \"value\": \"<string>\"\n },\n \"ragType\": {\n \"present\": true,\n \"value\": \"<string>\"\n }\n },\n \"largeLanguageModelReferenceId\": \"<string>\",\n \"llmConfig\": {\n \"maxOutputTokens\": 123,\n \"reasoningEffort\": \"<string>\",\n \"temperature\": 123\n },\n \"localeReferenceId\": \"<string>\",\n \"name\": \"<string>\",\n \"personaReferenceId\": \"<string>\",\n \"realtimeVoice\": \"<string>\",\n \"role\": \"<string>\",\n \"skillReferenceIds\": [\n \"<string>\"\n ],\n \"toolReferenceIds\": [\n \"<string>\"\n ],\n \"voiceLargeLanguageModelReferenceId\": \"<string>\",\n \"voicePromptTemplate\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"agentType": "voice",
"createdAt": 123,
"createdBy": "507f1f77bcf86cd799439011",
"description": "<string>",
"disabledToolReferenceIds": [
"<string>"
],
"guardrails": {
"dataPrivacy": {
"contactProfilesOption": "completeProfile",
"selectedProfileFields": [
"<string>"
]
},
"safetySettings": {
"avoidCopyrightInfringements": true,
"avoidHarmfulContent": true,
"avoidUngroundedContent": true,
"preventJailbreakAndManipulation": true
}
},
"hooks": {
"preTurn": [
{
"handler": {
"flowReferenceId": "<string>",
"kind": "<string>"
}
}
]
},
"id": "507f1f77bcf86cd799439011",
"image": "<string>",
"imageOptimizedFormat": true,
"instructions": "<string>",
"knowledge": {
"cognigyParameters": {
"language": "<string>",
"stores": [
"<string>"
],
"topK": 123
},
"context": "<string>",
"onSearchFailure": "<string>",
"ragMode": "<string>",
"ragType": "<string>"
},
"largeLanguageModelReferenceId": "<string>",
"lastChangedAt": 123,
"lastChangedBy": "507f1f77bcf86cd799439011",
"llmConfig": {
"maxOutputTokens": 123,
"reasoningEffort": "<string>",
"temperature": 123
},
"localeReferenceId": "<string>",
"name": "<string>",
"organisationId": "507f1f77bcf86cd799439011",
"personaReferenceId": "<string>",
"projectId": "507f1f77bcf86cd799439011",
"realtimeVoice": "<string>",
"referenceId": "<string>",
"role": "<string>",
"skillReferenceIds": [
"<string>"
],
"toolReferenceIds": [
"<string>"
],
"voiceLargeLanguageModelReferenceId": "<string>",
"voicePromptTemplate": "<string>"
}{
"detail": "request body validation failed",
"errors": [
{
"field": "<string>",
"message": "<string>"
}
],
"instance": "/v1/{resource}",
"status": 400,
"title": "Bad Request",
"traceId": "api--a4d2f126-bec4-4544-a049-7c0cf08524ed",
"type": "about:blank"
}{
"detail": "access denied: insufficient permissions",
"instance": "/v1/{resource}/{id}",
"status": 403,
"title": "Forbidden",
"traceId": "api--a4d2f126-bec4-4544-a049-7c0cf08524ed",
"type": "about:blank"
}{
"detail": "the requested resource does not exist",
"instance": "/v1/{resource}/{id}",
"status": 404,
"title": "Not Found",
"traceId": "api--a4d2f126-bec4-4544-a049-7c0cf08524ed",
"type": "about:blank"
}{
"detail": "a resource with this identifier already exists",
"instance": "/v1/{resource}",
"status": 409,
"title": "Conflict",
"traceId": "api--a4d2f126-bec4-4544-a049-7c0cf08524ed",
"type": "about:blank"
}{
"detail": "internal server error",
"instance": "/v1/{resource}",
"status": 500,
"title": "Internal Server Error",
"traceId": "api--a4d2f126-bec4-4544-a049-7c0cf08524ed",
"type": "about:blank"
}Authorizations
[Production] API key for production authentication
Path Parameters
The unique identifier for the agent.
Body
application/json
Agent update data
AgentType: send "text" or "voice" to change the agent's authored modality. A missing key or an explicit null is "no change"; an empty string is rejected, because an agent cannot be un-typed on purpose.
Available options:
text, voice DisabledToolReferenceIds switches tools off for this agent without changing how they reach it: the runtime withholds them from the LLM, the resource keeps its parameters, and the Tools tab keeps showing the row.
Accepts a reference on EITHER route — a tool attached directly, or one bundled in a skill this agent has hired. A skill's own bundle is never edited by this: it is shared by every agent that hires the skill, so the per-agent switch is recorded here instead.
Replaces the whole set, like ToolReferenceIds does. Absent = no change,
[] = enable everything. A reference the agent cannot reach by either
route is stored as sent and ignored at execution time.
Guardrails: send a non-null object to set or update the block. Same "cannot clear via PATCH" caveat as LLMConfig.
Unlike LLMConfig, replacement is scoped to each sub-object rather than
to the block. To toggle one inner safety field, resend the whole
SafetySettings object: a toggle left out of it is stored off (unlike
create, where it defaults on). Sending only safetySettings leaves
dataPrivacy intact, and sending only dataPrivacy leaves
safetySettings intact. Sending neither ({}) changes nothing.
Show child attributes
Show child attributes
Hooks replaces the whole block. Send null or {"preTurn": []} to
remove it; a missing key leaves it unchanged. Unlike LLMConfig and
Guardrails, this block can be cleared through PATCH.
Image is the agent's avatar: either a URL or a base64 data URI. Optional, like AgentType above: a missing key or an explicit null is "no change". Unlike AgentType, an explicit empty string IS meaningful — it clears the avatar — since an agent without one is a valid, expressible state.
ImageOptimizedFormat reports whether Image is stored in Cognigy's optimized image format. Same "nil = no change" semantics as Image; the two are set together, never independently.
Instructions: same rules as on create. A stored value over the limit that is sent back unchanged is accepted.
Knowledge uses field-level merge (RFC 7396 JSON Merge Patch). Each inner field independently distinguishes absent / explicit null / value. See PatchKnowledgeRequest.
Show child attributes
Show child attributes
LLMConfig: send a non-null object to set or replace the override. A missing key OR an explicit null is treated as "no change" — this endpoint cannot currently clear an existing override. Removing the override requires a separate path (or a future revision that wires PartialUpdateInput.ClearLLMConfig from a raw-body presence check).
Show child attributes
Show child attributes
Name: same rules as on create.
RealtimeVoice: one of the gpt-live-1 voices (alloy, ash, ballad, beacon, bossa, cedar, cinder, coral, delta, echo, gleam, marin, meridian, quartz, ripple, sage, shimmer, stone, tempo, verse, vesper, willow) sets it, null resets to "marin"; missing is no change; others are 400.
Role: absent or explicit null leaves the stored value alone; a string replaces it (send "" to clear). Same rules as on create.
VoiceLargeLanguageModelReferenceId: a UUID sets it, "" clears it; missing or null is no change.
VoicePromptTemplate: a string sets it, null resets to the product default; missing is no change; empty or over 32 KiB is rejected with 400.
Response
OK
AgentType is the modality the agent was authored for. Always present: an agent stored without one — every agent that predates the field — reads back as "text", because it was authored when chat was the only thing an agent could be.
Available options:
text, voice Example:
"voice"
Example:
"507f1f77bcf86cd799439011"
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Example:
"507f1f77bcf86cd799439011"
Show child attributes
Show child attributes
Example:
"507f1f77bcf86cd799439011"
Show child attributes
Show child attributes
Example:
"507f1f77bcf86cd799439011"
Example:
"507f1f77bcf86cd799439011"
RealtimeVoice is the gpt-live-1 voice; absent means the default ("marin").
VoiceLargeLanguageModelReferenceId links a realtime (V2V) LLM for voice sessions. Optional UUID; text turns never use it.
VoicePromptTemplate is the agent's own template; absent means the product default.
⌘I
Update an agent
curl --request PATCH \
--url https://api-trial.cognigy.ai/v1/agents/{id} \
--header 'Content-Type: application/json' \
--header 'X-API-Key: <api-key>' \
--data '
{
"description": "<string>",
"disabledToolReferenceIds": [
"<string>"
],
"guardrails": {
"dataPrivacy": {
"contactProfilesOption": "completeProfile",
"selectedProfileFields": [
"<string>"
]
},
"safetySettings": {
"avoidCopyrightInfringements": true,
"avoidHarmfulContent": true,
"avoidUngroundedContent": true,
"preventJailbreakAndManipulation": true
}
},
"hooks": {},
"image": "<string>",
"imageOptimizedFormat": true,
"instructions": "<string>",
"knowledge": {
"cognigyParameters": {
"present": true,
"value": {
"language": {
"present": true,
"value": "<string>"
},
"stores": {
"present": true,
"value": [
"<string>"
]
},
"topK": {
"present": true,
"value": 123
}
}
},
"context": {
"present": true,
"value": "<string>"
},
"onSearchFailure": {
"present": true,
"value": "<string>"
},
"ragMode": {
"present": true,
"value": "<string>"
},
"ragType": {
"present": true,
"value": "<string>"
}
},
"largeLanguageModelReferenceId": "<string>",
"llmConfig": {
"maxOutputTokens": 123,
"reasoningEffort": "<string>",
"temperature": 123
},
"localeReferenceId": "<string>",
"name": "<string>",
"personaReferenceId": "<string>",
"realtimeVoice": "<string>",
"role": "<string>",
"skillReferenceIds": [
"<string>"
],
"toolReferenceIds": [
"<string>"
],
"voiceLargeLanguageModelReferenceId": "<string>",
"voicePromptTemplate": "<string>"
}
'import requests
url = "https://api-trial.cognigy.ai/v1/agents/{id}"
payload = {
"description": "<string>",
"disabledToolReferenceIds": ["<string>"],
"guardrails": {
"dataPrivacy": {
"contactProfilesOption": "completeProfile",
"selectedProfileFields": ["<string>"]
},
"safetySettings": {
"avoidCopyrightInfringements": True,
"avoidHarmfulContent": True,
"avoidUngroundedContent": True,
"preventJailbreakAndManipulation": True
}
},
"hooks": {},
"image": "<string>",
"imageOptimizedFormat": True,
"instructions": "<string>",
"knowledge": {
"cognigyParameters": {
"present": True,
"value": {
"language": {
"present": True,
"value": "<string>"
},
"stores": {
"present": True,
"value": ["<string>"]
},
"topK": {
"present": True,
"value": 123
}
}
},
"context": {
"present": True,
"value": "<string>"
},
"onSearchFailure": {
"present": True,
"value": "<string>"
},
"ragMode": {
"present": True,
"value": "<string>"
},
"ragType": {
"present": True,
"value": "<string>"
}
},
"largeLanguageModelReferenceId": "<string>",
"llmConfig": {
"maxOutputTokens": 123,
"reasoningEffort": "<string>",
"temperature": 123
},
"localeReferenceId": "<string>",
"name": "<string>",
"personaReferenceId": "<string>",
"realtimeVoice": "<string>",
"role": "<string>",
"skillReferenceIds": ["<string>"],
"toolReferenceIds": ["<string>"],
"voiceLargeLanguageModelReferenceId": "<string>",
"voicePromptTemplate": "<string>"
}
headers = {
"X-API-Key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {'X-API-Key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
description: '<string>',
disabledToolReferenceIds: ['<string>'],
guardrails: {
dataPrivacy: {contactProfilesOption: 'completeProfile', selectedProfileFields: ['<string>']},
safetySettings: {
avoidCopyrightInfringements: true,
avoidHarmfulContent: true,
avoidUngroundedContent: true,
preventJailbreakAndManipulation: true
}
},
hooks: {},
image: '<string>',
imageOptimizedFormat: true,
instructions: '<string>',
knowledge: {
cognigyParameters: {
present: true,
value: {
language: {present: true, value: '<string>'},
stores: {present: true, value: ['<string>']},
topK: {present: true, value: 123}
}
},
context: {present: true, value: '<string>'},
onSearchFailure: {present: true, value: '<string>'},
ragMode: {present: true, value: '<string>'},
ragType: {present: true, value: '<string>'}
},
largeLanguageModelReferenceId: '<string>',
llmConfig: {maxOutputTokens: 123, reasoningEffort: '<string>', temperature: 123},
localeReferenceId: '<string>',
name: '<string>',
personaReferenceId: '<string>',
realtimeVoice: '<string>',
role: '<string>',
skillReferenceIds: ['<string>'],
toolReferenceIds: ['<string>'],
voiceLargeLanguageModelReferenceId: '<string>',
voicePromptTemplate: '<string>'
})
};
fetch('https://api-trial.cognigy.ai/v1/agents/{id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api-trial.cognigy.ai/v1/agents/{id}",
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([
'description' => '<string>',
'disabledToolReferenceIds' => [
'<string>'
],
'guardrails' => [
'dataPrivacy' => [
'contactProfilesOption' => 'completeProfile',
'selectedProfileFields' => [
'<string>'
]
],
'safetySettings' => [
'avoidCopyrightInfringements' => true,
'avoidHarmfulContent' => true,
'avoidUngroundedContent' => true,
'preventJailbreakAndManipulation' => true
]
],
'hooks' => [
],
'image' => '<string>',
'imageOptimizedFormat' => true,
'instructions' => '<string>',
'knowledge' => [
'cognigyParameters' => [
'present' => true,
'value' => [
'language' => [
'present' => true,
'value' => '<string>'
],
'stores' => [
'present' => true,
'value' => [
'<string>'
]
],
'topK' => [
'present' => true,
'value' => 123
]
]
],
'context' => [
'present' => true,
'value' => '<string>'
],
'onSearchFailure' => [
'present' => true,
'value' => '<string>'
],
'ragMode' => [
'present' => true,
'value' => '<string>'
],
'ragType' => [
'present' => true,
'value' => '<string>'
]
],
'largeLanguageModelReferenceId' => '<string>',
'llmConfig' => [
'maxOutputTokens' => 123,
'reasoningEffort' => '<string>',
'temperature' => 123
],
'localeReferenceId' => '<string>',
'name' => '<string>',
'personaReferenceId' => '<string>',
'realtimeVoice' => '<string>',
'role' => '<string>',
'skillReferenceIds' => [
'<string>'
],
'toolReferenceIds' => [
'<string>'
],
'voiceLargeLanguageModelReferenceId' => '<string>',
'voicePromptTemplate' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-API-Key: <api-key>"
],
]);
$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-trial.cognigy.ai/v1/agents/{id}"
payload := strings.NewReader("{\n \"description\": \"<string>\",\n \"disabledToolReferenceIds\": [\n \"<string>\"\n ],\n \"guardrails\": {\n \"dataPrivacy\": {\n \"contactProfilesOption\": \"completeProfile\",\n \"selectedProfileFields\": [\n \"<string>\"\n ]\n },\n \"safetySettings\": {\n \"avoidCopyrightInfringements\": true,\n \"avoidHarmfulContent\": true,\n \"avoidUngroundedContent\": true,\n \"preventJailbreakAndManipulation\": true\n }\n },\n \"hooks\": {},\n \"image\": \"<string>\",\n \"imageOptimizedFormat\": true,\n \"instructions\": \"<string>\",\n \"knowledge\": {\n \"cognigyParameters\": {\n \"present\": true,\n \"value\": {\n \"language\": {\n \"present\": true,\n \"value\": \"<string>\"\n },\n \"stores\": {\n \"present\": true,\n \"value\": [\n \"<string>\"\n ]\n },\n \"topK\": {\n \"present\": true,\n \"value\": 123\n }\n }\n },\n \"context\": {\n \"present\": true,\n \"value\": \"<string>\"\n },\n \"onSearchFailure\": {\n \"present\": true,\n \"value\": \"<string>\"\n },\n \"ragMode\": {\n \"present\": true,\n \"value\": \"<string>\"\n },\n \"ragType\": {\n \"present\": true,\n \"value\": \"<string>\"\n }\n },\n \"largeLanguageModelReferenceId\": \"<string>\",\n \"llmConfig\": {\n \"maxOutputTokens\": 123,\n \"reasoningEffort\": \"<string>\",\n \"temperature\": 123\n },\n \"localeReferenceId\": \"<string>\",\n \"name\": \"<string>\",\n \"personaReferenceId\": \"<string>\",\n \"realtimeVoice\": \"<string>\",\n \"role\": \"<string>\",\n \"skillReferenceIds\": [\n \"<string>\"\n ],\n \"toolReferenceIds\": [\n \"<string>\"\n ],\n \"voiceLargeLanguageModelReferenceId\": \"<string>\",\n \"voicePromptTemplate\": \"<string>\"\n}")
req, _ := http.NewRequest("PATCH", url, payload)
req.Header.Add("X-API-Key", "<api-key>")
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-trial.cognigy.ai/v1/agents/{id}")
.header("X-API-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"description\": \"<string>\",\n \"disabledToolReferenceIds\": [\n \"<string>\"\n ],\n \"guardrails\": {\n \"dataPrivacy\": {\n \"contactProfilesOption\": \"completeProfile\",\n \"selectedProfileFields\": [\n \"<string>\"\n ]\n },\n \"safetySettings\": {\n \"avoidCopyrightInfringements\": true,\n \"avoidHarmfulContent\": true,\n \"avoidUngroundedContent\": true,\n \"preventJailbreakAndManipulation\": true\n }\n },\n \"hooks\": {},\n \"image\": \"<string>\",\n \"imageOptimizedFormat\": true,\n \"instructions\": \"<string>\",\n \"knowledge\": {\n \"cognigyParameters\": {\n \"present\": true,\n \"value\": {\n \"language\": {\n \"present\": true,\n \"value\": \"<string>\"\n },\n \"stores\": {\n \"present\": true,\n \"value\": [\n \"<string>\"\n ]\n },\n \"topK\": {\n \"present\": true,\n \"value\": 123\n }\n }\n },\n \"context\": {\n \"present\": true,\n \"value\": \"<string>\"\n },\n \"onSearchFailure\": {\n \"present\": true,\n \"value\": \"<string>\"\n },\n \"ragMode\": {\n \"present\": true,\n \"value\": \"<string>\"\n },\n \"ragType\": {\n \"present\": true,\n \"value\": \"<string>\"\n }\n },\n \"largeLanguageModelReferenceId\": \"<string>\",\n \"llmConfig\": {\n \"maxOutputTokens\": 123,\n \"reasoningEffort\": \"<string>\",\n \"temperature\": 123\n },\n \"localeReferenceId\": \"<string>\",\n \"name\": \"<string>\",\n \"personaReferenceId\": \"<string>\",\n \"realtimeVoice\": \"<string>\",\n \"role\": \"<string>\",\n \"skillReferenceIds\": [\n \"<string>\"\n ],\n \"toolReferenceIds\": [\n \"<string>\"\n ],\n \"voiceLargeLanguageModelReferenceId\": \"<string>\",\n \"voicePromptTemplate\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api-trial.cognigy.ai/v1/agents/{id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["X-API-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"description\": \"<string>\",\n \"disabledToolReferenceIds\": [\n \"<string>\"\n ],\n \"guardrails\": {\n \"dataPrivacy\": {\n \"contactProfilesOption\": \"completeProfile\",\n \"selectedProfileFields\": [\n \"<string>\"\n ]\n },\n \"safetySettings\": {\n \"avoidCopyrightInfringements\": true,\n \"avoidHarmfulContent\": true,\n \"avoidUngroundedContent\": true,\n \"preventJailbreakAndManipulation\": true\n }\n },\n \"hooks\": {},\n \"image\": \"<string>\",\n \"imageOptimizedFormat\": true,\n \"instructions\": \"<string>\",\n \"knowledge\": {\n \"cognigyParameters\": {\n \"present\": true,\n \"value\": {\n \"language\": {\n \"present\": true,\n \"value\": \"<string>\"\n },\n \"stores\": {\n \"present\": true,\n \"value\": [\n \"<string>\"\n ]\n },\n \"topK\": {\n \"present\": true,\n \"value\": 123\n }\n }\n },\n \"context\": {\n \"present\": true,\n \"value\": \"<string>\"\n },\n \"onSearchFailure\": {\n \"present\": true,\n \"value\": \"<string>\"\n },\n \"ragMode\": {\n \"present\": true,\n \"value\": \"<string>\"\n },\n \"ragType\": {\n \"present\": true,\n \"value\": \"<string>\"\n }\n },\n \"largeLanguageModelReferenceId\": \"<string>\",\n \"llmConfig\": {\n \"maxOutputTokens\": 123,\n \"reasoningEffort\": \"<string>\",\n \"temperature\": 123\n },\n \"localeReferenceId\": \"<string>\",\n \"name\": \"<string>\",\n \"personaReferenceId\": \"<string>\",\n \"realtimeVoice\": \"<string>\",\n \"role\": \"<string>\",\n \"skillReferenceIds\": [\n \"<string>\"\n ],\n \"toolReferenceIds\": [\n \"<string>\"\n ],\n \"voiceLargeLanguageModelReferenceId\": \"<string>\",\n \"voicePromptTemplate\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"agentType": "voice",
"createdAt": 123,
"createdBy": "507f1f77bcf86cd799439011",
"description": "<string>",
"disabledToolReferenceIds": [
"<string>"
],
"guardrails": {
"dataPrivacy": {
"contactProfilesOption": "completeProfile",
"selectedProfileFields": [
"<string>"
]
},
"safetySettings": {
"avoidCopyrightInfringements": true,
"avoidHarmfulContent": true,
"avoidUngroundedContent": true,
"preventJailbreakAndManipulation": true
}
},
"hooks": {
"preTurn": [
{
"handler": {
"flowReferenceId": "<string>",
"kind": "<string>"
}
}
]
},
"id": "507f1f77bcf86cd799439011",
"image": "<string>",
"imageOptimizedFormat": true,
"instructions": "<string>",
"knowledge": {
"cognigyParameters": {
"language": "<string>",
"stores": [
"<string>"
],
"topK": 123
},
"context": "<string>",
"onSearchFailure": "<string>",
"ragMode": "<string>",
"ragType": "<string>"
},
"largeLanguageModelReferenceId": "<string>",
"lastChangedAt": 123,
"lastChangedBy": "507f1f77bcf86cd799439011",
"llmConfig": {
"maxOutputTokens": 123,
"reasoningEffort": "<string>",
"temperature": 123
},
"localeReferenceId": "<string>",
"name": "<string>",
"organisationId": "507f1f77bcf86cd799439011",
"personaReferenceId": "<string>",
"projectId": "507f1f77bcf86cd799439011",
"realtimeVoice": "<string>",
"referenceId": "<string>",
"role": "<string>",
"skillReferenceIds": [
"<string>"
],
"toolReferenceIds": [
"<string>"
],
"voiceLargeLanguageModelReferenceId": "<string>",
"voicePromptTemplate": "<string>"
}{
"detail": "request body validation failed",
"errors": [
{
"field": "<string>",
"message": "<string>"
}
],
"instance": "/v1/{resource}",
"status": 400,
"title": "Bad Request",
"traceId": "api--a4d2f126-bec4-4544-a049-7c0cf08524ed",
"type": "about:blank"
}{
"detail": "access denied: insufficient permissions",
"instance": "/v1/{resource}/{id}",
"status": 403,
"title": "Forbidden",
"traceId": "api--a4d2f126-bec4-4544-a049-7c0cf08524ed",
"type": "about:blank"
}{
"detail": "the requested resource does not exist",
"instance": "/v1/{resource}/{id}",
"status": 404,
"title": "Not Found",
"traceId": "api--a4d2f126-bec4-4544-a049-7c0cf08524ed",
"type": "about:blank"
}{
"detail": "a resource with this identifier already exists",
"instance": "/v1/{resource}",
"status": 409,
"title": "Conflict",
"traceId": "api--a4d2f126-bec4-4544-a049-7c0cf08524ed",
"type": "about:blank"
}{
"detail": "internal server error",
"instance": "/v1/{resource}",
"status": 500,
"title": "Internal Server Error",
"traceId": "api--a4d2f126-bec4-4544-a049-7c0cf08524ed",
"type": "about:blank"
}