Skip to main content
GET
/
functions
/
{id}
Get function
curl --request GET \
  --url https://api.vogent.ai/api/functions/{id} \
  --header 'Authorization: Bearer <token>'
{
  "id": "<string>",
  "name": "<string>",
  "description": "<string>",
  "type": "transfer",
  "allowedNumbers": [
    {
      "number": "<string>"
    }
  ],
  "allowAnyNumber": true,
  "lifecycleMessages": {
    "started": [
      "<string>"
    ]
  }
}

Authorizations

​
Authorization
string
header
required

In the form Bearer <api_key_here>. You can find your api key in your dashboard.

Path Parameters

​
id
string
required

ID of the function.

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.

​
allowAnyNumber
boolean
required

Instead of using a fixed list of allowed numbers, allow the agent to transfer to any number (not recommended).

​
lifecycleMessages
object

Messages to display during function execution lifecycle events.