Create Agent

Creates a new agent.

post/agents

Request

  • Base URL
    https://api.vogent.ai/api
  • Auth
    HTTP bearer

Request body

namestring required

The name of the agent.

defaultVoiceIdstring required

The ID of the voice to use.

inboundWebhookResponseboolean
inboundWebhookUrlstring
maxDurationSecondsinteger

The maximum duration of the call in seconds.

timeoutMessagestring nullable

An optional message to play via TTS before hanging up when the call reaches its max duration timeout.

voiceVolumeLevelinteger nullable

A value, generally between -300 and 300, indicating the volume level to use for the voice. The default is -100.

backgroundNoiseType'noise' | 'office' | 'silence'

The background audio that's used by the agent.

linkedFunctionDefinitionIdsstring[]

The function definitions that should be available to this agent (deprecated, use linkedFunctionDefinitionInputs instead)

metadataobject
languagestring

The language to use for the agent.

secondaryLanguagesstring[]

Additional languages the agent can switch to during a call.

enableChangeLanguageboolean

Whether the agent can use the change_language tool to switch languages during a call.

fillEmptyStringVariablesboolean nullable

If true, variables that are not specified will be filled with empty strings instead of being left as template placeholders.

Response

Successful operation

idstring required
namestring required
metadataobject
languagestring required

The language to use for the agent.

maxDurationSecondsinteger

The maximum duration of the call in seconds.

timeoutMessagestring nullable

An optional message to play via TTS before hanging up when the call reaches its max duration timeout.

defaultVoiceIdstring

The default voice ID to use for the agent.

defaultVersionedPromptIdstring

The default versioned prompt ID to use for the agent.

defaultExtractorIdstring nullable

The default extractor ID to use for the agent.

fillEmptyStringVariablesboolean

If true, variables that are not specified will be filled with empty strings instead of being left as template placeholders.

Changes

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