List agent functions
Lists the functions the selected account can add to an agent. Check allowed and missingRequirement before changing the staging configuration.
OpenAPI
````yaml get /api/v2/agent/functions
openapi: 3.0.0
info:
version: 2.0.0
title: GetVoiceBot API
description: GetVoiceBot API Documentation
servers:
- url: https://api.getvoicebot.com
description: GetVoiceBot Production
variables:
baseUrl:
default: api.getvoicebot.com
description: Production API Root
security: []
tags:
- name: Agents
- name: Inbound Email
description: Control which senders may create inbound email work for an Agent.
- name: Features
description: Inspect capabilities available within an account hierarchy.
- name: Conversation Logs
description: Query conversation activity and calculate account-level metrics.
- name: Computer Agents
description: Set up, configure, inspect, and manage GetVoiceBot Computer Agents.
- name: Computer Agent Sessions
description: View and reset Computer Agent sessions.
- name: Accounts
- name: Agent Templates
description: Create, manage, and apply reusable Agent configurations.
paths:
/api/v2/agent/functions:
get:
tags:
- Agents
summary: List agent functions
description: >-
Lists the functions the selected account can add to an agent. Check
allowed and missingRequirement before changing the staging
configuration.
parameters:
- name: targetAccountId
in: query
description: Account whose function access should be evaluated.
required: true
schema:
type: integer
responses:
'200':
description: Successful response
content:
application/json:
schema:
type: object
properties:
success:
type: boolean
example: true
message:
type: string
example: Success
functions:
type: array
items:
type: object
properties:
name:
type: string
description: Stable function identifier stored in actions[].name.
example: callTransfer
label:
type: string
description: Display name.
example: Call Transfer
details:
type: string
description: What the function lets the agent do.
placeholder:
type: string
description: Guidance for authored function instructions.
limit:
type: integer
nullable: true
description: >-
Maximum number of this function that may be
configured.
hasSettings:
type: boolean
description: Whether related agent settings are available.
requirePaid:
type: boolean
description: Whether this function requires a paid account.
requireComputer:
type: boolean
description: >-
Whether this function delegates to a configured
Computer Agent.
allowed:
type: boolean
description: >-
Whether the selected account can currently use the
function.
reason:
type: string
nullable: true
description: Why the function is unavailable.
missingRequirement:
type: string
nullable: true
description: Setup needed before the function can be used.
docsPage:
type: string
nullable: true
description: Function guide URL.
security:
- apiKeyAuth: []
components:
securitySchemes:
apiKeyAuth:
type: apiKey
in: query
name: token
description: GetVoiceBot API Token
````
