Update agent (partial)
curl --request PATCH \
--url https://api.omnia-voice.com/api/v1/agents/{id} \
--header 'Content-Type: application/json' \
--header 'X-API-Key: <api-key>' \
--data '
{
"name": "<string>",
"description": "<string>",
"config": {
"languageId": "<string>",
"voiceId": "<string>",
"basePrompt": "<string>",
"greeting": "<string>",
"context": "<string>",
"questions": "<string>",
"customInstructions": "<string>",
"recordingEnabled": true,
"temperature": 0,
"maxDuration": 3000,
"firstSpeaker": "agent",
"interruptible": false,
"inactivityTimeout": 155,
"model": "llama",
"language": {
"id": "<string>",
"code": "<string>",
"name": "<string>",
"isActive": true
},
"voice": {
"id": "<string>",
"name": "<string>",
"description": "<string>",
"previewUrl": "<string>",
"languageCode": "<string>",
"gender": "<string>",
"isActive": true,
"language": {
"code": "<string>",
"name": "<string>"
}
}
},
"changeNote": "<string>"
}
'const options = {
method: 'PATCH',
headers: {'X-API-Key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: '<string>',
description: '<string>',
config: {
languageId: '<string>',
voiceId: '<string>',
basePrompt: '<string>',
greeting: '<string>',
context: '<string>',
questions: '<string>',
customInstructions: '<string>',
recordingEnabled: true,
temperature: 0,
maxDuration: 3000,
firstSpeaker: 'agent',
interruptible: false,
inactivityTimeout: 155,
model: 'llama',
language: {id: '<string>', code: '<string>', name: '<string>', isActive: true},
voice: {
id: '<string>',
name: '<string>',
description: '<string>',
previewUrl: '<string>',
languageCode: '<string>',
gender: '<string>',
isActive: true,
language: {code: '<string>', name: '<string>'}
}
},
changeNote: '<string>'
})
};
fetch('https://api.omnia-voice.com/api/v1/agents/{id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api.omnia-voice.com/api/v1/agents/{id}"
payload = {
"name": "<string>",
"description": "<string>",
"config": {
"languageId": "<string>",
"voiceId": "<string>",
"basePrompt": "<string>",
"greeting": "<string>",
"context": "<string>",
"questions": "<string>",
"customInstructions": "<string>",
"recordingEnabled": True,
"temperature": 0,
"maxDuration": 3000,
"firstSpeaker": "agent",
"interruptible": False,
"inactivityTimeout": 155,
"model": "llama",
"language": {
"id": "<string>",
"code": "<string>",
"name": "<string>",
"isActive": True
},
"voice": {
"id": "<string>",
"name": "<string>",
"description": "<string>",
"previewUrl": "<string>",
"languageCode": "<string>",
"gender": "<string>",
"isActive": True,
"language": {
"code": "<string>",
"name": "<string>"
}
}
},
"changeNote": "<string>"
}
headers = {
"X-API-Key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text){
"id": "<string>",
"name": "<string>",
"description": "<string>",
"status": "ACTIVE",
"type": "standard",
"workspaceId": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"standardConfig": {
"languageId": "<string>",
"voiceId": "<string>",
"basePrompt": "<string>",
"greeting": "<string>",
"context": "<string>",
"questions": "<string>",
"customInstructions": "<string>",
"recordingEnabled": true,
"temperature": 0,
"maxDuration": 3000,
"firstSpeaker": "agent",
"interruptible": false,
"inactivityTimeout": 155,
"inactivityAction": "hang_up",
"model": "llama",
"language": {
"id": "<string>",
"code": "<string>",
"name": "<string>",
"isActive": true
},
"voice": {
"id": "<string>",
"name": "<string>",
"description": "<string>",
"previewUrl": "<string>",
"languageCode": "<string>",
"gender": "<string>",
"isActive": true,
"language": {
"code": "<string>",
"name": "<string>"
}
}
},
"actions": [
{}
],
"knowledgeBases": [
{}
]
}{
"error": "Invalid request body",
"details": {
"formErrors": [
"<string>"
],
"fieldErrors": {
"baseUrlPattern": [
"Internal URLs are not allowed"
]
}
}
}{
"error": "Invalid request body",
"details": {
"formErrors": [
"<string>"
],
"fieldErrors": {
"baseUrlPattern": [
"Internal URLs are not allowed"
]
}
}
}Agents
Update agent (partial)
Update an existing agent
PATCH
/
agents
/
{id}
Update agent (partial)
curl --request PATCH \
--url https://api.omnia-voice.com/api/v1/agents/{id} \
--header 'Content-Type: application/json' \
--header 'X-API-Key: <api-key>' \
--data '
{
"name": "<string>",
"description": "<string>",
"config": {
"languageId": "<string>",
"voiceId": "<string>",
"basePrompt": "<string>",
"greeting": "<string>",
"context": "<string>",
"questions": "<string>",
"customInstructions": "<string>",
"recordingEnabled": true,
"temperature": 0,
"maxDuration": 3000,
"firstSpeaker": "agent",
"interruptible": false,
"inactivityTimeout": 155,
"model": "llama",
"language": {
"id": "<string>",
"code": "<string>",
"name": "<string>",
"isActive": true
},
"voice": {
"id": "<string>",
"name": "<string>",
"description": "<string>",
"previewUrl": "<string>",
"languageCode": "<string>",
"gender": "<string>",
"isActive": true,
"language": {
"code": "<string>",
"name": "<string>"
}
}
},
"changeNote": "<string>"
}
'const options = {
method: 'PATCH',
headers: {'X-API-Key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: '<string>',
description: '<string>',
config: {
languageId: '<string>',
voiceId: '<string>',
basePrompt: '<string>',
greeting: '<string>',
context: '<string>',
questions: '<string>',
customInstructions: '<string>',
recordingEnabled: true,
temperature: 0,
maxDuration: 3000,
firstSpeaker: 'agent',
interruptible: false,
inactivityTimeout: 155,
model: 'llama',
language: {id: '<string>', code: '<string>', name: '<string>', isActive: true},
voice: {
id: '<string>',
name: '<string>',
description: '<string>',
previewUrl: '<string>',
languageCode: '<string>',
gender: '<string>',
isActive: true,
language: {code: '<string>', name: '<string>'}
}
},
changeNote: '<string>'
})
};
fetch('https://api.omnia-voice.com/api/v1/agents/{id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api.omnia-voice.com/api/v1/agents/{id}"
payload = {
"name": "<string>",
"description": "<string>",
"config": {
"languageId": "<string>",
"voiceId": "<string>",
"basePrompt": "<string>",
"greeting": "<string>",
"context": "<string>",
"questions": "<string>",
"customInstructions": "<string>",
"recordingEnabled": True,
"temperature": 0,
"maxDuration": 3000,
"firstSpeaker": "agent",
"interruptible": False,
"inactivityTimeout": 155,
"model": "llama",
"language": {
"id": "<string>",
"code": "<string>",
"name": "<string>",
"isActive": True
},
"voice": {
"id": "<string>",
"name": "<string>",
"description": "<string>",
"previewUrl": "<string>",
"languageCode": "<string>",
"gender": "<string>",
"isActive": True,
"language": {
"code": "<string>",
"name": "<string>"
}
}
},
"changeNote": "<string>"
}
headers = {
"X-API-Key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text){
"id": "<string>",
"name": "<string>",
"description": "<string>",
"status": "ACTIVE",
"type": "standard",
"workspaceId": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"standardConfig": {
"languageId": "<string>",
"voiceId": "<string>",
"basePrompt": "<string>",
"greeting": "<string>",
"context": "<string>",
"questions": "<string>",
"customInstructions": "<string>",
"recordingEnabled": true,
"temperature": 0,
"maxDuration": 3000,
"firstSpeaker": "agent",
"interruptible": false,
"inactivityTimeout": 155,
"inactivityAction": "hang_up",
"model": "llama",
"language": {
"id": "<string>",
"code": "<string>",
"name": "<string>",
"isActive": true
},
"voice": {
"id": "<string>",
"name": "<string>",
"description": "<string>",
"previewUrl": "<string>",
"languageCode": "<string>",
"gender": "<string>",
"isActive": true,
"language": {
"code": "<string>",
"name": "<string>"
}
}
},
"actions": [
{}
],
"knowledgeBases": [
{}
]
}{
"error": "Invalid request body",
"details": {
"formErrors": [
"<string>"
],
"fieldErrors": {
"baseUrlPattern": [
"Internal URLs are not allowed"
]
}
}
}{
"error": "Invalid request body",
"details": {
"formErrors": [
"<string>"
],
"fieldErrors": {
"baseUrlPattern": [
"Internal URLs are not allowed"
]
}
}
}Body
application/json
Partial update — send only what you are changing. Omitted fields keep
their current values. Use PATCH; there is no PUT handler.
Response
Agent updated successfully
An agent as returned by the API.
Note the asymmetry with the create/update payloads: you write
configuration under config, and read it back under
standardConfig (or customProvider). The type field tells you which
one is present.