Update an existing assistant.
curl --request PATCH \
--url https://api.useinvent.com/orgs/{org_id}/assistants/{assistant_id} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "<string>",
"enabled": true,
"avatar_id": "<string>",
"config": {
"instructions": "<string>",
"language": "auto",
"model": "<string>",
"knowledge_scope": "all",
"timezone": "<string>"
},
"boards": [
{
"board_id": "<string>",
"initial_segment_id": "<string>"
}
]
}
'{
"id": "<string>",
"name": "<string>",
"enabled": true,
"deleted": true,
"secret_key": "<string>",
"avatar_url": "<string>",
"config": {
"language": "auto",
"model": "<string>",
"stt": {
"model": "<string>"
},
"tts": {
"model": "<string>",
"voice_id": "<string>"
},
"conversation": {
"thread_mode": "new",
"enable_memories": true,
"enable_transfer_to_human_tool": true,
"welcome_banner": "<string>",
"suggested_messages": [
"<string>"
],
"auto_intro_message": "<string>",
"enable_end_conversation_tool": true,
"enable_block_contact_tool": true,
"enable_auto_resolve": true,
"enable_auto_follow_ups": true,
"enable_auto_csat": true,
"enable_private_chats": true,
"enable_update_contact_tool": true
},
"knowledge_scope": "all",
"timezone": "<string>",
"instructions": "<string>"
},
"integrations": [
{
"id": "<string>",
"enabled": true,
"integration_id": "internal",
"assistant_id": "<string>",
"connection_id": "<string>",
"config": {},
"error": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z"
}
],
"actions": [
{
"id": "<string>",
"enabled": true,
"name": "<string>",
"instructions": "<string>",
"action_id": "<string>",
"assistant_id": "<string>",
"connection_id": "<string>",
"config": {
"input": {},
"definitions": [
{
"path": "<string>",
"definition": {}
}
]
},
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z"
}
],
"boards": [
{
"id": "<string>",
"board_id": "<string>",
"board_name": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"initial_segment": {
"id": "<string>",
"name": "<string>",
"color": "red",
"contacts_count": 123,
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z"
}
}
],
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z"
}Bearer token authentication using your API key
The ID of the org
The ID of the assistant
The assistant information to update.
Schema for updating an existing assistant
The name of the assistant
1 - 1024Whether the assistant is enabled
The ID of the avatar file id
Schema for updating the configuration of an assistant
Show child attributes
Boards to link to this assistant
Show child attributes
The updated assistant.
Schema for an assistant
The name of the assistant
Whether the assistant is enabled
Whether the assistant has been soft-deleted
The secret key to create session hashes
The URL of the avatar photo
Schema for the configuration of an assistant
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Was this page helpful?
curl --request PATCH \
--url https://api.useinvent.com/orgs/{org_id}/assistants/{assistant_id} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "<string>",
"enabled": true,
"avatar_id": "<string>",
"config": {
"instructions": "<string>",
"language": "auto",
"model": "<string>",
"knowledge_scope": "all",
"timezone": "<string>"
},
"boards": [
{
"board_id": "<string>",
"initial_segment_id": "<string>"
}
]
}
'{
"id": "<string>",
"name": "<string>",
"enabled": true,
"deleted": true,
"secret_key": "<string>",
"avatar_url": "<string>",
"config": {
"language": "auto",
"model": "<string>",
"stt": {
"model": "<string>"
},
"tts": {
"model": "<string>",
"voice_id": "<string>"
},
"conversation": {
"thread_mode": "new",
"enable_memories": true,
"enable_transfer_to_human_tool": true,
"welcome_banner": "<string>",
"suggested_messages": [
"<string>"
],
"auto_intro_message": "<string>",
"enable_end_conversation_tool": true,
"enable_block_contact_tool": true,
"enable_auto_resolve": true,
"enable_auto_follow_ups": true,
"enable_auto_csat": true,
"enable_private_chats": true,
"enable_update_contact_tool": true
},
"knowledge_scope": "all",
"timezone": "<string>",
"instructions": "<string>"
},
"integrations": [
{
"id": "<string>",
"enabled": true,
"integration_id": "internal",
"assistant_id": "<string>",
"connection_id": "<string>",
"config": {},
"error": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z"
}
],
"actions": [
{
"id": "<string>",
"enabled": true,
"name": "<string>",
"instructions": "<string>",
"action_id": "<string>",
"assistant_id": "<string>",
"connection_id": "<string>",
"config": {
"input": {},
"definitions": [
{
"path": "<string>",
"definition": {}
}
]
},
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z"
}
],
"boards": [
{
"id": "<string>",
"board_id": "<string>",
"board_name": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"initial_segment": {
"id": "<string>",
"name": "<string>",
"color": "red",
"contacts_count": 123,
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z"
}
}
],
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z"
}