AI Agent

Create an agent

post/companies/{company}/agents

Path parameters

companyinteger required

Request body

business_unit_idinteger nullable

agentNamestring nullable

sourceAgentIdinteger nullable

Build the new agent from an existing one instead of the website: prompt, knowledge base, calendar, hours, tools, fallbacks, pronunciation aliases and post-call email settings are copied over and no crawl runs. Makes voiceId optional.

skillTemplatesstring[] nullable

Skill template keys the new agent should have. Only honored together with sourceAgentId; matching skills are copied from it, the rest are created from their template.

firstMessagestring nullable

descriptionstring nullable

companyNamestring nullable

websitestring nullable

googlePlaceIdstring nullable

reviewBusinessInfoboolean nullable

Hold detected business info (address, industry, working hours) for user review instead of auto-applying it. The review is read and applied via the call-training analysis endpoints. Default false.

voiceIdstring

voiceLanguagestring nullable

scheduleIdinteger nullable

enabledboolean nullable

Whether the agent answers calls on the numbers and call flows assigned to it. Defaults to true when omitted.

voicemailFallbackEnabledboolean nullable

messageCaptureEnabledboolean nullable

callbackCaptureEnabledboolean nullable

transferSummaryEnabledboolean nullable

expressiveVoiceEnabledboolean nullable

escalationPolicystring nullable

dynamicVariablesobject nullable

Response

Agent creation happens asynchronously. This response contains batch information that can be used to check progress.

You can listen to the agent-create-completed event on the companies@{company} channel. Progress updates are broadcast as agent-create-progress on the same channel. The event payload will be an AgentCreateResult.

idstring uuid

namestring

totalJobsinteger

pendingJobsinteger

failedJobsinteger

progressinteger

createdAtstring

cancelledAtstring

finishedAtstring

Example response

{
  "createdAt": "2023-01-01 01:01:01",
  "cancelledAt": "2023-01-01 01:01:01",
  "finishedAt": "2023-01-01 01:01:01"
}

Changes

No recorded changes to this endpoint across all 1 revision of this API.