Voicebot

Beta Release Notice: This API documentation is currently in beta and is primarily intended for developer preview. While the core functionality is stable, specific aspects including error codes, response formats, and endpoint behaviors may be refined or modified in future releases. We encourage developers to provide feedback, but recommend not using this version in production environments without understanding that breaking changes may occur. We will strive to communicate significant changes through our developer channels.

PreviousSearch NextMy Profile

Last updated 1 day ago

List voicebots

get

/voicebots

Authorizations

Query parameters

include_sharedboolean

Include shared voicebots in the results

verboseboolean

Include full voicebot objects in the response

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://api.vectorshift.ai/v1/voicebots' \
  --header 'Authorization: Bearer JWT'

200

401

500

{
  "status": "success",
  "object_ids": [
    "text"
  ],
  "objects": [
    {
      "ANY_ADDITIONAL_PROPERTY": "anything"
    }
  ]
}

Successful response. When verbose=true, full voicebot objects are included in the response

Create a new voicebot

post

/voicebot

Authorizations

Body

namestringrequired

descriptionstringrequired

deployment_optionsobjectrequired

access_configobjectrequired

inputstringrequired

outputstringrequired

deployedbooleanrequired

rbacbooleanrequired

pipelineobjectrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url 'https://api.vectorshift.ai/v1/voicebot' \
  --header 'Authorization: Bearer JWT' \
  --header 'Content-Type: application/json' \
  --data '{"name":"text","description":"text","deployment_options":{"ANY_ADDITIONAL_PROPERTY":"anything"},"access_config":{"ANY_ADDITIONAL_PROPERTY":"anything"},"input":"text","output":"text","deployed":true,"rbac":true,"pipeline":{"id":"text","version":"latest"}}'

200

400

401

500

{
  "id": "text",
  "status": "success"
}

Successful response

Run a voicebot

post

/voicebot/{id}/run

Authorizations

Path parameters

idstringrequired

Voicebot ID

Body

audioobjectrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url 'https://api.vectorshift.ai/v1/voicebot/{id}/run' \
  --header 'Authorization: Bearer JWT' \
  --header 'Content-Type: application/json' \
  --data '{"audio":{"type":"text"}}'

200

400

401

500

{
  "result": {
    "type": "text",
    "id": "text",
    "raw_bytes": "text"
  },
  "status": "success"
}

Successful response

Delete a voicebot

delete

/voicebot/{id}

Authorizations

Path parameters

idstringrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request DELETE \
  --url 'https://api.vectorshift.ai/v1/voicebot/{id}' \
  --header 'Authorization: Bearer JWT'

200

401

500

{
  "status": "success"
}

Successful response

Fetch a voicebot

get

/voicebot/

Authorizations

Query parameters

idstring

Voicebot ID. Either id or name is required

namestring

Name of the voicebot. Required if id is not provided

usernamestring

Optional username for name-based search

org_namestring

Optional organization name for name-based search

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://api.vectorshift.ai/v1/voicebot/' \
  --header 'Authorization: Bearer JWT'

200

400

401

404

500

{
  "object": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "status": "success"
}

Successful response