POST
/
functions
Create a function
curl --request POST \
  --url https://api.vogent.ai/api/functions \
  --header 'Content-Type: application/json' \
  --data '{
  "name": "<string>",
  "description": "<string>",
  "type": "transfer",
  "lifecycleMessages": {
    "started": [
      "<string>"
    ]
  },
  "allowedNumbers": [
    {
      "number": "<string>"
    }
  ]
}'
{
  "id": "<string>",
  "name": "<string>",
  "description": "<string>",
  "type": "transfer",
  "lifecycleMessages": {
    "started": [
      "<string>"
    ]
  },
  "allowedNumbers": [
    {
      "number": "<string>"
    }
  ]
}

Body

application/json
name
string
required

The name of the function.

description
string
required

A description of what the function does.

allowedNumbers
object[]
required

The numbers that the agent is allowed to transfer to in e.164 format (+11234567890).

type
enum<string>
Available options:
transfer,
api
lifecycleMessages
object

Messages to display during function execution lifecycle events.

Response

Successful operation

id
string
required
name
string
required

The name of the function.

description
string
required

A description of what the function does.

type
enum<string>
required
Available options:
transfer,
api
allowedNumbers
object[]
required

The numbers that the agent is allowed to transfer to.

lifecycleMessages
object

Messages to display during function execution lifecycle events.