POST
/
agents
curl --request POST \
  --url https://api.vogent.ai/api/agents \
  --header 'Content-Type: application/json' \
  --data '{
  "name": "<string>",
  "defaultVoiceId": "<string>",
  "defaultVersionedPrompt": {
    "aiModelId": "<string>",
    "agentType": "STANDARD",
    "prompt": "<string>",
    "flowDefinition": {
      "nodes": [
        {
          "id": "<string>",
          "name": "<string>",
          "type": "<string>",
          "transitionRules": [
            {
              "conditionType": "always",
              "field": "<string>",
              "value": "<string>",
              "values": [
                "<string>"
              ],
              "transitionNodeId": "<string>"
            }
          ],
          "nodeData": {}
        }
      ]
    },
    "name": "<string>",
    "modelOptionValues": [
      {
        "optionId": "<string>",
        "value": "<string>"
      }
    ]
  },
  "inboundWebhookResponse": true,
  "inboundWebhookUrl": "<string>",
  "openingLine": {
    "lineType": "INBOUND_ONLY",
    "content": "<string>"
  },
  "voiceVolumeLevel": -100,
  "backgroundNoiseType": "noise",
  "linkedFunctionDefinitionIds": [
    "<string>"
  ],
  "metadata": {},
  "transcriberParams": {
    "keywords": [
      "<string>"
    ]
  },
  "utteranceDetectorConfig": {
    "sensitivity": "ULTRA_FAST"
  }
}'
{
  "id": "<string>",
  "name": "<string>",
  "transcriberParams": {
    "keywords": [
      "<string>"
    ]
  },
  "metadata": {},
  "utteranceDetectorConfig": {
    "sensitivity": "ULTRA_FAST"
  }
}

Body

application/json
Create a new agent
​
name
string
required

The name of the agent.

​
defaultVoiceId
string
required

The ID of the voice to use.

​
defaultVersionedPrompt
object
required

The default versioned prompt to use for this agent.

​
inboundWebhookResponse
boolean
​
inboundWebhookUrl
string
​
openingLine
object | null

Details about the Agent's opening line. If unspecified, or null no opening line will be created.

​
voiceVolumeLevel
integer | null
default:-100

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

​
backgroundNoiseType
enum<string>
default:noise

The background audio that's used by the agent.

Available options:
noise,
office
​
linkedFunctionDefinitionIds
string[]

The function definitions that should be available to this agent

​
metadata
object
​
transcriberParams
object
​
utteranceDetectorConfig
object

Response

200
application/json
Successful operation
​
id
string
required
​
name
string
required
​
transcriberParams
object
​
metadata
object
​
utteranceDetectorConfig
object