AI service API v1.0.0

AI service for various providers, fastify on node-js.

info

You are viewing REST API documentation. This documentation is auto-generated from a swagger specification which itself is generated from annotations in the source code of the project. It is possible that this documentation includes bugs and that code samples are incomplete or wrong.

Authentication

• HTTP Authentication, scheme: bearer

transcriptions

Manage transcription jobs

Create a new transcription

POST /api/ai/{appId}/conversations/{conversationId}/transcriptions HTTP/1.1
Content-Type: application/json
Accept: application/json

Creates a new transcription for a given conversation

Request body

{
  "language": "string",
  "model": "string"
}

Parameters

Parameter	In	Type	Required	Description
appId	path	string	true	none
conversationId	path	string	true	none
body	body	object	true	none
» language	body	string	true	none
» model	body	string	false	Model ID of any provider

Responses

Overview

Status	Meaning	Description	Schema
200	OK	Successful response	Inline
400	Bad Request	Bad Request	Inline
401	Unauthorized	Unauthorized	Inline
403	Forbidden	Forbidden	Inline
404	Not Found	Not Found	Inline

Response Schema

Status Code 200

Successful response

Name	Type	Required	Restrictions	Description
» conversationId	string	false	none	none
» id	string	false	none	none

Status Code 400

Bad Request

Name	Type	Required	Restrictions	Description
» statusCode	number	false	none	none
» error	string	false	none	none
» message	string	false	none	none

Status Code 401

Unauthorized

Name	Type	Required	Restrictions	Description
» statusCode	number	false	none	none
» error	string	false	none	none
» message	string	false	none	none

Status Code 403

Forbidden

Name	Type	Required	Restrictions	Description
» statusCode	number	false	none	none
» error	string	false	none	none
» message	string	false	none	none

Status Code 404

Not Found

Name	Type	Required	Restrictions	Description
» statusCode	number	false	none	none
» error	string	false	none	none
» message	string	false	none	none

Examples

200 Response

{
  "conversationId": "string",
  "id": "string"
}

caution

To perform this operation, you must be authenticated by means of one of the following methods: bearerAuth

Code samples

Shell

curl -X POST /api/ai/{appId}/conversations/{conversationId}/transcriptions \
  -H 'Content-Type: application/json' \  -H 'Accept: application/json' \  -H 'Authorization: Bearer {access-token}'

Go

package main

import (
    "bytes"
    "net/http"
)

func main() {
    headers := map[string][]string{ 
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
        "Authorization": []string{"Bearer {access-token}"},
    }

    var body []byte
    // body = ...

    req, err := http.NewRequest("POST", "/api/ai/{appId}/conversations/{conversationId}/transcriptions", bytes.NewBuffer(body))
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

Node

const fetch = require('node-fetch');
const input = '{
  "language": "string",
  "model": "string"
}';
const headers = {
  'Content-Type': 'application/json',  'Accept': 'application/json',  'Authorization': 'Bearer {access-token}'
}

fetch('/api/ai/{appId}/conversations/{conversationId}/transcriptions', {
  method: 'POST',
  body: input,
  headers
})
.then(r => r.json())
.then((body) => {
    console.log(body)
})

Java

// This sample needs improvement.
URL obj = new URL("/api/ai/{appId}/conversations/{conversationId}/transcriptions");

HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");

int responseCode = con.getResponseCode();

BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream())
);

String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();

System.out.println(response.toString());

Python

import requests

headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json',
  'Authorization': 'Bearer {access-token}'
}

r = requests.post(
  '/api/ai/{appId}/conversations/{conversationId}/transcriptions',
  params={},
  headers = headers)

print r.json()

Ruby

require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.post '/api/ai/{appId}/conversations/{conversationId}/transcriptions',
  params: {}, headers: headers

p JSON.parse(result)

Get all transriptions

GET /api/ai/{appId}/conversations/{conversationId}/transcriptions HTTP/1.1
Accept: application/json

Get all transcriptions of a conversation

Parameters

Parameter	In	Type	Required	Description
appId	path	string	true	ID of the app
conversationId	path	string	true	ID of the conversation

Responses

Overview

Status	Meaning	Description	Schema
200	OK	Success	Inline
404	Not Found	Not found	Inline

Response Schema

Status Code 200

Success

Name	Type	Required	Restrictions	Description
» transcriptions	[object]	false	none	none
»» id	string	false	none	none
»» conversationId	string	false	none	none
»» state	string	false	none	none
»» language	string	false	none	none
»» createdBy	string	false	none	none
»» createdAt	string(date-time)	false	none	none

Enumerated Values

Property	Value
state	SUBMITTED
state	RESUBMIT
state	PROCESSING
state	COMPLETED
state	FAILED

Status Code 404

Not found

Name	Type	Required	Restrictions	Description
» statusCode	number	false	none	none
» error	string	false	none	none
» message	string	false	none	none

Examples

200 Response

{
  "transcriptions": [
    {
      "id": "string",
      "conversationId": "string",
      "state": "SUBMITTED",
      "language": "string",
      "createdBy": "string",
      "createdAt": "2019-08-24T14:15:22Z"
    }
  ]
}

caution

To perform this operation, you must be authenticated by means of one of the following methods: bearerAuth

Code samples

Shell

curl -X GET /api/ai/{appId}/conversations/{conversationId}/transcriptions \
  -H 'Accept: application/json' \  -H 'Authorization: Bearer {access-token}'

Go

package main

import (
    "bytes"
    "net/http"
)

func main() {
    headers := map[string][]string{ 
        "Accept": []string{"application/json"},
        "Authorization": []string{"Bearer {access-token}"},
    }

    var body []byte
    // body = ...

    req, err := http.NewRequest("GET", "/api/ai/{appId}/conversations/{conversationId}/transcriptions", bytes.NewBuffer(body))
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

Node

const fetch = require('node-fetch');

const headers = {
  'Accept': 'application/json',  'Authorization': 'Bearer {access-token}'
}

fetch('/api/ai/{appId}/conversations/{conversationId}/transcriptions', {
  method: 'GET',
  headers
})
.then(r => r.json())
.then((body) => {
    console.log(body)
})

Java

// This sample needs improvement.
URL obj = new URL("/api/ai/{appId}/conversations/{conversationId}/transcriptions");

HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");

int responseCode = con.getResponseCode();

BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream())
);

String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();

System.out.println(response.toString());

Python

import requests

headers = {
  'Accept': 'application/json',
  'Authorization': 'Bearer {access-token}'
}

r = requests.get(
  '/api/ai/{appId}/conversations/{conversationId}/transcriptions',
  params={},
  headers = headers)

print r.json()

Ruby

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.get '/api/ai/{appId}/conversations/{conversationId}/transcriptions',
  params: {}, headers: headers

p JSON.parse(result)

Get a transription's status

GET /api/ai/{appId}/conversations/{conversationId}/transcriptions/{id} HTTP/1.1
Accept: application/json

Parameters

Parameter	In	Type	Required	Description
appId	path	string	true	Application ID
conversationId	path	string	true	ID of the conversation
id	path	string	true	ID of the transcription

Responses

Overview

Status	Meaning	Description	Schema
200	OK	Success	Inline
404	Not Found	Not found	Inline

Response Schema

Status Code 200

Success

Name	Type	Required	Restrictions	Description
» transcription	object	false	none	none
»» id	string	false	none	none
»» conversationId	string	false	none	none
»» state	string	false	none	none
»» language	string	false	none	none
»» createdBy	string	false	none	none
»» createdAt	string(date-time)	false	none	none

Enumerated Values

Property	Value
state	SUBMITTED
state	RESUBMIT
state	PROCESSING
state	COMPLETED
state	FAILED

Status Code 404

Not found

Name	Type	Required	Restrictions	Description
» statusCode	number	false	none	none
» error	string	false	none	none
» message	string	false	none	none

Examples

200 Response

{
  "transcription": {
    "id": "string",
    "conversationId": "string",
    "state": "SUBMITTED",
    "language": "string",
    "createdBy": "string",
    "createdAt": "2019-08-24T14:15:22Z"
  }
}

caution

To perform this operation, you must be authenticated by means of one of the following methods: bearerAuth

Code samples

Shell

curl -X GET /api/ai/{appId}/conversations/{conversationId}/transcriptions/{id} \
  -H 'Accept: application/json' \  -H 'Authorization: Bearer {access-token}'

Go

package main

import (
    "bytes"
    "net/http"
)

func main() {
    headers := map[string][]string{ 
        "Accept": []string{"application/json"},
        "Authorization": []string{"Bearer {access-token}"},
    }

    var body []byte
    // body = ...

    req, err := http.NewRequest("GET", "/api/ai/{appId}/conversations/{conversationId}/transcriptions/{id}", bytes.NewBuffer(body))
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

Node

const fetch = require('node-fetch');

const headers = {
  'Accept': 'application/json',  'Authorization': 'Bearer {access-token}'
}

fetch('/api/ai/{appId}/conversations/{conversationId}/transcriptions/{id}', {
  method: 'GET',
  headers
})
.then(r => r.json())
.then((body) => {
    console.log(body)
})

Java

// This sample needs improvement.
URL obj = new URL("/api/ai/{appId}/conversations/{conversationId}/transcriptions/{id}");

HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");

int responseCode = con.getResponseCode();

BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream())
);

String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();

System.out.println(response.toString());

Python

import requests

headers = {
  'Accept': 'application/json',
  'Authorization': 'Bearer {access-token}'
}

r = requests.get(
  '/api/ai/{appId}/conversations/{conversationId}/transcriptions/{id}',
  params={},
  headers = headers)

print r.json()

Ruby

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.get '/api/ai/{appId}/conversations/{conversationId}/transcriptions/{id}',
  params: {}, headers: headers

p JSON.parse(result)

Delete a transription's status and any saved file

DELETE /api/ai/{appId}/conversations/{conversationId}/transcriptions/{id} HTTP/1.1
Accept: application/json

Parameters

Parameter	In	Type	Required	Description
appId	path	string	true	ID of the application
conversationId	path	string	true	ID of the conversation
id	path	string	true	ID of the transcription

Responses

Overview

Status	Meaning	Description	Schema
200	OK	Success	string
404	Not Found	Not found	Inline

Response Schema

Status Code 404

Not found

Name	Type	Required	Restrictions	Description
» statusCode	number	false	none	none
» error	string	false	none	none
» message	string	false	none	none

Examples

200 Response

"OK"

caution

To perform this operation, you must be authenticated by means of one of the following methods: bearerAuth

Code samples

Shell

curl -X DELETE /api/ai/{appId}/conversations/{conversationId}/transcriptions/{id} \
  -H 'Accept: application/json' \  -H 'Authorization: Bearer {access-token}'

Go

package main

import (
    "bytes"
    "net/http"
)

func main() {
    headers := map[string][]string{ 
        "Accept": []string{"application/json"},
        "Authorization": []string{"Bearer {access-token}"},
    }

    var body []byte
    // body = ...

    req, err := http.NewRequest("DELETE", "/api/ai/{appId}/conversations/{conversationId}/transcriptions/{id}", bytes.NewBuffer(body))
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

Node

const fetch = require('node-fetch');

const headers = {
  'Accept': 'application/json',  'Authorization': 'Bearer {access-token}'
}

fetch('/api/ai/{appId}/conversations/{conversationId}/transcriptions/{id}', {
  method: 'DELETE',
  headers
})
.then(r => r.json())
.then((body) => {
    console.log(body)
})

Java

// This sample needs improvement.
URL obj = new URL("/api/ai/{appId}/conversations/{conversationId}/transcriptions/{id}");

HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("DELETE");

int responseCode = con.getResponseCode();

BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream())
);

String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();

System.out.println(response.toString());

Python

import requests

headers = {
  'Accept': 'application/json',
  'Authorization': 'Bearer {access-token}'
}

r = requests.delete(
  '/api/ai/{appId}/conversations/{conversationId}/transcriptions/{id}',
  params={},
  headers = headers)

print r.json()

Ruby

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.delete '/api/ai/{appId}/conversations/{conversationId}/transcriptions/{id}',
  params: {}, headers: headers

p JSON.parse(result)

Get a transript

GET /api/ai/{appId}/conversations/{conversationId}/transcriptions/{id}/signed-url HTTP/1.1
Accept: application/json

Get a signed url to a transcript

Parameters

Parameter	In	Type	Required	Description
appId	path	string	true	ID of the application
conversationId	path	string	true	ID of the conversation
id	path	string	true	ID of the transcript

Responses

Overview

Status	Meaning	Description	Schema
200	OK	Success	Inline
404	Not Found	Not found	Inline

Response Schema

Status Code 200

Success

Name	Type	Required	Restrictions	Description
» url	string	false	none	URL to access the transcript
» validUntil	string(date-time)	false	none	ISO timestamp with url expiration date

Status Code 404

Not found

Name	Type	Required	Restrictions	Description
» statusCode	number	false	none	none
» error	string	false	none	none
» message	string	false	none	none

Examples

200 Response

{
  "url": "string",
  "validUntil": "2019-08-24T14:15:22Z"
}

caution

To perform this operation, you must be authenticated by means of one of the following methods: bearerAuth

Code samples

Shell

curl -X GET /api/ai/{appId}/conversations/{conversationId}/transcriptions/{id}/signed-url \
  -H 'Accept: application/json' \  -H 'Authorization: Bearer {access-token}'

Go

package main

import (
    "bytes"
    "net/http"
)

func main() {
    headers := map[string][]string{ 
        "Accept": []string{"application/json"},
        "Authorization": []string{"Bearer {access-token}"},
    }

    var body []byte
    // body = ...

    req, err := http.NewRequest("GET", "/api/ai/{appId}/conversations/{conversationId}/transcriptions/{id}/signed-url", bytes.NewBuffer(body))
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

Node

const fetch = require('node-fetch');

const headers = {
  'Accept': 'application/json',  'Authorization': 'Bearer {access-token}'
}

fetch('/api/ai/{appId}/conversations/{conversationId}/transcriptions/{id}/signed-url', {
  method: 'GET',
  headers
})
.then(r => r.json())
.then((body) => {
    console.log(body)
})

Java

// This sample needs improvement.
URL obj = new URL("/api/ai/{appId}/conversations/{conversationId}/transcriptions/{id}/signed-url");

HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");

int responseCode = con.getResponseCode();

BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream())
);

String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();

System.out.println(response.toString());

Python

import requests

headers = {
  'Accept': 'application/json',
  'Authorization': 'Bearer {access-token}'
}

r = requests.get(
  '/api/ai/{appId}/conversations/{conversationId}/transcriptions/{id}/signed-url',
  params={},
  headers = headers)

print r.json()

Ruby

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.get '/api/ai/{appId}/conversations/{conversationId}/transcriptions/{id}/signed-url',
  params: {}, headers: headers

p JSON.parse(result)

Get a formatted transript

GET /api/ai/{appId}/conversations/{conversationId}/transcriptions/{id}/content HTTP/1.1
Accept: application/json

Get the transcript contents in a conversational format

Parameters

Parameter	In	Type	Required	Description
appId	path	string	true	ID of the application
conversationId	path	string	true	ID of the conversation
id	path	string	true	ID of the transcript

Responses

Overview

Status	Meaning	Description	Schema
200	OK	Success	string
404	Not Found	Not found	Inline

Response Schema

Status Code 404

Not found

Name	Type	Required	Restrictions	Description
» statusCode	number	false	none	none
» error	string	false	none	none
» message	string	false	none	none

Examples

200 Response

"string"

caution

To perform this operation, you must be authenticated by means of one of the following methods: bearerAuth

Code samples

Shell

curl -X GET /api/ai/{appId}/conversations/{conversationId}/transcriptions/{id}/content \
  -H 'Accept: application/json' \  -H 'Authorization: Bearer {access-token}'

Go

package main

import (
    "bytes"
    "net/http"
)

func main() {
    headers := map[string][]string{ 
        "Accept": []string{"application/json"},
        "Authorization": []string{"Bearer {access-token}"},
    }

    var body []byte
    // body = ...

    req, err := http.NewRequest("GET", "/api/ai/{appId}/conversations/{conversationId}/transcriptions/{id}/content", bytes.NewBuffer(body))
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

Node

const fetch = require('node-fetch');

const headers = {
  'Accept': 'application/json',  'Authorization': 'Bearer {access-token}'
}

fetch('/api/ai/{appId}/conversations/{conversationId}/transcriptions/{id}/content', {
  method: 'GET',
  headers
})
.then(r => r.json())
.then((body) => {
    console.log(body)
})

Java

// This sample needs improvement.
URL obj = new URL("/api/ai/{appId}/conversations/{conversationId}/transcriptions/{id}/content");

HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");

int responseCode = con.getResponseCode();

BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream())
);

String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();

System.out.println(response.toString());

Python

import requests

headers = {
  'Accept': 'application/json',
  'Authorization': 'Bearer {access-token}'
}

r = requests.get(
  '/api/ai/{appId}/conversations/{conversationId}/transcriptions/{id}/content',
  params={},
  headers = headers)

print r.json()

Ruby

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.get '/api/ai/{appId}/conversations/{conversationId}/transcriptions/{id}/content',
  params: {}, headers: headers

p JSON.parse(result)

translations

Manage translation jobs

Create a new translation task

POST /api/ai/{appId}/conversations/{conversationId}/transcriptions/{transcriptionId}/translations HTTP/1.1
Content-Type: application/json
Accept: application/json

Creates a new translation for a given conversation transcript

Request body

{
  "language": "string",
  "model": "string"
}

Parameters

Parameter	In	Type	Required	Description
appId	path	string	true	ID of the app
conversationId	path	string	true	ID of the conversation
transcriptionId	path	string	true	ID of the transcription
body	body	object	true	none
» language	body	string	true	Target language for translation
» model	body	string	false	Model ID of any provider

Responses

Overview

Status	Meaning	Description	Schema
200	OK	Translation Task Created Successfully	Inline
400	Bad Request	Bad Request	Inline
401	Unauthorized	Unauthorized	Inline
403	Forbidden	Forbidden	Inline
404	Not Found	Not Found	Inline

Response Schema

Status Code 200

Translation Task Created Successfully

Name	Type	Required	Restrictions	Description
» conversationId	string	true	none	ID of the conversation
» id	string	true	none	ID of the translation

Status Code 400

Bad Request

Name	Type	Required	Restrictions	Description
» statusCode	number	false	none	none
» error	string	false	none	none
» message	string	false	none	none

Status Code 401

Unauthorized

Name	Type	Required	Restrictions	Description
» statusCode	number	false	none	none
» error	string	false	none	none
» message	string	false	none	none

Status Code 403

Forbidden

Name	Type	Required	Restrictions	Description
» statusCode	number	false	none	none
» error	string	false	none	none
» message	string	false	none	none

Status Code 404

Not Found

Name	Type	Required	Restrictions	Description
» statusCode	number	false	none	none
» error	string	false	none	none
» message	string	false	none	none

Examples

200 Response

{
  "conversationId": "string",
  "id": "string"
}

caution

To perform this operation, you must be authenticated by means of one of the following methods: bearerAuth

Code samples

Shell

curl -X POST /api/ai/{appId}/conversations/{conversationId}/transcriptions/{transcriptionId}/translations \
  -H 'Content-Type: application/json' \  -H 'Accept: application/json' \  -H 'Authorization: Bearer {access-token}'

Go

package main

import (
    "bytes"
    "net/http"
)

func main() {
    headers := map[string][]string{ 
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
        "Authorization": []string{"Bearer {access-token}"},
    }

    var body []byte
    // body = ...

    req, err := http.NewRequest("POST", "/api/ai/{appId}/conversations/{conversationId}/transcriptions/{transcriptionId}/translations", bytes.NewBuffer(body))
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

Node

const fetch = require('node-fetch');
const input = '{
  "language": "string",
  "model": "string"
}';
const headers = {
  'Content-Type': 'application/json',  'Accept': 'application/json',  'Authorization': 'Bearer {access-token}'
}

fetch('/api/ai/{appId}/conversations/{conversationId}/transcriptions/{transcriptionId}/translations', {
  method: 'POST',
  body: input,
  headers
})
.then(r => r.json())
.then((body) => {
    console.log(body)
})

Java

// This sample needs improvement.
URL obj = new URL("/api/ai/{appId}/conversations/{conversationId}/transcriptions/{transcriptionId}/translations");

HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");

int responseCode = con.getResponseCode();

BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream())
);

String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();

System.out.println(response.toString());

Python

import requests

headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json',
  'Authorization': 'Bearer {access-token}'
}

r = requests.post(
  '/api/ai/{appId}/conversations/{conversationId}/transcriptions/{transcriptionId}/translations',
  params={},
  headers = headers)

print r.json()

Ruby

require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.post '/api/ai/{appId}/conversations/{conversationId}/transcriptions/{transcriptionId}/translations',
  params: {}, headers: headers

p JSON.parse(result)

Get all translations of a transcription

GET /api/ai/{appId}/conversations/{conversationId}/transcriptions/{transcriptionId}/translations HTTP/1.1
Accept: application/json

Parameters

Parameter	In	Type	Required	Description
appId	path	string	true	ID of the app
conversationId	path	string	true	ID of the conversation
transcriptionId	path	string	true	ID of the transcription

Responses

Overview

Status	Meaning	Description	Schema
200	OK	Success	Inline
404	Not Found	Not found	Inline

Response Schema

Status Code 200

Success

Name	Type	Required	Restrictions	Description
» translations	[object]	false	none	none
»» id	string	true	none	none
»» transcript	string	true	none	none
»» state	string	true	none	none
»» language	string	true	none	none
»» createdAt	string(date-time)	true	none	none
»» updatedAt	string(date-time)	true	none	none

Enumerated Values

Property	Value
state	SUBMITTED
state	RESUBMIT
state	PROCESSING
state	COMPLETED
state	FAILED

Status Code 404

Not found

Name	Type	Required	Restrictions	Description
» statusCode	number	false	none	none
» error	string	false	none	none
» message	string	false	none	none

Examples

200 Response

{
  "translations": [
    {
      "id": "string",
      "transcript": "string",
      "state": "SUBMITTED",
      "language": "string",
      "createdAt": "2019-08-24T14:15:22Z",
      "updatedAt": "2019-08-24T14:15:22Z"
    }
  ]
}

caution

To perform this operation, you must be authenticated by means of one of the following methods: bearerAuth

Code samples

Shell

curl -X GET /api/ai/{appId}/conversations/{conversationId}/transcriptions/{transcriptionId}/translations \
  -H 'Accept: application/json' \  -H 'Authorization: Bearer {access-token}'

Go

package main

import (
    "bytes"
    "net/http"
)

func main() {
    headers := map[string][]string{ 
        "Accept": []string{"application/json"},
        "Authorization": []string{"Bearer {access-token}"},
    }

    var body []byte
    // body = ...

    req, err := http.NewRequest("GET", "/api/ai/{appId}/conversations/{conversationId}/transcriptions/{transcriptionId}/translations", bytes.NewBuffer(body))
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

Node

const fetch = require('node-fetch');

const headers = {
  'Accept': 'application/json',  'Authorization': 'Bearer {access-token}'
}

fetch('/api/ai/{appId}/conversations/{conversationId}/transcriptions/{transcriptionId}/translations', {
  method: 'GET',
  headers
})
.then(r => r.json())
.then((body) => {
    console.log(body)
})

Java

// This sample needs improvement.
URL obj = new URL("/api/ai/{appId}/conversations/{conversationId}/transcriptions/{transcriptionId}/translations");

HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");

int responseCode = con.getResponseCode();

BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream())
);

String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();

System.out.println(response.toString());

Python

import requests

headers = {
  'Accept': 'application/json',
  'Authorization': 'Bearer {access-token}'
}

r = requests.get(
  '/api/ai/{appId}/conversations/{conversationId}/transcriptions/{transcriptionId}/translations',
  params={},
  headers = headers)

print r.json()

Ruby

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.get '/api/ai/{appId}/conversations/{conversationId}/transcriptions/{transcriptionId}/translations',
  params: {}, headers: headers

p JSON.parse(result)

Get a translation's status

GET /api/ai/{appId}/conversations/{conversationId}/transcriptions/{transcriptionId}/translations/{id} HTTP/1.1
Accept: application/json

Parameters

Parameter	In	Type	Required	Description
appId	path	string	true	ID of the application
conversationId	path	string	true	ID of the conversation
transcriptionId	path	string	true	ID of the transcription
id	path	string	true	ID of the translation

Responses

Overview

Status	Meaning	Description	Schema
200	OK	Success	Inline
404	Not Found	Not found	Inline

Response Schema

Status Code 200

Success

Name	Type	Required	Restrictions	Description
» translation	object	false	none	none
»» id	string	true	none	none
»» transcript	string	true	none	none
»» state	string	true	none	none
»» language	string	true	none	none
»» createdAt	string(date-time)	true	none	none
»» updatedAt	string(date-time)	true	none	none

Enumerated Values

Property	Value
state	SUBMITTED
state	RESUBMIT
state	PROCESSING
state	COMPLETED
state	FAILED

Status Code 404

Not found

Name	Type	Required	Restrictions	Description
» statusCode	number	false	none	none
» error	string	false	none	none
» message	string	false	none	none

Examples

200 Response

{
  "translation": {
    "id": "string",
    "transcript": "string",
    "state": "SUBMITTED",
    "language": "string",
    "createdAt": "2019-08-24T14:15:22Z",
    "updatedAt": "2019-08-24T14:15:22Z"
  }
}

caution

To perform this operation, you must be authenticated by means of one of the following methods: bearerAuth

Code samples

Shell

curl -X GET /api/ai/{appId}/conversations/{conversationId}/transcriptions/{transcriptionId}/translations/{id} \
  -H 'Accept: application/json' \  -H 'Authorization: Bearer {access-token}'

Go

package main

import (
    "bytes"
    "net/http"
)

func main() {
    headers := map[string][]string{ 
        "Accept": []string{"application/json"},
        "Authorization": []string{"Bearer {access-token}"},
    }

    var body []byte
    // body = ...

    req, err := http.NewRequest("GET", "/api/ai/{appId}/conversations/{conversationId}/transcriptions/{transcriptionId}/translations/{id}", bytes.NewBuffer(body))
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

Node

const fetch = require('node-fetch');

const headers = {
  'Accept': 'application/json',  'Authorization': 'Bearer {access-token}'
}

fetch('/api/ai/{appId}/conversations/{conversationId}/transcriptions/{transcriptionId}/translations/{id}', {
  method: 'GET',
  headers
})
.then(r => r.json())
.then((body) => {
    console.log(body)
})

Java

// This sample needs improvement.
URL obj = new URL("/api/ai/{appId}/conversations/{conversationId}/transcriptions/{transcriptionId}/translations/{id}");

HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");

int responseCode = con.getResponseCode();

BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream())
);

String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();

System.out.println(response.toString());

Python

import requests

headers = {
  'Accept': 'application/json',
  'Authorization': 'Bearer {access-token}'
}

r = requests.get(
  '/api/ai/{appId}/conversations/{conversationId}/transcriptions/{transcriptionId}/translations/{id}',
  params={},
  headers = headers)

print r.json()

Ruby

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.get '/api/ai/{appId}/conversations/{conversationId}/transcriptions/{transcriptionId}/translations/{id}',
  params: {}, headers: headers

p JSON.parse(result)

Delete a translation's status and any saved file

DELETE /api/ai/{appId}/conversations/{conversationId}/transcriptions/{transcriptionId}/translations/{id} HTTP/1.1
Accept: application/json

Parameters

Parameter	In	Type	Required	Description
appId	path	string	true	ID of the app
conversationId	path	string	true	ID of the conversation
transcriptionId	path	string	true	ID of the transcription
id	path	string	true	ID of the translation

Responses

Overview

Status	Meaning	Description	Schema
200	OK	Success	string
404	Not Found	Not found	Inline

Response Schema

Status Code 404

Not found

Name	Type	Required	Restrictions	Description
» statusCode	number	false	none	none
» error	string	false	none	none
» message	string	false	none	none

Examples

200 Response

"OK"

caution

To perform this operation, you must be authenticated by means of one of the following methods: bearerAuth

Code samples

Shell

curl -X DELETE /api/ai/{appId}/conversations/{conversationId}/transcriptions/{transcriptionId}/translations/{id} \
  -H 'Accept: application/json' \  -H 'Authorization: Bearer {access-token}'

Go

package main

import (
    "bytes"
    "net/http"
)

func main() {
    headers := map[string][]string{ 
        "Accept": []string{"application/json"},
        "Authorization": []string{"Bearer {access-token}"},
    }

    var body []byte
    // body = ...

    req, err := http.NewRequest("DELETE", "/api/ai/{appId}/conversations/{conversationId}/transcriptions/{transcriptionId}/translations/{id}", bytes.NewBuffer(body))
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

Node

const fetch = require('node-fetch');

const headers = {
  'Accept': 'application/json',  'Authorization': 'Bearer {access-token}'
}

fetch('/api/ai/{appId}/conversations/{conversationId}/transcriptions/{transcriptionId}/translations/{id}', {
  method: 'DELETE',
  headers
})
.then(r => r.json())
.then((body) => {
    console.log(body)
})

Java

// This sample needs improvement.
URL obj = new URL("/api/ai/{appId}/conversations/{conversationId}/transcriptions/{transcriptionId}/translations/{id}");

HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("DELETE");

int responseCode = con.getResponseCode();

BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream())
);

String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();

System.out.println(response.toString());

Python

import requests

headers = {
  'Accept': 'application/json',
  'Authorization': 'Bearer {access-token}'
}

r = requests.delete(
  '/api/ai/{appId}/conversations/{conversationId}/transcriptions/{transcriptionId}/translations/{id}',
  params={},
  headers = headers)

print r.json()

Ruby

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.delete '/api/ai/{appId}/conversations/{conversationId}/transcriptions/{transcriptionId}/translations/{id}',
  params: {}, headers: headers

p JSON.parse(result)

Get a translation

GET /api/ai/{appId}/conversations/{conversationId}/transcriptions/{transcriptionId}/translations/{id}/signed-url HTTP/1.1
Accept: application/json

Get a signed url to a transcription's translation

Parameters

Parameter	In	Type	Required	Description
appId	path	string	true	ID of the application
conversationId	path	string	true	ID of the conversation
transcriptionId	path	string	true	ID of the transcription
id	path	string	true	ID of the translation

Responses

Overview

Status	Meaning	Description	Schema
200	OK	Success	Inline
404	Not Found	Not found	Inline

Response Schema

Status Code 200

Success

Name	Type	Required	Restrictions	Description
» url	string	false	none	URL to access the translation json file
» validUntil	string(date-time)	false	none	ISO timestamp with url expiration date

Status Code 404

Not found

Name	Type	Required	Restrictions	Description
» statusCode	number	false	none	none
» error	string	false	none	none
» message	string	false	none	none

Examples

200 Response

{
  "url": "string",
  "validUntil": "2019-08-24T14:15:22Z"
}

caution

To perform this operation, you must be authenticated by means of one of the following methods: bearerAuth

Code samples

Shell

curl -X GET /api/ai/{appId}/conversations/{conversationId}/transcriptions/{transcriptionId}/translations/{id}/signed-url \
  -H 'Accept: application/json' \  -H 'Authorization: Bearer {access-token}'

Go

package main

import (
    "bytes"
    "net/http"
)

func main() {
    headers := map[string][]string{ 
        "Accept": []string{"application/json"},
        "Authorization": []string{"Bearer {access-token}"},
    }

    var body []byte
    // body = ...

    req, err := http.NewRequest("GET", "/api/ai/{appId}/conversations/{conversationId}/transcriptions/{transcriptionId}/translations/{id}/signed-url", bytes.NewBuffer(body))
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

Node

const fetch = require('node-fetch');

const headers = {
  'Accept': 'application/json',  'Authorization': 'Bearer {access-token}'
}

fetch('/api/ai/{appId}/conversations/{conversationId}/transcriptions/{transcriptionId}/translations/{id}/signed-url', {
  method: 'GET',
  headers
})
.then(r => r.json())
.then((body) => {
    console.log(body)
})

Java

// This sample needs improvement.
URL obj = new URL("/api/ai/{appId}/conversations/{conversationId}/transcriptions/{transcriptionId}/translations/{id}/signed-url");

HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");

int responseCode = con.getResponseCode();

BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream())
);

String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();

System.out.println(response.toString());

Python

import requests

headers = {
  'Accept': 'application/json',
  'Authorization': 'Bearer {access-token}'
}

r = requests.get(
  '/api/ai/{appId}/conversations/{conversationId}/transcriptions/{transcriptionId}/translations/{id}/signed-url',
  params={},
  headers = headers)

print r.json()

Ruby

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.get '/api/ai/{appId}/conversations/{conversationId}/transcriptions/{transcriptionId}/translations/{id}/signed-url',
  params: {}, headers: headers

p JSON.parse(result)

Get the formatted translation of a transcript

GET /api/ai/{appId}/conversations/{conversationId}/transcriptions/{transcriptionId}/translations/{id}/content HTTP/1.1
Accept: application/json

Get the translated contents in a conversational format

Parameters

Parameter	In	Type	Required	Description
appId	path	string	true	ID of the application
conversationId	path	string	true	ID of the conversation
transcriptionId	path	string	true	ID of the transcription
id	path	string	true	ID of the translation

Responses

Overview

Status	Meaning	Description	Schema
200	OK	Success	string
404	Not Found	Not found	Inline

Response Schema

Status Code 404

Not found

Name	Type	Required	Restrictions	Description
» statusCode	number	false	none	none
» error	string	false	none	none
» message	string	false	none	none

Examples

200 Response

"string"

caution

To perform this operation, you must be authenticated by means of one of the following methods: bearerAuth

Code samples

Shell

curl -X GET /api/ai/{appId}/conversations/{conversationId}/transcriptions/{transcriptionId}/translations/{id}/content \
  -H 'Accept: application/json' \  -H 'Authorization: Bearer {access-token}'

Go

package main

import (
    "bytes"
    "net/http"
)

func main() {
    headers := map[string][]string{ 
        "Accept": []string{"application/json"},
        "Authorization": []string{"Bearer {access-token}"},
    }

    var body []byte
    // body = ...

    req, err := http.NewRequest("GET", "/api/ai/{appId}/conversations/{conversationId}/transcriptions/{transcriptionId}/translations/{id}/content", bytes.NewBuffer(body))
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

Node

const fetch = require('node-fetch');

const headers = {
  'Accept': 'application/json',  'Authorization': 'Bearer {access-token}'
}

fetch('/api/ai/{appId}/conversations/{conversationId}/transcriptions/{transcriptionId}/translations/{id}/content', {
  method: 'GET',
  headers
})
.then(r => r.json())
.then((body) => {
    console.log(body)
})

Java

// This sample needs improvement.
URL obj = new URL("/api/ai/{appId}/conversations/{conversationId}/transcriptions/{transcriptionId}/translations/{id}/content");

HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");

int responseCode = con.getResponseCode();

BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream())
);

String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();

System.out.println(response.toString());

Python

import requests

headers = {
  'Accept': 'application/json',
  'Authorization': 'Bearer {access-token}'
}

r = requests.get(
  '/api/ai/{appId}/conversations/{conversationId}/transcriptions/{transcriptionId}/translations/{id}/content',
  params={},
  headers = headers)

print r.json()

Ruby

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.get '/api/ai/{appId}/conversations/{conversationId}/transcriptions/{transcriptionId}/translations/{id}/content',
  params: {}, headers: headers

p JSON.parse(result)

options

Manage options for each provider

Get properties of a provider

GET /api/ai/{appId}/providers/{provider}/properties HTTP/1.1
Accept: application/json

Get supported models, languages and regions for some provider

Parameters

Parameter	In	Type	Required	Description
region	query	string	false	Optional provider region used to scope region-specific models. Defaults to global.
appId	path	string	true	Application ID
provider	path	string	true	ASR service provider name

Enumerated Values

Parameter	Value
provider	open_ai
provider	google_cloud
provider	google_ai_studio
provider	elevenlabs

Responses

Overview

Status	Meaning	Description	Schema
200	OK	Success	Inline
400	Bad Request	Bad Request	Inline
401	Unauthorized	Unauthorized	Inline
403	Forbidden	Forbidden	Inline
404	Not Found	Not Found	Inline

Response Schema

Status Code 200

Success

Name	Type	Required	Restrictions	Description
» regions	[string]	false	none	none
» voices	[string]	false	none	none
» speechLanguages	[object]	false	none	none
»» language	string	true	none	Display name for speech language.
»» code	string	true	none	Language code for speech.
» models	[object]	false	none	none
»» id	string	true	none	The model ID.
»» provider	string	true	none	The model provider.
»» regions	[string]	false	none	none
»» transcription	boolean	false	none	Whether the model is used for transcription.
»» translation	boolean	false	none	Whether the model is used for translation.
»» prompt	boolean	false	none	Whether the model is used for prompt.
»» agent	boolean	false	none	Whether the model is used for agent.
»» chat	boolean	false	none	Whether the model is used for chat.
»» recognition	boolean	false	none	Whether the model is used for recognition.
» defaults	object	false	none	none
»» transcription	object	false	none	none
»»» model	string	true	none	Default model for transcription
»» translation	object	false	none	none
»»» model	string	true	none	Default model for translation
»» prompt	object	false	none	none
»»» model	string	true	none	Default model for prompt
»» agent	object	false	none	none
»»» model	string	true	none	Default model for agent
»»» systemPrompt	string	false	none	Default system prompt for agent
»» recognition	object	false	none	none
»»» model	string	true	none	Default model for recognition
»» chat	object	false	none	none
»»» model	string	true	none	Default model for chat
» tools	[object]	false	none	none
»» key	string	true	none	none
»» label	string	true	none	none
»» description	string	false	none	none
»» enabled	boolean	true	none	none

Enumerated Values

Property	Value
provider	open_ai
provider	google_cloud
provider	google_ai_studio
provider	elevenlabs
key	closeSession
key	scheduleVideoCallPanel
key	escalateToVideoCall
key	suggestQuickReplies
key	webSearch

Status Code 400

Bad Request

Name	Type	Required	Restrictions	Description
» code	number	false	none	none
» severity	string	false	none	none
» message	string	false	none	none
» errorCode	string	false	none	none

Status Code 401

Unauthorized

Name	Type	Required	Restrictions	Description
» code	number	false	none	none
» severity	string	false	none	none
» message	string	false	none	none
» errorCode	string	false	none	none

Status Code 403

Forbidden

Name	Type	Required	Restrictions	Description
» code	number	false	none	none
» severity	string	false	none	none
» message	string	false	none	none
» errorCode	string	false	none	none

Status Code 404

Not Found

Name	Type	Required	Restrictions	Description
» code	number	false	none	none
» severity	string	false	none	none
» message	string	false	none	none
» errorCode	string	false	none	none

Examples

200 Response

{
  "regions": [
    "string"
  ],
  "voices": [
    "string"
  ],
  "speechLanguages": [
    {
      "language": "string",
      "code": "string"
    }
  ],
  "models": [
    {
      "id": "string",
      "provider": "open_ai",
      "regions": [
        "string"
      ],
      "transcription": true,
      "translation": true,
      "prompt": true,
      "agent": true,
      "chat": true,
      "recognition": true
    }
  ],
  "defaults": {
    "transcription": {
      "model": "string"
    },
    "translation": {
      "model": "string"
    },
    "prompt": {
      "model": "string"
    },
    "agent": {
      "model": "string",
      "systemPrompt": "string"
    },
    "recognition": {
      "model": "string"
    },
    "chat": {
      "model": "string"
    }
  },
  "tools": [
    {
      "key": "closeSession",
      "label": "string",
      "description": "string",
      "enabled": true
    }
  ]
}

caution

To perform this operation, you must be authenticated by means of one of the following methods: bearerAuth

Code samples

Shell

curl -X GET /api/ai/{appId}/providers/{provider}/properties \
  -H 'Accept: application/json' \  -H 'Authorization: Bearer {access-token}'

Go

package main

import (
    "bytes"
    "net/http"
)

func main() {
    headers := map[string][]string{ 
        "Accept": []string{"application/json"},
        "Authorization": []string{"Bearer {access-token}"},
    }

    var body []byte
    // body = ...

    req, err := http.NewRequest("GET", "/api/ai/{appId}/providers/{provider}/properties", bytes.NewBuffer(body))
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

Node

const fetch = require('node-fetch');

const headers = {
  'Accept': 'application/json',  'Authorization': 'Bearer {access-token}'
}

fetch('/api/ai/{appId}/providers/{provider}/properties', {
  method: 'GET',
  headers
})
.then(r => r.json())
.then((body) => {
    console.log(body)
})

Java

// This sample needs improvement.
URL obj = new URL("/api/ai/{appId}/providers/{provider}/properties");

HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");

int responseCode = con.getResponseCode();

BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream())
);

String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();

System.out.println(response.toString());

Python

import requests

headers = {
  'Accept': 'application/json',
  'Authorization': 'Bearer {access-token}'
}

r = requests.get(
  '/api/ai/{appId}/providers/{provider}/properties',
  params={},
  headers = headers)

print r.json()

Ruby

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.get '/api/ai/{appId}/providers/{provider}/properties',
  params: {}, headers: headers

p JSON.parse(result)

Get available languages

GET /api/ai/{appId}/providers/{provider}/languages HTTP/1.1
Accept: application/json

Get the supported languages for some provider with region, model and usage filters

Parameters

Parameter	In	Type	Required	Description
usage	query	string	false	Usage type filter
region	query	string	false	Region code filter
model	query	string	false	Model identifier filter
appId	path	string	true	Application ID
provider	path	string	true	none

Enumerated Values

Parameter	Value
usage	transcriptions
usage	translations
provider	open_ai
provider	google_cloud
provider	google_ai_studio

Responses

Overview

Status	Meaning	Description	Schema
200	OK	Success	Inline
400	Bad Request	Bad Request	Inline
401	Unauthorized	Unauthorized	Inline
403	Forbidden	Forbidden	Inline

Response Schema

Status Code 200

Success

Name	Type	Required	Restrictions	Description
» code	string	false	none	Language code
» name	string	false	none	Language name
» support	[object]	false	none	Support details for language
»» region	string	false	none	Region code
»» model	string	false	none	Model identifier

Status Code 400

Bad Request

Name	Type	Required	Restrictions	Description
» code	number	false	none	none
» severity	string	false	none	none
» message	string	false	none	none

Status Code 401

Unauthorized

Name	Type	Required	Restrictions	Description
» code	number	false	none	none
» severity	string	false	none	none
» message	string	false	none	none

Status Code 403

Forbidden

Name	Type	Required	Restrictions	Description
» code	number	false	none	none
» severity	string	false	none	none
» message	string	false	none	none

Examples

200 Response

[
  {
    "code": "en",
    "region": "global",
    "name": "English",
    "model": "whisper-1"
  },
  {
    "region": "us-west1",
    "name": "English (United States)",
    "code": "en-US",
    "model": "chirp_2"
  }
]

caution

To perform this operation, you must be authenticated by means of one of the following methods: bearerAuth

Code samples

Shell

curl -X GET /api/ai/{appId}/providers/{provider}/languages \
  -H 'Accept: application/json' \  -H 'Authorization: Bearer {access-token}'

Go

package main

import (
    "bytes"
    "net/http"
)

func main() {
    headers := map[string][]string{ 
        "Accept": []string{"application/json"},
        "Authorization": []string{"Bearer {access-token}"},
    }

    var body []byte
    // body = ...

    req, err := http.NewRequest("GET", "/api/ai/{appId}/providers/{provider}/languages", bytes.NewBuffer(body))
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

Node

const fetch = require('node-fetch');

const headers = {
  'Accept': 'application/json',  'Authorization': 'Bearer {access-token}'
}

fetch('/api/ai/{appId}/providers/{provider}/languages', {
  method: 'GET',
  headers
})
.then(r => r.json())
.then((body) => {
    console.log(body)
})

Java

// This sample needs improvement.
URL obj = new URL("/api/ai/{appId}/providers/{provider}/languages");

HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");

int responseCode = con.getResponseCode();

BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream())
);

String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();

System.out.println(response.toString());

Python

import requests

headers = {
  'Accept': 'application/json',
  'Authorization': 'Bearer {access-token}'
}

r = requests.get(
  '/api/ai/{appId}/providers/{provider}/languages',
  params={},
  headers = headers)

print r.json()

Ruby

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.get '/api/ai/{appId}/providers/{provider}/languages',
  params: {}, headers: headers

p JSON.parse(result)

Test configured AI options

POST /api/ai/{appId}/options/test HTTP/1.1
Content-Type: application/json
Accept: application/json

Runs a lightweight test session against the configured provider to verify connectivity.

Request body

{
  "usage": "transcription",
  "languageCode": "string",
  "auviousEnvironment": "string"
}

Parameters

Parameter	In	Type	Required	Description
appId	path	string	true	Application ID
body	body	object	true	none
» usage	body	string	true	Usage intent to test
» languageCode	body	string	false	Optional language code override
» auviousEnvironment	body	string	false	Optional override for auvious environment URL

Enumerated Values

Parameter	Value
» usage	transcription
» usage	translation
» usage	prompt
» usage	agent
» usage	chat
» usage	recognition

Responses

Overview

Status	Meaning	Description	Schema
200	OK	Default Response	Inline

Response Schema

Status Code 200

Name	Type	Required	Restrictions	Description
» usage	string	true	none	Usage intent to test
» passed	boolean	true	none	none
» reason	string	false	none	none

Enumerated Values

Property	Value
usage	transcription
usage	translation
usage	prompt
usage	agent
usage	chat
usage	recognition

Examples

200 Response

{
  "usage": "transcription",
  "passed": true,
  "reason": "string"
}

caution

To perform this operation, you must be authenticated by means of one of the following methods: bearerAuth

Code samples

Shell

curl -X POST /api/ai/{appId}/options/test \
  -H 'Content-Type: application/json' \  -H 'Accept: application/json' \  -H 'Authorization: Bearer {access-token}'

Go

package main

import (
    "bytes"
    "net/http"
)

func main() {
    headers := map[string][]string{ 
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
        "Authorization": []string{"Bearer {access-token}"},
    }

    var body []byte
    // body = ...

    req, err := http.NewRequest("POST", "/api/ai/{appId}/options/test", bytes.NewBuffer(body))
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

Node

const fetch = require('node-fetch');
const input = '{
  "usage": "transcription",
  "languageCode": "string",
  "auviousEnvironment": "string"
}';
const headers = {
  'Content-Type': 'application/json',  'Accept': 'application/json',  'Authorization': 'Bearer {access-token}'
}

fetch('/api/ai/{appId}/options/test', {
  method: 'POST',
  body: input,
  headers
})
.then(r => r.json())
.then((body) => {
    console.log(body)
})

Java

// This sample needs improvement.
URL obj = new URL("/api/ai/{appId}/options/test");

HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");

int responseCode = con.getResponseCode();

BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream())
);

String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();

System.out.println(response.toString());

Python

import requests

headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json',
  'Authorization': 'Bearer {access-token}'
}

r = requests.post(
  '/api/ai/{appId}/options/test',
  params={},
  headers = headers)

print r.json()

Ruby

require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.post '/api/ai/{appId}/options/test',
  params: {}, headers: headers

p JSON.parse(result)

Get provisioned languages

GET /api/ai/{appId}/enabled/languages HTTP/1.1
Accept: application/json

Get the provisioned languages of user's organization

Parameters

Parameter	In	Type	Required	Description
appId	path	string	true	none

Responses

Overview

Status	Meaning	Description	Schema
200	OK	Success	Inline
400	Bad Request	Bad Request	Inline
401	Unauthorized	Unauthorized	Inline
403	Forbidden	Forbidden	Inline

Response Schema

Status Code 200

Success

Name	Type	Required	Restrictions	Description
» languages	[object]	false	none	none
»» code	string	true	none	The language code (e.g., 'en', 'fr').
»» provider	string	true	none	The language provider.
»» model	string	false	none	Specific model
»» region	string	false	none	Provider's server region
»» usage	string	false	none	What is the language used for by default.

Enumerated Values

Property	Value
provider	open_ai
provider	google_cloud
provider	google_ai_studio
usage	transcription
usage	translation

Status Code 400

Bad Request

Name	Type	Required	Restrictions	Description
» code	number	false	none	none
» severity	string	false	none	none
» message	string	false	none	none

Status Code 401

Unauthorized

Name	Type	Required	Restrictions	Description
» code	number	false	none	none
» severity	string	false	none	none
» message	string	false	none	none

Status Code 403

Forbidden

Name	Type	Required	Restrictions	Description
» code	number	false	none	none
» severity	string	false	none	none
» message	string	false	none	none

Examples

200 Response

{
  "languages": [
    {
      "code": "gr",
      "provider": "open_ai",
      "model": "string",
      "region": "string",
      "usage": "transcription"
    }
  ]
}

caution

To perform this operation, you must be authenticated by means of one of the following methods: bearerAuth

Code samples

Shell

curl -X GET /api/ai/{appId}/enabled/languages \
  -H 'Accept: application/json' \  -H 'Authorization: Bearer {access-token}'

Go

package main

import (
    "bytes"
    "net/http"
)

func main() {
    headers := map[string][]string{ 
        "Accept": []string{"application/json"},
        "Authorization": []string{"Bearer {access-token}"},
    }

    var body []byte
    // body = ...

    req, err := http.NewRequest("GET", "/api/ai/{appId}/enabled/languages", bytes.NewBuffer(body))
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

Node

const fetch = require('node-fetch');

const headers = {
  'Accept': 'application/json',  'Authorization': 'Bearer {access-token}'
}

fetch('/api/ai/{appId}/enabled/languages', {
  method: 'GET',
  headers
})
.then(r => r.json())
.then((body) => {
    console.log(body)
})

Java

// This sample needs improvement.
URL obj = new URL("/api/ai/{appId}/enabled/languages");

HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");

int responseCode = con.getResponseCode();

BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream())
);

String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();

System.out.println(response.toString());

Python

import requests

headers = {
  'Accept': 'application/json',
  'Authorization': 'Bearer {access-token}'
}

r = requests.get(
  '/api/ai/{appId}/enabled/languages',
  params={},
  headers = headers)

print r.json()

Ruby

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.get '/api/ai/{appId}/enabled/languages',
  params: {}, headers: headers

p JSON.parse(result)

Add language support to user's application

POST /api/ai/{appId}/enabled/languages HTTP/1.1
Content-Type: application/json
Accept: application/json

It will overwrite existing language configuration for the specified provider/usage combo.

Request body

{
  "code": "string",
  "provider": "GOOGLE_CLOUD",
  "regions": [
    {
      "region": "string",
      "model": "string"
    }
  ],
  "setDefault": "transcription"
}

Parameters

Parameter	In	Type	Required	Description
appId	path	string	true	Application ID
body	body	object	true	none
» code	body	string	true	Language code
» provider	body	string	true	STT Provider
» regions	body	[object]	false	Define optional regions and models for the language. Missing values suggests to consider all options.
»» region	body	string	true	Region code
»» model	body	string	false	Model name
» setDefault	body	string	false	none

Enumerated Values

Parameter	Value
» provider	GOOGLE_CLOUD
» provider	OPEN_AI
» setDefault	transcription
» setDefault	translation

Responses

Overview

Status	Meaning	Description	Schema
200	OK	OK	string
400	Bad Request	Bad Request	Inline
401	Unauthorized	Unauthorized	Inline
403	Forbidden	Forbidden	Inline

Response Schema

Status Code 400

Bad Request

Name	Type	Required	Restrictions	Description
» code	number	false	none	none
» severity	string	false	none	none
» message	string	false	none	none

Status Code 401

Unauthorized

Name	Type	Required	Restrictions	Description
» code	number	false	none	none
» severity	string	false	none	none
» message	string	false	none	none

Status Code 403

Forbidden

Name	Type	Required	Restrictions	Description
» code	number	false	none	none
» severity	string	false	none	none
» message	string	false	none	none

Examples

200 Response

"string"

caution

To perform this operation, you must be authenticated by means of one of the following methods: bearerAuth

Code samples

Shell

curl -X POST /api/ai/{appId}/enabled/languages \
  -H 'Content-Type: application/json' \  -H 'Accept: application/json' \  -H 'Authorization: Bearer {access-token}'

Go

package main

import (
    "bytes"
    "net/http"
)

func main() {
    headers := map[string][]string{ 
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
        "Authorization": []string{"Bearer {access-token}"},
    }

    var body []byte
    // body = ...

    req, err := http.NewRequest("POST", "/api/ai/{appId}/enabled/languages", bytes.NewBuffer(body))
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

Node

const fetch = require('node-fetch');
const input = '{
  "code": "string",
  "provider": "GOOGLE_CLOUD",
  "regions": [
    {
      "region": "string",
      "model": "string"
    }
  ],
  "setDefault": "transcription"
}';
const headers = {
  'Content-Type': 'application/json',  'Accept': 'application/json',  'Authorization': 'Bearer {access-token}'
}

fetch('/api/ai/{appId}/enabled/languages', {
  method: 'POST',
  body: input,
  headers
})
.then(r => r.json())
.then((body) => {
    console.log(body)
})

Java

// This sample needs improvement.
URL obj = new URL("/api/ai/{appId}/enabled/languages");

HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");

int responseCode = con.getResponseCode();

BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream())
);

String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();

System.out.println(response.toString());

Python

import requests

headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json',
  'Authorization': 'Bearer {access-token}'
}

r = requests.post(
  '/api/ai/{appId}/enabled/languages',
  params={},
  headers = headers)

print r.json()

Ruby

require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.post '/api/ai/{appId}/enabled/languages',
  params: {}, headers: headers

p JSON.parse(result)

Remove a language from a user's organization

DELETE /api/ai/{appId}/enabled/languages/{code} HTTP/1.1
Accept: application/json

Remove all by code or optionally make it more specific by adding provider or usage

Parameters

Parameter	In	Type	Required	Description
provider	query	string	false	Remove by service provider
usage	query	string	false	Remove by language usage
appId	path	string	true	Application ID
code	path	string	true	Language code

Enumerated Values

Parameter	Value
provider	GOOGLE_CLOUD
provider	OPEN_AI
usage	transcription
usage	translation

Responses

Overview

Status	Meaning	Description	Schema
200	OK	OK	string
400	Bad Request	Bad Request	Inline
401	Unauthorized	Unauthorized	Inline
403	Forbidden	Forbidden	Inline

Response Schema

Status Code 400

Bad Request

Name	Type	Required	Restrictions	Description
» code	number	false	none	none
» severity	string	false	none	none
» message	string	false	none	none

Status Code 401

Unauthorized

Name	Type	Required	Restrictions	Description
» code	number	false	none	none
» severity	string	false	none	none
» message	string	false	none	none

Status Code 403

Forbidden

Name	Type	Required	Restrictions	Description
» code	number	false	none	none
» severity	string	false	none	none
» message	string	false	none	none

Examples

200 Response

"string"

caution

To perform this operation, you must be authenticated by means of one of the following methods: bearerAuth

Code samples

Shell

curl -X DELETE /api/ai/{appId}/enabled/languages/{code} \
  -H 'Accept: application/json' \  -H 'Authorization: Bearer {access-token}'

Go

package main

import (
    "bytes"
    "net/http"
)

func main() {
    headers := map[string][]string{ 
        "Accept": []string{"application/json"},
        "Authorization": []string{"Bearer {access-token}"},
    }

    var body []byte
    // body = ...

    req, err := http.NewRequest("DELETE", "/api/ai/{appId}/enabled/languages/{code}", bytes.NewBuffer(body))
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

Node

const fetch = require('node-fetch');

const headers = {
  'Accept': 'application/json',  'Authorization': 'Bearer {access-token}'
}

fetch('/api/ai/{appId}/enabled/languages/{code}', {
  method: 'DELETE',
  headers
})
.then(r => r.json())
.then((body) => {
    console.log(body)
})

Java

// This sample needs improvement.
URL obj = new URL("/api/ai/{appId}/enabled/languages/{code}");

HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("DELETE");

int responseCode = con.getResponseCode();

BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream())
);

String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();

System.out.println(response.toString());

Python

import requests

headers = {
  'Accept': 'application/json',
  'Authorization': 'Bearer {access-token}'
}

r = requests.delete(
  '/api/ai/{appId}/enabled/languages/{code}',
  params={},
  headers = headers)

print r.json()

Ruby

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.delete '/api/ai/{appId}/enabled/languages/{code}',
  params: {}, headers: headers

p JSON.parse(result)

Get provisioned models

GET /api/ai/{appId}/enabled/models HTTP/1.1
Accept: application/json

Get the provisioned models for some organization

Parameters

Parameter	In	Type	Required	Description
appId	path	string	true	none

Responses

Overview

Status	Meaning	Description	Schema
200	OK	Success	Inline
400	Bad Request	Bad Request	Inline
401	Unauthorized	Unauthorized	Inline
403	Forbidden	Forbidden	Inline

Response Schema

Status Code 200

Success

Name	Type	Required	Restrictions	Description
» models	[object]	false	none	none
»» id	string	false	none	The model ID.
»» provider	string	false	none	The model provider.
»» usage	string	false	none	Intended usage

Enumerated Values

Property	Value
provider	open_ai
provider	google_cloud
provider	google_ai_studio
provider	elevenlabs
usage	transcription
usage	translation
usage	prompt
usage	agent
usage	chat
usage	recognition

Status Code 400

Bad Request

Name	Type	Required	Restrictions	Description
» code	number	false	none	none
» severity	string	false	none	none
» message	string	false	none	none

Status Code 401

Unauthorized

Name	Type	Required	Restrictions	Description
» code	number	false	none	none
» severity	string	false	none	none
» message	string	false	none	none

Status Code 403

Forbidden

Name	Type	Required	Restrictions	Description
» code	number	false	none	none
» severity	string	false	none	none
» message	string	false	none	none

Examples

200 Response

{
  "models": [
    {
      "id": "string",
      "provider": "open_ai",
      "usage": "transcription"
    }
  ]
}

caution

To perform this operation, you must be authenticated by means of one of the following methods: bearerAuth

Code samples

Shell

curl -X GET /api/ai/{appId}/enabled/models \
  -H 'Accept: application/json' \  -H 'Authorization: Bearer {access-token}'

Go

package main

import (
    "bytes"
    "net/http"
)

func main() {
    headers := map[string][]string{ 
        "Accept": []string{"application/json"},
        "Authorization": []string{"Bearer {access-token}"},
    }

    var body []byte
    // body = ...

    req, err := http.NewRequest("GET", "/api/ai/{appId}/enabled/models", bytes.NewBuffer(body))
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

Node

const fetch = require('node-fetch');

const headers = {
  'Accept': 'application/json',  'Authorization': 'Bearer {access-token}'
}

fetch('/api/ai/{appId}/enabled/models', {
  method: 'GET',
  headers
})
.then(r => r.json())
.then((body) => {
    console.log(body)
})

Java

// This sample needs improvement.
URL obj = new URL("/api/ai/{appId}/enabled/models");

HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");

int responseCode = con.getResponseCode();

BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream())
);

String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();

System.out.println(response.toString());

Python

import requests

headers = {
  'Accept': 'application/json',
  'Authorization': 'Bearer {access-token}'
}

r = requests.get(
  '/api/ai/{appId}/enabled/models',
  params={},
  headers = headers)

print r.json()

Ruby

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.get '/api/ai/{appId}/enabled/models',
  params: {}, headers: headers

p JSON.parse(result)

Mark an available model for usage by the organization

POST /api/ai/{appId}/enabled/models HTTP/1.1
Content-Type: application/json
Accept: application/json

Model can be of any type, if it is the first one it becomes the default for its type

Request body

{
  "id": "string",
  "provider": "GOOGLE_CLOUD",
  "usage": "transcription"
}

Parameters

Parameter	In	Type	Required	Description
appId	path	string	true	Application ID
body	body	object	true	none
» id	body	string	true	Model ID
» provider	body	string	true	Service provider ID
» usage	body	string	true	none

Enumerated Values

Parameter	Value
» provider	GOOGLE_CLOUD
» provider	GOOGLE_AI_STUDIO
» provider	OPEN_AI
» provider	ELEVENLABS
» usage	transcription
» usage	translation
» usage	prompt
» usage	agent
» usage	chat
» usage	recognition

Responses

Overview

Status	Meaning	Description	Schema
200	OK	OK	string
400	Bad Request	Bad Request	Inline
401	Unauthorized	Unauthorized	Inline
403	Forbidden	Forbidden	Inline
404	Not Found	Not Found	Inline

Response Schema

Status Code 400

Bad Request

Name	Type	Required	Restrictions	Description
» code	number	false	none	none
» severity	string	false	none	none
» message	string	false	none	none
» errorCode	string	false	none	none

Status Code 401

Unauthorized

Name	Type	Required	Restrictions	Description
» code	number	false	none	none
» severity	string	false	none	none
» message	string	false	none	none
» errorCode	string	false	none	none

Status Code 403

Forbidden

Name	Type	Required	Restrictions	Description
» code	number	false	none	none
» severity	string	false	none	none
» message	string	false	none	none
» errorCode	string	false	none	none

Status Code 404

Not Found

Name	Type	Required	Restrictions	Description
» code	number	false	none	none
» severity	string	false	none	none
» message	string	false	none	none
» errorCode	string	false	none	none

Examples

200 Response

"string"

caution

To perform this operation, you must be authenticated by means of one of the following methods: bearerAuth

Code samples

Shell

curl -X POST /api/ai/{appId}/enabled/models \
  -H 'Content-Type: application/json' \  -H 'Accept: application/json' \  -H 'Authorization: Bearer {access-token}'

Go

package main

import (
    "bytes"
    "net/http"
)

func main() {
    headers := map[string][]string{ 
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
        "Authorization": []string{"Bearer {access-token}"},
    }

    var body []byte
    // body = ...

    req, err := http.NewRequest("POST", "/api/ai/{appId}/enabled/models", bytes.NewBuffer(body))
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

Node

const fetch = require('node-fetch');
const input = '{
  "id": "string",
  "provider": "GOOGLE_CLOUD",
  "usage": "transcription"
}';
const headers = {
  'Content-Type': 'application/json',  'Accept': 'application/json',  'Authorization': 'Bearer {access-token}'
}

fetch('/api/ai/{appId}/enabled/models', {
  method: 'POST',
  body: input,
  headers
})
.then(r => r.json())
.then((body) => {
    console.log(body)
})

Java

// This sample needs improvement.
URL obj = new URL("/api/ai/{appId}/enabled/models");

HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");

int responseCode = con.getResponseCode();

BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream())
);

String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();

System.out.println(response.toString());

Python

import requests

headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json',
  'Authorization': 'Bearer {access-token}'
}

r = requests.post(
  '/api/ai/{appId}/enabled/models',
  params={},
  headers = headers)

print r.json()

Ruby

require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.post '/api/ai/{appId}/enabled/models',
  params: {}, headers: headers

p JSON.parse(result)

Remove a model from the organization

DELETE /api/ai/{appId}/enabled/models/{id}/providers/{provider} HTTP/1.1
Accept: application/json

Parameters

Parameter	In	Type	Required	Description
usage	query	string	false	none
appId	path	string	true	Application ID
id	path	string	true	Model ID
provider	path	string	true	Provider ID

Enumerated Values

Parameter	Value
usage	transcription
usage	translation
usage	prompt
usage	agent
usage	recognition
provider	GOOGLE_CLOUD
provider	GOOGLE_AI_STUDIO
provider	OPEN_AI
provider	ELEVENLABS

Responses

Overview

Status	Meaning	Description	Schema
200	OK	OK	string
400	Bad Request	Bad Request	Inline
401	Unauthorized	Unauthorized	Inline
403	Forbidden	Forbidden	Inline

Response Schema

Status Code 400

Bad Request

Name	Type	Required	Restrictions	Description
» code	number	false	none	none
» severity	string	false	none	none
» message	string	false	none	none

Status Code 401

Unauthorized

Name	Type	Required	Restrictions	Description
» code	number	false	none	none
» severity	string	false	none	none
» message	string	false	none	none

Status Code 403

Forbidden

Name	Type	Required	Restrictions	Description
» code	number	false	none	none
» severity	string	false	none	none
» message	string	false	none	none

Examples

200 Response

"string"

caution

To perform this operation, you must be authenticated by means of one of the following methods: bearerAuth

Code samples

Shell

curl -X DELETE /api/ai/{appId}/enabled/models/{id}/providers/{provider} \
  -H 'Accept: application/json' \  -H 'Authorization: Bearer {access-token}'

Go

package main

import (
    "bytes"
    "net/http"
)

func main() {
    headers := map[string][]string{ 
        "Accept": []string{"application/json"},
        "Authorization": []string{"Bearer {access-token}"},
    }

    var body []byte
    // body = ...

    req, err := http.NewRequest("DELETE", "/api/ai/{appId}/enabled/models/{id}/providers/{provider}", bytes.NewBuffer(body))
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

Node

const fetch = require('node-fetch');

const headers = {
  'Accept': 'application/json',  'Authorization': 'Bearer {access-token}'
}

fetch('/api/ai/{appId}/enabled/models/{id}/providers/{provider}', {
  method: 'DELETE',
  headers
})
.then(r => r.json())
.then((body) => {
    console.log(body)
})

Java

// This sample needs improvement.
URL obj = new URL("/api/ai/{appId}/enabled/models/{id}/providers/{provider}");

HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("DELETE");

int responseCode = con.getResponseCode();

BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream())
);

String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();

System.out.println(response.toString());

Python

import requests

headers = {
  'Accept': 'application/json',
  'Authorization': 'Bearer {access-token}'
}

r = requests.delete(
  '/api/ai/{appId}/enabled/models/{id}/providers/{provider}',
  params={},
  headers = headers)

print r.json()

Ruby

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.delete '/api/ai/{appId}/enabled/models/{id}/providers/{provider}',
  params: {}, headers: headers

p JSON.parse(result)

prompts

Prompt an AI model

POST /api/ai/{appId}/conversations/{conversationId}/transcriptions/{transcriptionId}/prompts HTTP/1.1
Content-Type: application/json
Accept: application/json

Creates a new prompt task for a given conversation transcript

Request body

{
  "model": "string",
  "customPrompt": "string",
  "intent": "summary"
}

Parameters

Parameter	In	Type	Required	Description
appId	path	string	true	ID of the application
conversationId	path	string	true	ID of the conversation
transcriptionId	path	string	true	ID of the transcription
body	body	object	true	none
» model	body	string	false	ID of the sentiment model of any provider
» customPrompt	body	string	false	Custom prompt override for the intent
» intent	body	string	true	Intent for querying a model (use prompt for anything else).

Enumerated Values

Parameter	Value
» intent	summary
» intent	sentiment
» intent	prompt

Responses

Overview

Status	Meaning	Description	Schema
200	OK	Task Created Successfully	Inline
400	Bad Request	Bad Request	Inline
401	Unauthorized	Unauthorized	Inline
403	Forbidden	Forbidden	Inline
404	Not Found	Not Found	Inline

Response Schema

Status Code 200

Task Created Successfully

Name	Type	Required	Restrictions	Description
» conversationId	string	true	none	ID of the conversation
» id	string	true	none	ID of the analysis

Status Code 400

Bad Request

Name	Type	Required	Restrictions	Description
» statusCode	number	false	none	none
» error	string	false	none	none
» message	string	false	none	none

Status Code 401

Unauthorized

Name	Type	Required	Restrictions	Description
» statusCode	number	false	none	none
» error	string	false	none	none
» message	string	false	none	none

Status Code 403

Forbidden

Name	Type	Required	Restrictions	Description
» statusCode	number	false	none	none
» error	string	false	none	none
» message	string	false	none	none

Status Code 404

Not Found

Name	Type	Required	Restrictions	Description
» statusCode	number	false	none	none
» error	string	false	none	none
» message	string	false	none	none

Examples

200 Response

{
  "conversationId": "string",
  "id": "string"
}

caution

To perform this operation, you must be authenticated by means of one of the following methods: bearerAuth

Code samples

Shell

curl -X POST /api/ai/{appId}/conversations/{conversationId}/transcriptions/{transcriptionId}/prompts \
  -H 'Content-Type: application/json' \  -H 'Accept: application/json' \  -H 'Authorization: Bearer {access-token}'

Go

package main

import (
    "bytes"
    "net/http"
)

func main() {
    headers := map[string][]string{ 
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
        "Authorization": []string{"Bearer {access-token}"},
    }

    var body []byte
    // body = ...

    req, err := http.NewRequest("POST", "/api/ai/{appId}/conversations/{conversationId}/transcriptions/{transcriptionId}/prompts", bytes.NewBuffer(body))
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

Node

const fetch = require('node-fetch');
const input = '{
  "model": "string",
  "customPrompt": "string",
  "intent": "summary"
}';
const headers = {
  'Content-Type': 'application/json',  'Accept': 'application/json',  'Authorization': 'Bearer {access-token}'
}

fetch('/api/ai/{appId}/conversations/{conversationId}/transcriptions/{transcriptionId}/prompts', {
  method: 'POST',
  body: input,
  headers
})
.then(r => r.json())
.then((body) => {
    console.log(body)
})

Java

// This sample needs improvement.
URL obj = new URL("/api/ai/{appId}/conversations/{conversationId}/transcriptions/{transcriptionId}/prompts");

HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");

int responseCode = con.getResponseCode();

BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream())
);

String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();

System.out.println(response.toString());

Python

import requests

headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json',
  'Authorization': 'Bearer {access-token}'
}

r = requests.post(
  '/api/ai/{appId}/conversations/{conversationId}/transcriptions/{transcriptionId}/prompts',
  params={},
  headers = headers)

print r.json()

Ruby

require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.post '/api/ai/{appId}/conversations/{conversationId}/transcriptions/{transcriptionId}/prompts',
  params: {}, headers: headers

p JSON.parse(result)

Get all prompt tasks of a transcription

GET /api/ai/{appId}/conversations/{conversationId}/transcriptions/{transcriptionId}/prompts HTTP/1.1
Accept: application/json

Parameters

Parameter	In	Type	Required	Description
appId	path	string	true	ID of the application
conversationId	path	string	true	ID of the conversation
transcriptionId	path	string	true	ID of the transcription

Responses

Overview

Status	Meaning	Description	Schema
200	OK	Success	Inline
404	Not Found	Not found	Inline

Response Schema

Status Code 200

Success

Name	Type	Required	Restrictions	Description
» prompts	[object]	false	none	none
»» id	string	true	none	none
»» transcript	string	true	none	none
»» intent	string	false	none	none
»» state	string	true	none	none
»» createdAt	string(date-time)	true	none	none
»» updatedAt	string(date-time)	true	none	none

Enumerated Values

Property	Value
intent	summary
intent	sentiment
intent	prompt
state	SUBMITTED
state	RESUBMIT
state	PROCESSING
state	COMPLETED
state	FAILED

Status Code 404

Not found

Name	Type	Required	Restrictions	Description
» statusCode	number	false	none	none
» error	string	false	none	none
» message	string	false	none	none

Examples

200 Response

{
  "prompts": [
    {
      "id": "string",
      "transcript": "string",
      "intent": "summary",
      "state": "SUBMITTED",
      "createdAt": "2019-08-24T14:15:22Z",
      "updatedAt": "2019-08-24T14:15:22Z"
    }
  ]
}

caution

To perform this operation, you must be authenticated by means of one of the following methods: bearerAuth

Code samples

Shell

curl -X GET /api/ai/{appId}/conversations/{conversationId}/transcriptions/{transcriptionId}/prompts \
  -H 'Accept: application/json' \  -H 'Authorization: Bearer {access-token}'

Go

package main

import (
    "bytes"
    "net/http"
)

func main() {
    headers := map[string][]string{ 
        "Accept": []string{"application/json"},
        "Authorization": []string{"Bearer {access-token}"},
    }

    var body []byte
    // body = ...

    req, err := http.NewRequest("GET", "/api/ai/{appId}/conversations/{conversationId}/transcriptions/{transcriptionId}/prompts", bytes.NewBuffer(body))
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

Node

const fetch = require('node-fetch');

const headers = {
  'Accept': 'application/json',  'Authorization': 'Bearer {access-token}'
}

fetch('/api/ai/{appId}/conversations/{conversationId}/transcriptions/{transcriptionId}/prompts', {
  method: 'GET',
  headers
})
.then(r => r.json())
.then((body) => {
    console.log(body)
})

Java

// This sample needs improvement.
URL obj = new URL("/api/ai/{appId}/conversations/{conversationId}/transcriptions/{transcriptionId}/prompts");

HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");

int responseCode = con.getResponseCode();

BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream())
);

String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();

System.out.println(response.toString());

Python

import requests

headers = {
  'Accept': 'application/json',
  'Authorization': 'Bearer {access-token}'
}

r = requests.get(
  '/api/ai/{appId}/conversations/{conversationId}/transcriptions/{transcriptionId}/prompts',
  params={},
  headers = headers)

print r.json()

Ruby

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.get '/api/ai/{appId}/conversations/{conversationId}/transcriptions/{transcriptionId}/prompts',
  params: {}, headers: headers

p JSON.parse(result)

Get a prompt's task status

GET /api/ai/{appId}/conversations/{conversationId}/transcriptions/{transcriptionId}/prompts/{id} HTTP/1.1
Accept: application/json

Parameters

Parameter	In	Type	Required	Description
appId	path	string	true	ID of the application
conversationId	path	string	true	ID of the conversation
transcriptionId	path	string	true	ID of the transcription
id	path	string	true	ID of the analysis

Responses

Overview

Status	Meaning	Description	Schema
200	OK	Success	Inline
404	Not Found	Not found	Inline

Response Schema

Status Code 200

Success

Name	Type	Required	Restrictions	Description
» prompt	object	false	none	none
»» id	string	true	none	none
»» transcript	string	true	none	none
»» intent	string	false	none	none
»» state	string	true	none	none
»» createdAt	string(date-time)	true	none	none
»» updatedAt	string(date-time)	true	none	none

Enumerated Values

Property	Value
intent	summary
intent	sentiment
intent	prompt
state	SUBMITTED
state	RESUBMIT
state	PROCESSING
state	COMPLETED
state	FAILED

Status Code 404

Not found

Name	Type	Required	Restrictions	Description
» statusCode	number	false	none	none
» error	string	false	none	none
» message	string	false	none	none

Examples

200 Response

{
  "prompt": {
    "id": "string",
    "transcript": "string",
    "intent": "summary",
    "state": "SUBMITTED",
    "createdAt": "2019-08-24T14:15:22Z",
    "updatedAt": "2019-08-24T14:15:22Z"
  }
}

caution

To perform this operation, you must be authenticated by means of one of the following methods: bearerAuth

Code samples

Shell

curl -X GET /api/ai/{appId}/conversations/{conversationId}/transcriptions/{transcriptionId}/prompts/{id} \
  -H 'Accept: application/json' \  -H 'Authorization: Bearer {access-token}'

Go

package main

import (
    "bytes"
    "net/http"
)

func main() {
    headers := map[string][]string{ 
        "Accept": []string{"application/json"},
        "Authorization": []string{"Bearer {access-token}"},
    }

    var body []byte
    // body = ...

    req, err := http.NewRequest("GET", "/api/ai/{appId}/conversations/{conversationId}/transcriptions/{transcriptionId}/prompts/{id}", bytes.NewBuffer(body))
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

Node

const fetch = require('node-fetch');

const headers = {
  'Accept': 'application/json',  'Authorization': 'Bearer {access-token}'
}

fetch('/api/ai/{appId}/conversations/{conversationId}/transcriptions/{transcriptionId}/prompts/{id}', {
  method: 'GET',
  headers
})
.then(r => r.json())
.then((body) => {
    console.log(body)
})

Java

// This sample needs improvement.
URL obj = new URL("/api/ai/{appId}/conversations/{conversationId}/transcriptions/{transcriptionId}/prompts/{id}");

HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");

int responseCode = con.getResponseCode();

BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream())
);

String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();

System.out.println(response.toString());

Python

import requests

headers = {
  'Accept': 'application/json',
  'Authorization': 'Bearer {access-token}'
}

r = requests.get(
  '/api/ai/{appId}/conversations/{conversationId}/transcriptions/{transcriptionId}/prompts/{id}',
  params={},
  headers = headers)

print r.json()

Ruby

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.get '/api/ai/{appId}/conversations/{conversationId}/transcriptions/{transcriptionId}/prompts/{id}',
  params: {}, headers: headers

p JSON.parse(result)

Delete a prompt task status and any file saved

DELETE /api/ai/{appId}/conversations/{conversationId}/transcriptions/{transcriptionId}/prompts/{id} HTTP/1.1
Accept: application/json

Parameters

Parameter	In	Type	Required	Description
appId	path	string	true	ID of the application
conversationId	path	string	true	ID of the conversation
transcriptionId	path	string	true	ID of the transcription
id	path	string	true	ID of the analysis

Responses

Overview

Status	Meaning	Description	Schema
200	OK	Success	string
404	Not Found	Not found	Inline

Response Schema

Status Code 404

Not found

Name	Type	Required	Restrictions	Description
» statusCode	number	false	none	none
» error	string	false	none	none
» message	string	false	none	none

Examples

200 Response

"OK"

caution

To perform this operation, you must be authenticated by means of one of the following methods: bearerAuth

Code samples

Shell

curl -X DELETE /api/ai/{appId}/conversations/{conversationId}/transcriptions/{transcriptionId}/prompts/{id} \
  -H 'Accept: application/json' \  -H 'Authorization: Bearer {access-token}'

Go

package main

import (
    "bytes"
    "net/http"
)

func main() {
    headers := map[string][]string{ 
        "Accept": []string{"application/json"},
        "Authorization": []string{"Bearer {access-token}"},
    }

    var body []byte
    // body = ...

    req, err := http.NewRequest("DELETE", "/api/ai/{appId}/conversations/{conversationId}/transcriptions/{transcriptionId}/prompts/{id}", bytes.NewBuffer(body))
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

Node

const fetch = require('node-fetch');

const headers = {
  'Accept': 'application/json',  'Authorization': 'Bearer {access-token}'
}

fetch('/api/ai/{appId}/conversations/{conversationId}/transcriptions/{transcriptionId}/prompts/{id}', {
  method: 'DELETE',
  headers
})
.then(r => r.json())
.then((body) => {
    console.log(body)
})

Java

// This sample needs improvement.
URL obj = new URL("/api/ai/{appId}/conversations/{conversationId}/transcriptions/{transcriptionId}/prompts/{id}");

HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("DELETE");

int responseCode = con.getResponseCode();

BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream())
);

String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();

System.out.println(response.toString());

Python

import requests

headers = {
  'Accept': 'application/json',
  'Authorization': 'Bearer {access-token}'
}

r = requests.delete(
  '/api/ai/{appId}/conversations/{conversationId}/transcriptions/{transcriptionId}/prompts/{id}',
  params={},
  headers = headers)

print r.json()

Ruby

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.delete '/api/ai/{appId}/conversations/{conversationId}/transcriptions/{transcriptionId}/prompts/{id}',
  params: {}, headers: headers

p JSON.parse(result)

Get a prompt task result

GET /api/ai/{appId}/conversations/{conversationId}/transcriptions/{transcriptionId}/prompts/{id}/content HTTP/1.1
Accept: application/json

Get the result of prompting a model on a transcription

Parameters

Parameter	In	Type	Required	Description
appId	path	string	true	ID of the application
conversationId	path	string	true	ID of the conversation
transcriptionId	path	string	true	ID of the transcription
id	path	string	true	ID of the sentiment

Responses

Overview

Status	Meaning	Description	Schema
200	OK	Success	string
404	Not Found	Not found	Inline

Response Schema

Status Code 404

Not found

Name	Type	Required	Restrictions	Description
» statusCode	number	false	none	none
» error	string	false	none	none
» message	string	false	none	none

Examples

200 Response

"string"

caution

To perform this operation, you must be authenticated by means of one of the following methods: bearerAuth

Code samples

Shell

curl -X GET /api/ai/{appId}/conversations/{conversationId}/transcriptions/{transcriptionId}/prompts/{id}/content \
  -H 'Accept: application/json' \  -H 'Authorization: Bearer {access-token}'

Go

package main

import (
    "bytes"
    "net/http"
)

func main() {
    headers := map[string][]string{ 
        "Accept": []string{"application/json"},
        "Authorization": []string{"Bearer {access-token}"},
    }

    var body []byte
    // body = ...

    req, err := http.NewRequest("GET", "/api/ai/{appId}/conversations/{conversationId}/transcriptions/{transcriptionId}/prompts/{id}/content", bytes.NewBuffer(body))
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

Node

const fetch = require('node-fetch');

const headers = {
  'Accept': 'application/json',  'Authorization': 'Bearer {access-token}'
}

fetch('/api/ai/{appId}/conversations/{conversationId}/transcriptions/{transcriptionId}/prompts/{id}/content', {
  method: 'GET',
  headers
})
.then(r => r.json())
.then((body) => {
    console.log(body)
})

Java

// This sample needs improvement.
URL obj = new URL("/api/ai/{appId}/conversations/{conversationId}/transcriptions/{transcriptionId}/prompts/{id}/content");

HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");

int responseCode = con.getResponseCode();

BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream())
);

String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();

System.out.println(response.toString());

Python

import requests

headers = {
  'Accept': 'application/json',
  'Authorization': 'Bearer {access-token}'
}

r = requests.get(
  '/api/ai/{appId}/conversations/{conversationId}/transcriptions/{transcriptionId}/prompts/{id}/content',
  params={},
  headers = headers)

print r.json()

Ruby

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.get '/api/ai/{appId}/conversations/{conversationId}/transcriptions/{transcriptionId}/prompts/{id}/content',
  params: {}, headers: headers

p JSON.parse(result)

recognition

Create a new image recognition task

POST /api/ai/{appId}/vision/recognition HTTP/1.1
Content-Type: application/json
Accept: application/json

Query a vision model with custom prompt and an (base64) image

Request body

{
  "prompt": "string",
  "image_url": "string",
  "model": "string"
}

Parameters

Parameter	In	Type	Required	Description
appId	path	string	true	none
body	body	object	true	none
» prompt	body	string	false	Custom image recognition prompt
» image_url	body	string	true	Url or base64-encoded image
» model	body	string	false	Model ID of any provider

Responses

Overview

Status	Meaning	Description	Schema
200	OK	Recognition Task Created Successfully	Inline
400	Bad Request	Bad Request	Inline
401	Unauthorized	Unauthorized	Inline
403	Forbidden	Forbidden	Inline
404	Not Found	Not Found	Inline

Response Schema

Status Code 200

Recognition Task Created Successfully

Name	Type	Required	Restrictions	Description
» id	string	true	none	ID of the task

Status Code 400

Bad Request

Name	Type	Required	Restrictions	Description
» statusCode	number	false	none	none
» error	string	false	none	none
» message	string	false	none	none

Status Code 401

Unauthorized

Name	Type	Required	Restrictions	Description
» statusCode	number	false	none	none
» error	string	false	none	none
» message	string	false	none	none

Status Code 403

Forbidden

Name	Type	Required	Restrictions	Description
» statusCode	number	false	none	none
» error	string	false	none	none
» message	string	false	none	none

Status Code 404

Not Found

Name	Type	Required	Restrictions	Description
» statusCode	number	false	none	none
» error	string	false	none	none
» message	string	false	none	none

Examples

200 Response

{
  "id": "string"
}

caution

To perform this operation, you must be authenticated by means of one of the following methods: bearerAuth

Code samples

Shell

curl -X POST /api/ai/{appId}/vision/recognition \
  -H 'Content-Type: application/json' \  -H 'Accept: application/json' \  -H 'Authorization: Bearer {access-token}'

Go

package main

import (
    "bytes"
    "net/http"
)

func main() {
    headers := map[string][]string{ 
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
        "Authorization": []string{"Bearer {access-token}"},
    }

    var body []byte
    // body = ...

    req, err := http.NewRequest("POST", "/api/ai/{appId}/vision/recognition", bytes.NewBuffer(body))
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

Node

const fetch = require('node-fetch');
const input = '{
  "prompt": "string",
  "image_url": "string",
  "model": "string"
}';
const headers = {
  'Content-Type': 'application/json',  'Accept': 'application/json',  'Authorization': 'Bearer {access-token}'
}

fetch('/api/ai/{appId}/vision/recognition', {
  method: 'POST',
  body: input,
  headers
})
.then(r => r.json())
.then((body) => {
    console.log(body)
})

Java

// This sample needs improvement.
URL obj = new URL("/api/ai/{appId}/vision/recognition");

HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");

int responseCode = con.getResponseCode();

BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream())
);

String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();

System.out.println(response.toString());

Python

import requests

headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json',
  'Authorization': 'Bearer {access-token}'
}

r = requests.post(
  '/api/ai/{appId}/vision/recognition',
  params={},
  headers = headers)

print r.json()

Ruby

require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.post '/api/ai/{appId}/vision/recognition',
  params: {}, headers: headers

p JSON.parse(result)

live

Create a new live session

POST /api/ai/{appId}/live HTTP/1.1
Content-Type: application/json
Accept: application/json

Creates a new live AI session

Request body

{
  "modality": "text",
  "auviousEnvironment": "string",
  "languageCode": "string",
  "username": "string",
  "voice": "alloy",
  "endpoint": "string",
  "promptContext": "string",
  "userLocalTime": "string",
  "liveToolOverrides": {
    "property1": true,
    "property2": true
  }
}

Parameters

Parameter	In	Type	Required	Description
appId	path	string	true	none
body	body	object	true	none
» modality	body	string	true	none
» auviousEnvironment	body	string	false	none
» languageCode	body	string	false	none
» username	body	string	false	The name to be addressed by the AI
» voice	body	string	false	Optional TTS voice name for audio sessions.
» endpoint	body	string	false	none
» promptContext	body	string	false	none
» userLocalTime	body	string	false	none
» liveToolOverrides	body	object	false	Optional map of live tool names to booleans overriding app live tool configuration for this session.
»» additionalProperties	body	boolean	false	none

Enumerated Values

Parameter	Value
» modality	text
» modality	audio
» voice	alloy
» voice	ash
» voice	ballad
» voice	coral
» voice	echo
» voice	sage
» voice	shimmer
» voice	verse
» voice	marin
» voice	cedar
» voice	Achernar
» voice	Achird
» voice	Algenib
» voice	Algieba
» voice	Alnilam
» voice	Aoede
» voice	Autonoe
» voice	Callirrhoe
» voice	Charon
» voice	Despina
» voice	Enceladus
» voice	Erinome
» voice	Fenrir
» voice	Gacrux
» voice	Iapetus
» voice	Kore
» voice	Laomedeia
» voice	Leda
» voice	Orus
» voice	Pulcherrima
» voice	Puck
» voice	Rasalgethi
» voice	Sadachbia
» voice	Sadaltager
» voice	Schedar
» voice	Sulafat
» voice	Umbriel
» voice	Vindemiatrix
» voice	Zephyr
» voice	Zubenelgenubi

Responses

Overview

Status	Meaning	Description	Schema
200	OK	Successful response	Inline
400	Bad Request	Bad request	string

Response Schema

Status Code 200

Successful response

Name	Type	Required	Restrictions	Description
» id	string	false	none	none

Examples

200 Response

{
  "id": "string"
}

caution

To perform this operation, you must be authenticated by means of one of the following methods: bearerAuth

Code samples

Shell

curl -X POST /api/ai/{appId}/live \
  -H 'Content-Type: application/json' \  -H 'Accept: application/json' \  -H 'Authorization: Bearer {access-token}'

Go

package main

import (
    "bytes"
    "net/http"
)

func main() {
    headers := map[string][]string{ 
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
        "Authorization": []string{"Bearer {access-token}"},
    }

    var body []byte
    // body = ...

    req, err := http.NewRequest("POST", "/api/ai/{appId}/live", bytes.NewBuffer(body))
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

Node

const fetch = require('node-fetch');
const input = '{
  "modality": "text",
  "auviousEnvironment": "string",
  "languageCode": "string",
  "username": "string",
  "voice": "alloy",
  "endpoint": "string",
  "promptContext": "string",
  "userLocalTime": "string",
  "liveToolOverrides": {
    "property1": true,
    "property2": true
  }
}';
const headers = {
  'Content-Type': 'application/json',  'Accept': 'application/json',  'Authorization': 'Bearer {access-token}'
}

fetch('/api/ai/{appId}/live', {
  method: 'POST',
  body: input,
  headers
})
.then(r => r.json())
.then((body) => {
    console.log(body)
})

Java

// This sample needs improvement.
URL obj = new URL("/api/ai/{appId}/live");

HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");

int responseCode = con.getResponseCode();

BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream())
);

String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();

System.out.println(response.toString());

Python

import requests

headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json',
  'Authorization': 'Bearer {access-token}'
}

r = requests.post(
  '/api/ai/{appId}/live',
  params={},
  headers = headers)

print r.json()

Ruby

require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.post '/api/ai/{appId}/live',
  params: {}, headers: headers

p JSON.parse(result)

Create a new conference

POST /api/ai/{appId}/conference HTTP/1.1
Content-Type: application/json
Accept: application/json

Creates a new conference to later join a session with AI

Request body

{
  "username": "string",
  "endpoint": "string",
  "user": "string"
}

Parameters

Parameter	In	Type	Required	Description
appId	path	string	true	none
body	body	object	true	none
» username	body	string	false	none
» endpoint	body	string	true	none
» user	body	string	true	none

Responses

Overview

Status	Meaning	Description	Schema
200	OK	Successful response	Inline

Response Schema

Status Code 200

Successful response

Name	Type	Required	Restrictions	Description
» conferenceId	string	false	none	none
» ticket	string	false	none	none

Examples

200 Response

{
  "conferenceId": "string",
  "ticket": "string"
}

caution

To perform this operation, you must be authenticated by means of one of the following methods: bearerAuth

Code samples

Shell

curl -X POST /api/ai/{appId}/conference \
  -H 'Content-Type: application/json' \  -H 'Accept: application/json' \  -H 'Authorization: Bearer {access-token}'

Go

package main

import (
    "bytes"
    "net/http"
)

func main() {
    headers := map[string][]string{ 
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
        "Authorization": []string{"Bearer {access-token}"},
    }

    var body []byte
    // body = ...

    req, err := http.NewRequest("POST", "/api/ai/{appId}/conference", bytes.NewBuffer(body))
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

Node

const fetch = require('node-fetch');
const input = '{
  "username": "string",
  "endpoint": "string",
  "user": "string"
}';
const headers = {
  'Content-Type': 'application/json',  'Accept': 'application/json',  'Authorization': 'Bearer {access-token}'
}

fetch('/api/ai/{appId}/conference', {
  method: 'POST',
  body: input,
  headers
})
.then(r => r.json())
.then((body) => {
    console.log(body)
})

Java

// This sample needs improvement.
URL obj = new URL("/api/ai/{appId}/conference");

HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");

int responseCode = con.getResponseCode();

BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream())
);

String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();

System.out.println(response.toString());

Python

import requests

headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json',
  'Authorization': 'Bearer {access-token}'
}

r = requests.post(
  '/api/ai/{appId}/conference',
  params={},
  headers = headers)

print r.json()

Ruby

require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.post '/api/ai/{appId}/conference',
  params: {}, headers: headers

p JSON.parse(result)

Delete a live session

DELETE /api/ai/{appId}/live/{id} HTTP/1.1
Accept: application/json

Deletes an existing live AI session

Parameters

Parameter	In	Type	Required	Description
appId	path	string	true	Application ID
id	path	string	true	Live session ID

Responses

Overview

Status	Meaning	Description	Schema
200	OK	OK	string

Examples

200 Response

"string"

caution

To perform this operation, you must be authenticated by means of one of the following methods: bearerAuth

Code samples

Shell

curl -X DELETE /api/ai/{appId}/live/{id} \
  -H 'Accept: application/json' \  -H 'Authorization: Bearer {access-token}'

Go

package main

import (
    "bytes"
    "net/http"
)

func main() {
    headers := map[string][]string{ 
        "Accept": []string{"application/json"},
        "Authorization": []string{"Bearer {access-token}"},
    }

    var body []byte
    // body = ...

    req, err := http.NewRequest("DELETE", "/api/ai/{appId}/live/{id}", bytes.NewBuffer(body))
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

Node

const fetch = require('node-fetch');

const headers = {
  'Accept': 'application/json',  'Authorization': 'Bearer {access-token}'
}

fetch('/api/ai/{appId}/live/{id}', {
  method: 'DELETE',
  headers
})
.then(r => r.json())
.then((body) => {
    console.log(body)
})

Java

// This sample needs improvement.
URL obj = new URL("/api/ai/{appId}/live/{id}");

HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("DELETE");

int responseCode = con.getResponseCode();

BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream())
);

String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();

System.out.println(response.toString());

Python

import requests

headers = {
  'Accept': 'application/json',
  'Authorization': 'Bearer {access-token}'
}

r = requests.delete(
  '/api/ai/{appId}/live/{id}',
  params={},
  headers = headers)

print r.json()

Ruby

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.delete '/api/ai/{appId}/live/{id}',
  params: {}, headers: headers

p JSON.parse(result)

Escalate live session

POST /api/ai/{appId}/live/{id}/escalate HTTP/1.1
Content-Type: application/json
Accept: application/json

Escalates a live session to realtime mode, optionally with a different AI provider.

Request body

{
  "provider": "OPEN_AI",
  "voice": "string",
  "liveToolOverrides": {
    "property1": true,
    "property2": true
  }
}

Parameters

Parameter	In	Type	Required	Description
appId	path	string	true	Application ID
id	path	string	true	Live session ID
body	body	object	true	none
» provider	body	string	false	Optional AI provider to use for escalation.
» voice	body	string	false	Optional voice to use for escalated live session.
» liveToolOverrides	body	object	false	Optional map of live tool names to booleans overriding app configuration.
»» additionalProperties	body	boolean	false	none

Enumerated Values

Parameter	Value
» provider	OPEN_AI
» provider	GOOGLE_CLOUD
» provider	GOOGLE_AI_STUDIO
» provider	ELEVENLABS

Responses

Overview

Status	Meaning	Description	Schema
200	OK	Escalation result	Inline

Response Schema

Status Code 200

Escalation result

Name	Type	Required	Restrictions	Description
» escalated	boolean	true	none	none

Examples

200 Response

{
  "escalated": true
}

caution

To perform this operation, you must be authenticated by means of one of the following methods: bearerAuth

Code samples

Shell

curl -X POST /api/ai/{appId}/live/{id}/escalate \
  -H 'Content-Type: application/json' \  -H 'Accept: application/json' \  -H 'Authorization: Bearer {access-token}'

Go

package main

import (
    "bytes"
    "net/http"
)

func main() {
    headers := map[string][]string{ 
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
        "Authorization": []string{"Bearer {access-token}"},
    }

    var body []byte
    // body = ...

    req, err := http.NewRequest("POST", "/api/ai/{appId}/live/{id}/escalate", bytes.NewBuffer(body))
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

Node

const fetch = require('node-fetch');
const input = '{
  "provider": "OPEN_AI",
  "voice": "string",
  "liveToolOverrides": {
    "property1": true,
    "property2": true
  }
}';
const headers = {
  'Content-Type': 'application/json',  'Accept': 'application/json',  'Authorization': 'Bearer {access-token}'
}

fetch('/api/ai/{appId}/live/{id}/escalate', {
  method: 'POST',
  body: input,
  headers
})
.then(r => r.json())
.then((body) => {
    console.log(body)
})

Java

// This sample needs improvement.
URL obj = new URL("/api/ai/{appId}/live/{id}/escalate");

HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");

int responseCode = con.getResponseCode();

BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream())
);

String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();

System.out.println(response.toString());

Python

import requests

headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json',
  'Authorization': 'Bearer {access-token}'
}

r = requests.post(
  '/api/ai/{appId}/live/{id}/escalate',
  params={},
  headers = headers)

print r.json()

Ruby

require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.post '/api/ai/{appId}/live/{id}/escalate',
  params: {}, headers: headers

p JSON.parse(result)

Deescalate live session

DELETE /api/ai/{appId}/live/{id}/escalate HTTP/1.1
Accept: application/json

Stops realtime escalation and routes all future operations back through chat conversation.

Parameters

Parameter	In	Type	Required	Description
appId	path	string	true	Application ID
id	path	string	true	Live session ID

Responses

Overview

Status	Meaning	Description	Schema
200	OK	Deescalation result	Inline

Response Schema

Status Code 200

Deescalation result

Name	Type	Required	Restrictions	Description
» deescalated	boolean	true	none	none

Examples

200 Response

{
  "deescalated": true
}

caution

To perform this operation, you must be authenticated by means of one of the following methods: bearerAuth

Code samples

Shell

curl -X DELETE /api/ai/{appId}/live/{id}/escalate \
  -H 'Accept: application/json' \  -H 'Authorization: Bearer {access-token}'

Go

package main

import (
    "bytes"
    "net/http"
)

func main() {
    headers := map[string][]string{ 
        "Accept": []string{"application/json"},
        "Authorization": []string{"Bearer {access-token}"},
    }

    var body []byte
    // body = ...

    req, err := http.NewRequest("DELETE", "/api/ai/{appId}/live/{id}/escalate", bytes.NewBuffer(body))
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

Node

const fetch = require('node-fetch');

const headers = {
  'Accept': 'application/json',  'Authorization': 'Bearer {access-token}'
}

fetch('/api/ai/{appId}/live/{id}/escalate', {
  method: 'DELETE',
  headers
})
.then(r => r.json())
.then((body) => {
    console.log(body)
})

Java

// This sample needs improvement.
URL obj = new URL("/api/ai/{appId}/live/{id}/escalate");

HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("DELETE");

int responseCode = con.getResponseCode();

BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream())
);

String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();

System.out.println(response.toString());

Python

import requests

headers = {
  'Accept': 'application/json',
  'Authorization': 'Bearer {access-token}'
}

r = requests.delete(
  '/api/ai/{appId}/live/{id}/escalate',
  params={},
  headers = headers)

print r.json()

Ruby

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.delete '/api/ai/{appId}/live/{id}/escalate',
  params: {}, headers: headers

p JSON.parse(result)

Join a live session with conference

POST /api/ai/{appId}/live/{id}/join/{conferenceId} HTTP/1.1
Accept: application/json

Joins an existing live AI session with a specific conference

Parameters

Parameter	In	Type	Required	Description
appId	path	string	true	Application ID
id	path	string	true	Live session ID
conferenceId	path	string	true	Conference ID

Responses

Overview

Status	Meaning	Description	Schema
200	OK	OK	string
204	No Content	Already joined the requested conference	string

Examples

200 Response

"string"

caution

To perform this operation, you must be authenticated by means of one of the following methods: bearerAuth

Code samples

Shell

curl -X POST /api/ai/{appId}/live/{id}/join/{conferenceId} \
  -H 'Accept: application/json' \  -H 'Authorization: Bearer {access-token}'

Go

package main

import (
    "bytes"
    "net/http"
)

func main() {
    headers := map[string][]string{ 
        "Accept": []string{"application/json"},
        "Authorization": []string{"Bearer {access-token}"},
    }

    var body []byte
    // body = ...

    req, err := http.NewRequest("POST", "/api/ai/{appId}/live/{id}/join/{conferenceId}", bytes.NewBuffer(body))
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

Node

const fetch = require('node-fetch');

const headers = {
  'Accept': 'application/json',  'Authorization': 'Bearer {access-token}'
}

fetch('/api/ai/{appId}/live/{id}/join/{conferenceId}', {
  method: 'POST',
  headers
})
.then(r => r.json())
.then((body) => {
    console.log(body)
})

Java

// This sample needs improvement.
URL obj = new URL("/api/ai/{appId}/live/{id}/join/{conferenceId}");

HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");

int responseCode = con.getResponseCode();

BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream())
);

String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();

System.out.println(response.toString());

Python

import requests

headers = {
  'Accept': 'application/json',
  'Authorization': 'Bearer {access-token}'
}

r = requests.post(
  '/api/ai/{appId}/live/{id}/join/{conferenceId}',
  params={},
  headers = headers)

print r.json()

Ruby

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.post '/api/ai/{appId}/live/{id}/join/{conferenceId}',
  params: {}, headers: headers

p JSON.parse(result)

Route audio stream

POST /api/ai/{appId}/live/{id}/audio/{streamId} HTTP/1.1
Accept: application/json

Routes audio stream from an endpoint to a live session

Parameters

Parameter	In	Type	Required	Description
appId	path	string	true	Application ID
id	path	string	true	Live session ID
streamId	path	string	true	Audio stream ID to route

Responses

Overview

Status	Meaning	Description	Schema
200	OK	OK	string

Examples

200 Response

"string"

caution

To perform this operation, you must be authenticated by means of one of the following methods: bearerAuth

Code samples

Shell

curl -X POST /api/ai/{appId}/live/{id}/audio/{streamId} \
  -H 'Accept: application/json' \  -H 'Authorization: Bearer {access-token}'

Go

package main

import (
    "bytes"
    "net/http"
)

func main() {
    headers := map[string][]string{ 
        "Accept": []string{"application/json"},
        "Authorization": []string{"Bearer {access-token}"},
    }

    var body []byte
    // body = ...

    req, err := http.NewRequest("POST", "/api/ai/{appId}/live/{id}/audio/{streamId}", bytes.NewBuffer(body))
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

Node

const fetch = require('node-fetch');

const headers = {
  'Accept': 'application/json',  'Authorization': 'Bearer {access-token}'
}

fetch('/api/ai/{appId}/live/{id}/audio/{streamId}', {
  method: 'POST',
  headers
})
.then(r => r.json())
.then((body) => {
    console.log(body)
})

Java

// This sample needs improvement.
URL obj = new URL("/api/ai/{appId}/live/{id}/audio/{streamId}");

HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");

int responseCode = con.getResponseCode();

BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream())
);

String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();

System.out.println(response.toString());

Python

import requests

headers = {
  'Accept': 'application/json',
  'Authorization': 'Bearer {access-token}'
}

r = requests.post(
  '/api/ai/{appId}/live/{id}/audio/{streamId}',
  params={},
  headers = headers)

print r.json()

Ruby

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.post '/api/ai/{appId}/live/{id}/audio/{streamId}',
  params: {}, headers: headers

p JSON.parse(result)

Disconnect audio stream

DELETE /api/ai/{appId}/live/{id}/audio/{streamId} HTTP/1.1
Accept: application/json

Disconnects audio stream from an endpoint in a live session

Parameters

Parameter	In	Type	Required	Description
appId	path	string	true	Application ID
id	path	string	true	Live session ID
streamId	path	string	true	Audio stream ID to route

Responses

Overview

Status	Meaning	Description	Schema
200	OK	OK	string
204	No Content	No audio track was active	string

Examples

200 Response

"string"

caution

To perform this operation, you must be authenticated by means of one of the following methods: bearerAuth

Code samples

Shell

curl -X DELETE /api/ai/{appId}/live/{id}/audio/{streamId} \
  -H 'Accept: application/json' \  -H 'Authorization: Bearer {access-token}'

Go

package main

import (
    "bytes"
    "net/http"
)

func main() {
    headers := map[string][]string{ 
        "Accept": []string{"application/json"},
        "Authorization": []string{"Bearer {access-token}"},
    }

    var body []byte
    // body = ...

    req, err := http.NewRequest("DELETE", "/api/ai/{appId}/live/{id}/audio/{streamId}", bytes.NewBuffer(body))
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

Node

const fetch = require('node-fetch');

const headers = {
  'Accept': 'application/json',  'Authorization': 'Bearer {access-token}'
}

fetch('/api/ai/{appId}/live/{id}/audio/{streamId}', {
  method: 'DELETE',
  headers
})
.then(r => r.json())
.then((body) => {
    console.log(body)
})

Java

// This sample needs improvement.
URL obj = new URL("/api/ai/{appId}/live/{id}/audio/{streamId}");

HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("DELETE");

int responseCode = con.getResponseCode();

BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream())
);

String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();

System.out.println(response.toString());

Python

import requests

headers = {
  'Accept': 'application/json',
  'Authorization': 'Bearer {access-token}'
}

r = requests.delete(
  '/api/ai/{appId}/live/{id}/audio/{streamId}',
  params={},
  headers = headers)

print r.json()

Ruby

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.delete '/api/ai/{appId}/live/{id}/audio/{streamId}',
  params: {}, headers: headers

p JSON.parse(result)

Route video stream

POST /api/ai/{appId}/live/{id}/video/{streamId} HTTP/1.1
Accept: application/json

Routes video stream from an endpoint to a live session

Parameters

Parameter	In	Type	Required	Description
appId	path	string	true	Application ID
id	path	string	true	Live session ID
streamId	path	string	true	Video stream ID to route

Responses

Overview

Status	Meaning	Description	Schema
200	OK	OK	string

Examples

200 Response

"string"

caution

To perform this operation, you must be authenticated by means of one of the following methods: bearerAuth

Code samples

Shell

curl -X POST /api/ai/{appId}/live/{id}/video/{streamId} \
  -H 'Accept: application/json' \  -H 'Authorization: Bearer {access-token}'

Go

package main

import (
    "bytes"
    "net/http"
)

func main() {
    headers := map[string][]string{ 
        "Accept": []string{"application/json"},
        "Authorization": []string{"Bearer {access-token}"},
    }

    var body []byte
    // body = ...

    req, err := http.NewRequest("POST", "/api/ai/{appId}/live/{id}/video/{streamId}", bytes.NewBuffer(body))
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

Node

const fetch = require('node-fetch');

const headers = {
  'Accept': 'application/json',  'Authorization': 'Bearer {access-token}'
}

fetch('/api/ai/{appId}/live/{id}/video/{streamId}', {
  method: 'POST',
  headers
})
.then(r => r.json())
.then((body) => {
    console.log(body)
})

Java

// This sample needs improvement.
URL obj = new URL("/api/ai/{appId}/live/{id}/video/{streamId}");

HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");

int responseCode = con.getResponseCode();

BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream())
);

String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();

System.out.println(response.toString());

Python

import requests

headers = {
  'Accept': 'application/json',
  'Authorization': 'Bearer {access-token}'
}

r = requests.post(
  '/api/ai/{appId}/live/{id}/video/{streamId}',
  params={},
  headers = headers)

print r.json()

Ruby

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.post '/api/ai/{appId}/live/{id}/video/{streamId}',
  params: {}, headers: headers

p JSON.parse(result)

Disconnect video stream

DELETE /api/ai/{appId}/live/{id}/video/{streamId} HTTP/1.1
Accept: application/json

Disconnects video stream from an endpoint in a live session

Parameters

Parameter	In	Type	Required	Description
appId	path	string	true	Application ID
id	path	string	true	Live session ID
streamId	path	string	true	Video stream ID to route

Responses

Overview

Status	Meaning	Description	Schema
200	OK	OK	string
204	No Content	No video track was active	string

Examples

200 Response

"string"

caution

To perform this operation, you must be authenticated by means of one of the following methods: bearerAuth

Code samples

Shell

curl -X DELETE /api/ai/{appId}/live/{id}/video/{streamId} \
  -H 'Accept: application/json' \  -H 'Authorization: Bearer {access-token}'

Go

package main

import (
    "bytes"
    "net/http"
)

func main() {
    headers := map[string][]string{ 
        "Accept": []string{"application/json"},
        "Authorization": []string{"Bearer {access-token}"},
    }

    var body []byte
    // body = ...

    req, err := http.NewRequest("DELETE", "/api/ai/{appId}/live/{id}/video/{streamId}", bytes.NewBuffer(body))
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

Node

const fetch = require('node-fetch');

const headers = {
  'Accept': 'application/json',  'Authorization': 'Bearer {access-token}'
}

fetch('/api/ai/{appId}/live/{id}/video/{streamId}', {
  method: 'DELETE',
  headers
})
.then(r => r.json())
.then((body) => {
    console.log(body)
})

Java

// This sample needs improvement.
URL obj = new URL("/api/ai/{appId}/live/{id}/video/{streamId}");

HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("DELETE");

int responseCode = con.getResponseCode();

BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream())
);

String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();

System.out.println(response.toString());

Python

import requests

headers = {
  'Accept': 'application/json',
  'Authorization': 'Bearer {access-token}'
}

r = requests.delete(
  '/api/ai/{appId}/live/{id}/video/{streamId}',
  params={},
  headers = headers)

print r.json()

Ruby

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.delete '/api/ai/{appId}/live/{id}/video/{streamId}',
  params: {}, headers: headers

p JSON.parse(result)

Post text content

POST /api/ai/{appId}/live/{id}/text HTTP/1.1
Content-Type: application/json
Accept: application/json

Posts text content from an endpoint to a live session

Request body

{
  "message": "string"
}

Parameters

Parameter	In	Type	Required	Description
appId	path	string	true	Application ID
id	path	string	true	none
body	body	object	true	none
» message	body	string	true	none

Responses

Overview

Status	Meaning	Description	Schema
200	OK	OK	string

Examples

200 Response

"string"

caution

To perform this operation, you must be authenticated by means of one of the following methods: bearerAuth

Code samples

Shell

curl -X POST /api/ai/{appId}/live/{id}/text \
  -H 'Content-Type: application/json' \  -H 'Accept: application/json' \  -H 'Authorization: Bearer {access-token}'

Go

package main

import (
    "bytes"
    "net/http"
)

func main() {
    headers := map[string][]string{ 
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
        "Authorization": []string{"Bearer {access-token}"},
    }

    var body []byte
    // body = ...

    req, err := http.NewRequest("POST", "/api/ai/{appId}/live/{id}/text", bytes.NewBuffer(body))
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

Node

const fetch = require('node-fetch');
const input = '{
  "message": "string"
}';
const headers = {
  'Content-Type': 'application/json',  'Accept': 'application/json',  'Authorization': 'Bearer {access-token}'
}

fetch('/api/ai/{appId}/live/{id}/text', {
  method: 'POST',
  body: input,
  headers
})
.then(r => r.json())
.then((body) => {
    console.log(body)
})

Java

// This sample needs improvement.
URL obj = new URL("/api/ai/{appId}/live/{id}/text");

HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");

int responseCode = con.getResponseCode();

BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream())
);

String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();

System.out.println(response.toString());

Python

import requests

headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json',
  'Authorization': 'Bearer {access-token}'
}

r = requests.post(
  '/api/ai/{appId}/live/{id}/text',
  params={},
  headers = headers)

print r.json()

Ruby

require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.post '/api/ai/{appId}/live/{id}/text',
  params: {}, headers: headers

p JSON.parse(result)

Return tool response

POST /api/ai/{appId}/live/{id}/tool-response HTTP/1.1
Content-Type: application/json
Accept: application/json

The result of an earlier tool call or error

Request body

{
  "name": "string",
  "response": null,
  "error": "string"
}

Parameters

Parameter	In	Type	Required	Description
appId	path	string	true	Application ID
id	path	string	true	none
body	body	object	true	none
» name	body	string	true	The original name of the tool
» response	body	any	false	The result of the tool call - can be any type
» error	body	string	false	none

Responses

Overview

Status	Meaning	Description	Schema
200	OK	OK	Inline

Response Schema

Status Code 200

OK

Name	Type	Required	Restrictions	Description

Examples

200 Response

{}

caution

To perform this operation, you must be authenticated by means of one of the following methods: bearerAuth

Code samples

Shell

curl -X POST /api/ai/{appId}/live/{id}/tool-response \
  -H 'Content-Type: application/json' \  -H 'Accept: application/json' \  -H 'Authorization: Bearer {access-token}'

Go

package main

import (
    "bytes"
    "net/http"
)

func main() {
    headers := map[string][]string{ 
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
        "Authorization": []string{"Bearer {access-token}"},
    }

    var body []byte
    // body = ...

    req, err := http.NewRequest("POST", "/api/ai/{appId}/live/{id}/tool-response", bytes.NewBuffer(body))
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

Node

const fetch = require('node-fetch');
const input = '{
  "name": "string",
  "response": null,
  "error": "string"
}';
const headers = {
  'Content-Type': 'application/json',  'Accept': 'application/json',  'Authorization': 'Bearer {access-token}'
}

fetch('/api/ai/{appId}/live/{id}/tool-response', {
  method: 'POST',
  body: input,
  headers
})
.then(r => r.json())
.then((body) => {
    console.log(body)
})

Java

// This sample needs improvement.
URL obj = new URL("/api/ai/{appId}/live/{id}/tool-response");

HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");

int responseCode = con.getResponseCode();

BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream())
);

String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();

System.out.println(response.toString());

Python

import requests

headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json',
  'Authorization': 'Bearer {access-token}'
}

r = requests.post(
  '/api/ai/{appId}/live/{id}/tool-response',
  params={},
  headers = headers)

print r.json()

Ruby

require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.post '/api/ai/{appId}/live/{id}/tool-response',
  params: {}, headers: headers

p JSON.parse(result)

Schemas

AppErrorCode

"APPLICATION_NOT_FOUND"

*Application error codes.

• APPLICATION_NOT_FOUND: Application not found.
• CREATE_LIVE_SESSION: Failed to create live session.
• AI_PROVIDER_SESSION_ERROR: AI provider session error.
• AI_PROVIDER_SERVICE_UNAVAILABLE: AI provider service unavailable.
• AI_PROVIDER_MODEL_NOT_FOUND: AI provider model not found.
• AI_PROVIDER_LANGUAGE_CODE_INVALID: AI selected language code is invalid.
• AI_PROVIDER_ORG_NOT_FOUND: AI provider organization not found.
• AI_PROVIDER_GENERAL_ERROR: AI provider general error.
• STORAGE_CONFIGURATION_MISSING: Storage is not configured correctly: provider name, key or bucket is missing.*

Properties

Name	Type	Required	Restrictions	Description
anonymous	string	false	none	Application error codes. - APPLICATION_NOT_FOUND: Application not found. - CREATE_LIVE_SESSION: Failed to create live session. - AI_PROVIDER_SESSION_ERROR: AI provider session error. - AI_PROVIDER_SERVICE_UNAVAILABLE: AI provider service unavailable. - AI_PROVIDER_MODEL_NOT_FOUND: AI provider model not found. - AI_PROVIDER_LANGUAGE_CODE_INVALID: AI selected language code is invalid. - AI_PROVIDER_ORG_NOT_FOUND: AI provider organization not found. - AI_PROVIDER_GENERAL_ERROR: AI provider general error. - STORAGE_CONFIGURATION_MISSING: Storage is not configured correctly: provider name, key or bucket is missing.

Enumerated Values

Property	Value
anonymous	APPLICATION_NOT_FOUND
anonymous	CREATE_LIVE_SESSION
anonymous	AI_PROVIDER_SESSION_ERROR
anonymous	AI_PROVIDER_SERVICE_UNAVAILABLE
anonymous	AI_PROVIDER_MODEL_NOT_FOUND
anonymous	AI_PROVIDER_LANGUAGE_CODE_INVALID
anonymous	AI_PROVIDER_ORG_NOT_FOUND
anonymous	AI_PROVIDER_GENERAL_ERROR
anonymous	STORAGE_CONFIGURATION_MISSING

AppError

{
  "code": 0,
  "severity": "DEFAULT",
  "message": "string",
  "errorCode": "APPLICATION_NOT_FOUND"
}

Properties

Name	Type	Required	Restrictions	Description
code	number	true	none	HTTP status code.
severity	string	true	none	none
message	string	true	none	none
errorCode	AppErrorCode	false	none	Application error codes. - APPLICATION_NOT_FOUND: Application not found. - CREATE_LIVE_SESSION: Failed to create live session. - AI_PROVIDER_SESSION_ERROR: AI provider session error. - AI_PROVIDER_SERVICE_UNAVAILABLE: AI provider service unavailable. - AI_PROVIDER_MODEL_NOT_FOUND: AI provider model not found. - AI_PROVIDER_LANGUAGE_CODE_INVALID: AI selected language code is invalid. - AI_PROVIDER_ORG_NOT_FOUND: AI provider organization not found. - AI_PROVIDER_GENERAL_ERROR: AI provider general error. - STORAGE_CONFIGURATION_MISSING: Storage is not configured correctly: provider name, key or bucket is missing.

Enumerated Values

Property	Value
severity	DEFAULT
severity	DEBUG
severity	INFO
severity	NOTICE
severity	WARNING
severity	ERROR
severity	CRITICAL
severity	ALERT
severity	EMERGENCY

AppErrorCatalog

[
  {
    "errorCode": "APPLICATION_NOT_FOUND",
    "message": "Application not found."
  },
  {
    "errorCode": "CREATE_LIVE_SESSION",
    "message": "Failed to create live session."
  },
  {
    "errorCode": "AI_PROVIDER_SESSION_ERROR",
    "message": "AI provider session error."
  },
  {
    "errorCode": "AI_PROVIDER_SERVICE_UNAVAILABLE",
    "message": "AI provider service unavailable."
  },
  {
    "errorCode": "AI_PROVIDER_MODEL_NOT_FOUND",
    "message": "AI provider model not found."
  },
  {
    "errorCode": "AI_PROVIDER_LANGUAGE_CODE_INVALID",
    "message": "AI selected language code is invalid."
  },
  {
    "errorCode": "AI_PROVIDER_ORG_NOT_FOUND",
    "message": "AI provider organization not found."
  },
  {
    "errorCode": "AI_PROVIDER_GENERAL_ERROR",
    "message": "AI provider general error."
  },
  {
    "errorCode": "STORAGE_CONFIGURATION_MISSING",
    "message": "Storage is not configured correctly: provider name, key or bucket is missing."
  }
]

Application-level errors and their public messages.

Properties

Name	Type	Required	Restrictions	Description
errorCode	AppErrorCode	true	none	Application error codes. - APPLICATION_NOT_FOUND: Application not found. - CREATE_LIVE_SESSION: Failed to create live session. - AI_PROVIDER_SESSION_ERROR: AI provider session error. - AI_PROVIDER_SERVICE_UNAVAILABLE: AI provider service unavailable. - AI_PROVIDER_MODEL_NOT_FOUND: AI provider model not found. - AI_PROVIDER_LANGUAGE_CODE_INVALID: AI selected language code is invalid. - AI_PROVIDER_ORG_NOT_FOUND: AI provider organization not found. - AI_PROVIDER_GENERAL_ERROR: AI provider general error. - STORAGE_CONFIGURATION_MISSING: Storage is not configured correctly: provider name, key or bucket is missing.
message	string	true	none	none

ToolRequestSchedule

{
  "id": "string",
  "name": "scheduleVideoCallPanel",
  "arguments": null,
  "response": "string"
}

Opens the scheduling interface to book a video call with an available live agent

Properties

Name	Type	Required	Restrictions	Description
id	string	false	none	none
name	string	true	none	none
arguments	any	false	none	none
response	string	false	none	ISO date string or empty

ToolRequestQuickReplies

{
  "id": "string",
  "name": "suggestQuickReplies",
  "arguments": {
    "replies": [
      "string"
    ]
  },
  "response": "string"
}

Generates clickable quick reply buttons that MUST be extracted from the previous message for faster user responses

Properties

Name	Type	Required	Restrictions	Description
id	string	false	none	none
name	string	true	none	none
arguments	object	false	none	none
» replies	[string]	false	none	An small list of suggested quick actions that advance or redirect the conversation flow, avoiding passive responses
response	string	false	none	The quick reply itself

MQTT_EVENT

{
  "type": "ASROfflineTranscriptCreatedEvent",
  "timestamp": "2019-08-24T14:15:22Z",
  "id": "string"
}

Properties

Name	Type	Required	Restrictions	Description
type	string	true	none	none
timestamp	string(date-time)	true	none	none
id	string	true	none	none

Enumerated Values

Property	Value
type	ASROfflineTranscriptCreatedEvent
type	ASROfflineTranscriptProcessingEvent
type	ASROfflineTranscriptFailedEvent
type	ASROfflineTranslationCreatedEvent
type	ASROfflineTranslationProcessingEvent
type	ASROfflineTranslationFailedEvent
type	AIPromptCreatedEvent
type	AIPromptProcessingEvent
type	AIPromptFailedEvent
type	AIRecognitionCreatedEvent
type	AIRecognitionProcessingEvent
type	AIRecognitionFailedEvent
type	AILiveCreatedEvent
type	AILiveEndedEvent
type	AILiveFailedEvent
type	AILiveResponseEvent
type	AILiveStreamConnectedEvent
type	AILiveStreamDisconnectedEvent
type	AIToolEvent
type	AIToolCancellationEvent