Create an agent account
Creates a child agent account under an organization. Use the returned account ID when configuring and provisioning a Computer Agent.
OpenAPI
````yaml post /api/v2/createAccount
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/createAccount:
post:
tags:
- Accounts
summary: Create an agent account
description: >-
Creates a child agent account under an organization. Use the returned
account ID when configuring and provisioning a Computer Agent.
parameters:
- name: targetAccountId
in: query
description: >-
Organization account ID. Required when the API key is not already
scoped to the organization.
required: false
schema:
type: string
requestBody:
required: true
content:
application/json:
schema:
type: object
required:
- accountName
properties:
accountName:
description: Customer-facing name for the new agent account.
type: string
example: Acme Solar Bay Area Support Agent
externalAccountId:
description: Optional identifier from another business system.
type: string
example: AC_12345
externalBillingId:
description: Optional identifier from another billing system.
type: string
example: billing-id-6789
integrations:
description: >-
Optional list of third-party app integrations to set up for
the new agent account.
type: array
items:
type: object
required:
- appId
- appVersion
- appData
properties:
appId:
type: string
example: someappId
appVersion:
type: string
example: v1
appData:
type: object
description: Key/value settings specific to the integration
additionalProperties:
type: string
example:
apiToken: appsApiToken
example:
- appId: some-app-id
appVersion: v1
appData:
apiToken: APIToken
- appId: another-example-app
appVersion: v2
appData:
accountSid: sidxxxxxxx
accountToken: tokenxxxxxxx
apiUrl: https://someurl.example
responses:
'200':
description: Account created
content:
application/json:
schema:
type: object
properties:
success:
type: boolean
example: true
message:
type: string
example: Account created
account:
type: object
description: The newly created agent account without its API key.
security:
- apiKeyAuth: []
components:
securitySchemes:
apiKeyAuth:
type: apiKey
in: query
name: token
description: GetVoiceBot API Token
````
