Agent Builder
Create an agent
Creates an assistant with the internal defaults for theme, channels, settings, flow, and billing checks. Requires a USER API key.
post/public/v1/agents
Request body
Example request
{
"name": "Support Agent"
}Response
Created agent
Example response
{
"id": "550e8400-e29b-41d4-a716-446655440000",
"name": "Support Bot",
"description": "Main customer support agent",
"status": "ACTIVE",
"createdAt": "2024-01-01T12:00:00Z",
"updatedAt": "2024-01-01T12:00:00Z",
"ownerId": 1,
"accountId": 1,
"theme": {
"id": 1,
"assistantId": "example",
"avatar": "example",
"bubbleImage": "example",
"title": "example",
"initialMessage": "example",
"placeholder": "example",
"bubbleColor": "example",
"userMessageColor": "example",
"agentMessageColor": "example",
"bubbleAlignment": "RIGHT",
"progressIndicator": "STATIC",
"verticalPositionInPixels": 1,
"updatedAt": "example"
},
"agentSetting": {
"id": 1,
"aiModelId": 1,
"aiModel": {
"id": 1,
"name": "example",
"description": "example",
"creditsPerMessage": 1,
"order": 1,
"analyticsColor": "example",
"externalId": "example",
"aiVendor": "example",
"type": "TEXT"
},
"model": "example",
"aiType": "ASSISTANT",
"temperature": 1,
"instructions": "example",
"agentRole": "NONE",
"toneOfVoice": "NONE",
"answerLength": "NONE",
"maxIterations": 1,
"agentType": "BASIC",
"customTools": [
{
"id": 1,
"name": "example",
"description": "example",
"status": "example",
"type": "example"
}
],
"selectedRecordTypes": [
{
"recordTypeId": 1
}
],
"agentConnectedAccounts": [
{
"connectedAccountId": 1,
"selectedToolSlugs": [
"example"
],
"connectedAccount": {
"id": 1,
"toolkit": "example",
"alias": "example",
"connectedEmail": "example"
}
}
],
"agentPlaybooks": [
{
"playbookId": 1,
"assignedAt": "example",
"playbook": {
"id": 1,
"name": "example",
"description": "example"
}
}
]
},
"channel": {
"id": 1,
"channelLiveChat": {
"splitCharacterLimit": 1,
"closeAfter": 1,
"timeUnit": "MINUTES",
"conversationClose": "NEVER",
"feedbackVisibility": "ON_HOVER",
"feedbackText": "example",
"openFeedbackText": "example",
"feedbackReasons": [
{
"id": 1,
"reason": "example",
"order": 1
}
],
"idleSettings": {
"id": 1,
"after": 1,
"timeUnit": "MINUTES",
"resetsLimit": 1
},
"id": 1
},
"channelWhatsapp": {
"splitCharacterLimit": 1,
"closeAfter": 1,
"timeUnit": "MINUTES",
"conversationClose": "NEVER",
"idleSettings": {
"id": 1,
"after": 1,
"timeUnit": "MINUTES",
"resetsLimit": 1
},
"conversationInterruptTimeUnit": "MINUTES",
"closeMessageType": "STATIC",
"closeMessage": "example",
"closeInstruction": "example",
"id": 1
},
"channelInstagram": {
"splitCharacterLimit": 1,
"closeAfter": 1,
"timeUnit": "MINUTES",
"conversationClose": "NEVER",
"idleSettings": {
"id": 1,
"after": 1,
"timeUnit": "MINUTES",
"resetsLimit": 1
},
"conversationInterruptTimeUnit": "MINUTES",
"closeMessageType": "STATIC",
"closeMessage": "example",
"closeInstruction": "example",
"id": 1
},
"channelMessenger": {
"splitCharacterLimit": 1,
"closeAfter": 1,
"timeUnit": "MINUTES",
"conversationClose": "NEVER",
"idleSettings": {
"id": 1,
"after": 1,
"timeUnit": "MINUTES",
"resetsLimit": 1
},
"conversationInterruptTimeUnit": "MINUTES",
"closeMessageType": "STATIC",
"closeMessage": "example",
"closeInstruction": "example",
"id": 1
}
}
}