Auvious Composition API v1.0

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

API Key (apiKey)
- Parameter Name: Authorization, in: header.

Composition Command Service

Cancel a running Composition

POST http://auvious.video/composition/api/{conversationId}/{compositionId}/cancel HTTP/1.1
Host: auvious.video
Accept: */*

Supported roles (AGENT, SUPERVISOR)

Parameters

Parameter	In	Type	Required	Description
conversationId	path	string	true	none
compositionId	path	string	true	none

Responses

Overview

Status	Meaning	Description	Schema
200	OK	OK	Inline

Response Schema

Examples

caution

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

Code samples

curl -X POST http://auvious.video/composition/api/{conversationId}/{compositionId}/cancel \
  -H 'Accept: */*' \  -H 'Authorization: API_KEY'

package main

import (
    "bytes"
    "net/http"
)

func main() {
    headers := map[string][]string{ 
        "Accept": []string{"*/*"},
        "Authorization": []string{"API_KEY"},
    }

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

    req, err := http.NewRequest("POST", "http://auvious.video/composition/api/{conversationId}/{compositionId}/cancel", bytes.NewBuffer(body))
    req.Header = headers

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

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

const headers = {
  'Accept': '*/*',  'Authorization': 'API_KEY'
}

fetch('http://auvious.video/composition/api/{conversationId}/{compositionId}/cancel', {
  method: 'POST',
  headers
})
.then(r => r.json())
.then((body) => {
    console.log(body)
})

// This sample needs improvement.
URL obj = new URL("http://auvious.video/composition/api/{conversationId}/{compositionId}/cancel");

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());

import requests

headers = {
  'Accept': '*/*',
  'Authorization': 'API_KEY'
}

r = requests.post(
  'http://auvious.video/composition/api/{conversationId}/{compositionId}/cancel',
  params={},
  headers = headers)

print r.json()

require 'rest-client'
require 'json'

headers = {
  'Accept' => '*/*',
  'Authorization' => 'API_KEY'
}

result = RestClient.post 'http://auvious.video/composition/api/{conversationId}/{compositionId}/cancel',
  params: {}, headers: headers

p JSON.parse(result)

Create a new Composition

POST http://auvious.video/composition/api/request HTTP/1.1
Host: auvious.video
Content-Type: application/json
Accept: application/json

Supported roles (AGENT, SUPERVISOR, SERVICE)

Request body

{
  "conversationId": "string",
  "type": "VIDEO",
  "layout": "GRID",
  "name": "string",
  "videoFormat": "MP4",
  "audioFormat": "MP3",
  "resolution": "320x240",
  "priority": "0",
  "audioBitrateKbps": "48",
  "screenShareWidth": "640",
  "participantResolution": "320x240"
}

Parameters

Parameter	In	Type	Required	Description
body	body	CreateCompositionWebCommand	true	none

Responses

Overview

Status	Meaning	Description	Schema
200	OK	OK	CompositionIdentifier

Examples

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

caution

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

Code samples

curl -X POST http://auvious.video/composition/api/request \
  -H 'Content-Type: application/json' \  -H 'Accept: application/json' \  -H 'Authorization: API_KEY'

package main

import (
    "bytes"
    "net/http"
)

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

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

    req, err := http.NewRequest("POST", "http://auvious.video/composition/api/request", bytes.NewBuffer(body))
    req.Header = headers

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

const fetch = require('node-fetch');
const input = '{
  "conversationId": "string",
  "type": "VIDEO",
  "layout": "GRID",
  "name": "string",
  "videoFormat": "MP4",
  "audioFormat": "MP3",
  "resolution": "320x240",
  "priority": "0",
  "audioBitrateKbps": "48",
  "screenShareWidth": "640",
  "participantResolution": "320x240"
}';
const headers = {
  'Content-Type': 'application/json',  'Accept': 'application/json',  'Authorization': 'API_KEY'
}

fetch('http://auvious.video/composition/api/request', {
  method: 'POST',
  body: input,
  headers
})
.then(r => r.json())
.then((body) => {
    console.log(body)
})

// This sample needs improvement.
URL obj = new URL("http://auvious.video/composition/api/request");

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());

import requests

headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json',
  'Authorization': 'API_KEY'
}

r = requests.post(
  'http://auvious.video/composition/api/request',
  params={},
  headers = headers)

print r.json()

require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json',
  'Authorization' => 'API_KEY'
}

result = RestClient.post 'http://auvious.video/composition/api/request',
  params: {}, headers: headers

p JSON.parse(result)

Re-execute a previously completed composition

POST http://auvious.video/composition/api/reexecute HTTP/1.1
Host: auvious.video
Content-Type: application/json
Accept: application/json

Supported roles (AGENT, SUPERVISOR)

Request body

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

Parameters

Parameter	In	Type	Required	Description
body	body	ReExecuteCompositionWebCommand	true	none

Responses

Overview

Status	Meaning	Description	Schema
200	OK	OK	CompositionIdentifier

Examples

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

caution

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

Code samples

curl -X POST http://auvious.video/composition/api/reexecute \
  -H 'Content-Type: application/json' \  -H 'Accept: application/json' \  -H 'Authorization: API_KEY'

package main

import (
    "bytes"
    "net/http"
)

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

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

    req, err := http.NewRequest("POST", "http://auvious.video/composition/api/reexecute", bytes.NewBuffer(body))
    req.Header = headers

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

const fetch = require('node-fetch');
const input = '{
  "id": "string",
  "conversationId": "string",
  "priority": "1"
}';
const headers = {
  'Content-Type': 'application/json',  'Accept': 'application/json',  'Authorization': 'API_KEY'
}

fetch('http://auvious.video/composition/api/reexecute', {
  method: 'POST',
  body: input,
  headers
})
.then(r => r.json())
.then((body) => {
    console.log(body)
})

// This sample needs improvement.
URL obj = new URL("http://auvious.video/composition/api/reexecute");

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());

import requests

headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json',
  'Authorization': 'API_KEY'
}

r = requests.post(
  'http://auvious.video/composition/api/reexecute',
  params={},
  headers = headers)

print r.json()

require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json',
  'Authorization' => 'API_KEY'
}

result = RestClient.post 'http://auvious.video/composition/api/reexecute',
  params: {}, headers: headers

p JSON.parse(result)

Delete existing Composition

DELETE http://auvious.video/composition/api/{conversationId}/{compositionId}/delete HTTP/1.1
Host: auvious.video
Accept: */*

Supported roles (SUPERVISOR)

Parameters

Parameter	In	Type	Required	Description
conversationId	path	string	true	none
compositionId	path	string	true	none

Responses

Overview

Status	Meaning	Description	Schema
200	OK	OK	Inline

Response Schema

Examples

caution

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

Code samples

curl -X DELETE http://auvious.video/composition/api/{conversationId}/{compositionId}/delete \
  -H 'Accept: */*' \  -H 'Authorization: API_KEY'

package main

import (
    "bytes"
    "net/http"
)

func main() {
    headers := map[string][]string{ 
        "Accept": []string{"*/*"},
        "Authorization": []string{"API_KEY"},
    }

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

    req, err := http.NewRequest("DELETE", "http://auvious.video/composition/api/{conversationId}/{compositionId}/delete", bytes.NewBuffer(body))
    req.Header = headers

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

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

const headers = {
  'Accept': '*/*',  'Authorization': 'API_KEY'
}

fetch('http://auvious.video/composition/api/{conversationId}/{compositionId}/delete', {
  method: 'DELETE',
  headers
})
.then(r => r.json())
.then((body) => {
    console.log(body)
})

// This sample needs improvement.
URL obj = new URL("http://auvious.video/composition/api/{conversationId}/{compositionId}/delete");

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());

import requests

headers = {
  'Accept': '*/*',
  'Authorization': 'API_KEY'
}

r = requests.delete(
  'http://auvious.video/composition/api/{conversationId}/{compositionId}/delete',
  params={},
  headers = headers)

print r.json()

require 'rest-client'
require 'json'

headers = {
  'Accept' => '*/*',
  'Authorization' => 'API_KEY'
}

result = RestClient.delete 'http://auvious.video/composition/api/{conversationId}/{compositionId}/delete',
  params: {}, headers: headers

p JSON.parse(result)

Composition Query Service

Get recording data and associated composition by conversationId

GET http://auvious.video/composition/api/query/conversation/{conversationId} HTTP/1.1
Host: auvious.video
Accept: application/json

Supported roles (AGENT, SUPERVISOR)

Parameters

Parameter	In	Type	Required	Description
conversationId	path	string	true	none

Responses

Overview

Status	Meaning	Description	Schema
200	OK	OK	CompositionMessage

Examples

{
  "recordingMetadata": {
    "conversationId": "string",
    "audio": true,
    "video": true,
    "started": "string",
    "stopped": "string",
    "duration": "string",
    "totalParticipants": 0,
    "canExportVideo": true,
    "canExportAudio": true,
    "agentId": "string",
    "organizationId": "string"
  },
  "compositions": [
    {
      "id": "string",
      "conversationId": "string",
      "userId": "string",
      "state": "string",
      "type": "string",
      "created": "string",
      "completed": "string",
      "name": "string",
      "format": "string",
      "layout": "GRID",
      "duration": "string",
      "ffmpegVersion": "string"
    }
  ]
}

caution

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

Code samples

curl -X GET http://auvious.video/composition/api/query/conversation/{conversationId} \
  -H 'Accept: application/json' \  -H 'Authorization: API_KEY'

package main

import (
    "bytes"
    "net/http"
)

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

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

    req, err := http.NewRequest("GET", "http://auvious.video/composition/api/query/conversation/{conversationId}", bytes.NewBuffer(body))
    req.Header = headers

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

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

const headers = {
  'Accept': 'application/json',  'Authorization': 'API_KEY'
}

fetch('http://auvious.video/composition/api/query/conversation/{conversationId}', {
  method: 'GET',
  headers
})
.then(r => r.json())
.then((body) => {
    console.log(body)
})

// This sample needs improvement.
URL obj = new URL("http://auvious.video/composition/api/query/conversation/{conversationId}");

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());

import requests

headers = {
  'Accept': 'application/json',
  'Authorization': 'API_KEY'
}

r = requests.get(
  'http://auvious.video/composition/api/query/conversation/{conversationId}',
  params={},
  headers = headers)

print r.json()

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'Authorization' => 'API_KEY'
}

result = RestClient.get 'http://auvious.video/composition/api/query/conversation/{conversationId}',
  params: {}, headers: headers

p JSON.parse(result)

Get all compositions initiated by the currently authenticated user

GET http://auvious.video/composition/api/query/composition?pageable=page,0,size,1,sort,string HTTP/1.1
Host: auvious.video
Accept: application/json

Supported roles (AGENT, SUPERVISOR)

Parameters

Parameter	In	Type	Required	Description
pageable	query	Pageable	true	none

Responses

Overview

Status	Meaning	Description	Schema
200	OK	OK	PageCompositionView

Examples

{
  "totalPages": 0,
  "totalElements": 0,
  "pageable": {
    "paged": true,
    "pageNumber": 0,
    "pageSize": 0,
    "offset": 0,
    "sort": {
      "sorted": true,
      "empty": true,
      "unsorted": true
    },
    "unpaged": true
  },
  "size": 0,
  "content": [
    {
      "id": "string",
      "conversationId": "string",
      "userId": "string",
      "state": "string",
      "type": "string",
      "created": "string",
      "completed": "string",
      "name": "string",
      "format": "string",
      "layout": "GRID",
      "duration": "string",
      "ffmpegVersion": "string"
    }
  ],
  "number": 0,
  "sort": {
    "sorted": true,
    "empty": true,
    "unsorted": true
  },
  "first": true,
  "last": true,
  "numberOfElements": 0,
  "empty": true
}

caution

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

Code samples

curl -X GET http://auvious.video/composition/api/query/composition?pageable=page,0,size,1,sort,string \
  -H 'Accept: application/json' \  -H 'Authorization: API_KEY'

package main

import (
    "bytes"
    "net/http"
)

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

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

    req, err := http.NewRequest("GET", "http://auvious.video/composition/api/query/composition", bytes.NewBuffer(body))
    req.Header = headers

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

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

const headers = {
  'Accept': 'application/json',  'Authorization': 'API_KEY'
}

fetch('http://auvious.video/composition/api/query/composition?pageable=page,0,size,1,sort,string', {
  method: 'GET',
  headers
})
.then(r => r.json())
.then((body) => {
    console.log(body)
})

// This sample needs improvement.
URL obj = new URL("http://auvious.video/composition/api/query/composition?pageable=page,0,size,1,sort,string");

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());

import requests

headers = {
  'Accept': 'application/json',
  'Authorization': 'API_KEY'
}

r = requests.get(
  'http://auvious.video/composition/api/query/composition',
  params={
    'pageable': {
  "page": 0,
  "size": 1,
  "sort": [
    "string"
  ]
}},
  headers = headers)

print r.json()

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'Authorization' => 'API_KEY'
}

result = RestClient.get 'http://auvious.video/composition/api/query/composition',
  params: {
    'pageable' => '[Pageable](#schemapageable)'}, headers: headers

p JSON.parse(result)

Get a composition by compositionId

GET http://auvious.video/composition/api/query/composition/{compositionId} HTTP/1.1
Host: auvious.video
Accept: application/json

Supported roles (AGENT, SUPERVISOR). Agents can access their own compositions within the tenant; supervisors can access any tenant composition.

Parameters

Parameter	In	Type	Required	Description
compositionId	path	string	true	none

Responses

Overview

Status	Meaning	Description	Schema
200	OK	OK	CompositionView

Examples

{
  "id": "string",
  "conversationId": "string",
  "userId": "string",
  "state": "string",
  "type": "string",
  "created": "string",
  "completed": "string",
  "name": "string",
  "format": "string",
  "layout": "GRID",
  "duration": "string",
  "ffmpegVersion": "string"
}

caution

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

Code samples

curl -X GET http://auvious.video/composition/api/query/composition/{compositionId} \
  -H 'Accept: application/json' \  -H 'Authorization: API_KEY'

package main

import (
    "bytes"
    "net/http"
)

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

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

    req, err := http.NewRequest("GET", "http://auvious.video/composition/api/query/composition/{compositionId}", bytes.NewBuffer(body))
    req.Header = headers

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

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

const headers = {
  'Accept': 'application/json',  'Authorization': 'API_KEY'
}

fetch('http://auvious.video/composition/api/query/composition/{compositionId}', {
  method: 'GET',
  headers
})
.then(r => r.json())
.then((body) => {
    console.log(body)
})

// This sample needs improvement.
URL obj = new URL("http://auvious.video/composition/api/query/composition/{compositionId}");

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());

import requests

headers = {
  'Accept': 'application/json',
  'Authorization': 'API_KEY'
}

r = requests.get(
  'http://auvious.video/composition/api/query/composition/{compositionId}',
  params={},
  headers = headers)

print r.json()

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'Authorization' => 'API_KEY'
}

result = RestClient.get 'http://auvious.video/composition/api/query/composition/{compositionId}',
  params: {}, headers: headers

p JSON.parse(result)

Composition Media Player

Get a signed URL to play a media file by conversation id and composition Id

GET http://auvious.video/composition/api/player/{conversationId}/{compositionId}/url/inline HTTP/1.1
Host: auvious.video
Accept: */*
Referer: string

Supported roles (AGENT, SUPERVISOR)

Parameters

Parameter	In	Type	Required	Description
conversationId	path	string	true	none
compositionId	path	string	true	none
Referer	header	string	true	none

Responses

Overview

Status	Meaning	Description	Schema
200	OK	OK	CompositionResourceMessage

Examples

caution

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

Code samples

curl -X GET http://auvious.video/composition/api/player/{conversationId}/{compositionId}/url/inline \
  -H 'Accept: */*' \  -H 'Referer: string' \  -H 'Authorization: API_KEY'

package main

import (
    "bytes"
    "net/http"
)

func main() {
    headers := map[string][]string{ 
        "Accept": []string{"*/*"},
        "Referer": []string{"string"},
        "Authorization": []string{"API_KEY"},
    }

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

    req, err := http.NewRequest("GET", "http://auvious.video/composition/api/player/{conversationId}/{compositionId}/url/inline", bytes.NewBuffer(body))
    req.Header = headers

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

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

const headers = {
  'Accept': '*/*',  'Referer': 'string',  'Authorization': 'API_KEY'
}

fetch('http://auvious.video/composition/api/player/{conversationId}/{compositionId}/url/inline', {
  method: 'GET',
  headers
})
.then(r => r.json())
.then((body) => {
    console.log(body)
})

// This sample needs improvement.
URL obj = new URL("http://auvious.video/composition/api/player/{conversationId}/{compositionId}/url/inline");

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());

import requests

headers = {
  'Accept': '*/*',
  'Referer': 'string',
  'Authorization': 'API_KEY'
}

r = requests.get(
  'http://auvious.video/composition/api/player/{conversationId}/{compositionId}/url/inline',
  params={},
  headers = headers)

print r.json()

require 'rest-client'
require 'json'

headers = {
  'Accept' => '*/*',
  'Referer' => 'string',
  'Authorization' => 'API_KEY'
}

result = RestClient.get 'http://auvious.video/composition/api/player/{conversationId}/{compositionId}/url/inline',
  params: {}, headers: headers

p JSON.parse(result)

Get a signed URL to download a media file by conversation id and composition Id

GET http://auvious.video/composition/api/player/{conversationId}/{compositionId}/url/attachment HTTP/1.1
Host: auvious.video
Accept: */*
Referer: string

Supported roles (AGENT, SUPERVISOR)

Parameters

Parameter	In	Type	Required	Description
conversationId	path	string	true	none
compositionId	path	string	true	none
Referer	header	string	true	none

Responses

Overview

Status	Meaning	Description	Schema
200	OK	OK	CompositionResourceMessage

Examples

caution

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

Code samples

curl -X GET http://auvious.video/composition/api/player/{conversationId}/{compositionId}/url/attachment \
  -H 'Accept: */*' \  -H 'Referer: string' \  -H 'Authorization: API_KEY'

package main

import (
    "bytes"
    "net/http"
)

func main() {
    headers := map[string][]string{ 
        "Accept": []string{"*/*"},
        "Referer": []string{"string"},
        "Authorization": []string{"API_KEY"},
    }

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

    req, err := http.NewRequest("GET", "http://auvious.video/composition/api/player/{conversationId}/{compositionId}/url/attachment", bytes.NewBuffer(body))
    req.Header = headers

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

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

const headers = {
  'Accept': '*/*',  'Referer': 'string',  'Authorization': 'API_KEY'
}

fetch('http://auvious.video/composition/api/player/{conversationId}/{compositionId}/url/attachment', {
  method: 'GET',
  headers
})
.then(r => r.json())
.then((body) => {
    console.log(body)
})

// This sample needs improvement.
URL obj = new URL("http://auvious.video/composition/api/player/{conversationId}/{compositionId}/url/attachment");

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());

import requests

headers = {
  'Accept': '*/*',
  'Referer': 'string',
  'Authorization': 'API_KEY'
}

r = requests.get(
  'http://auvious.video/composition/api/player/{conversationId}/{compositionId}/url/attachment',
  params={},
  headers = headers)

print r.json()

require 'rest-client'
require 'json'

headers = {
  'Accept' => '*/*',
  'Referer' => 'string',
  'Authorization' => 'API_KEY'
}

result = RestClient.get 'http://auvious.video/composition/api/player/{conversationId}/{compositionId}/url/attachment',
  params: {}, headers: headers

p JSON.parse(result)

getInline

GET http://auvious.video/composition/api/player/inline/{conversationId}/{compositionId}/{fileName}?Date=string&Expires=string&Signature=string HTTP/1.1
Host: auvious.video
Accept: */*
Range: string

Parameters

Parameter	In	Type	Required	Description
conversationId	path	string	true	none
compositionId	path	string	true	none
fileName	path	string	true	none
Date	query	string	true	none
Expires	query	string	true	none
Signature	query	string	true	none
Range	header	string	false	none

Responses

Overview

Status	Meaning	Description	Schema
200	OK	OK	string

Examples

caution

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

Code samples

curl -X GET http://auvious.video/composition/api/player/inline/{conversationId}/{compositionId}/{fileName}?Date=string&Expires=string&Signature=string \
  -H 'Accept: */*' \  -H 'Range: string' \  -H 'Authorization: API_KEY'

package main

import (
    "bytes"
    "net/http"
)

func main() {
    headers := map[string][]string{ 
        "Accept": []string{"*/*"},
        "Range": []string{"string"},
        "Authorization": []string{"API_KEY"},
    }

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

    req, err := http.NewRequest("GET", "http://auvious.video/composition/api/player/inline/{conversationId}/{compositionId}/{fileName}", bytes.NewBuffer(body))
    req.Header = headers

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

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

const headers = {
  'Accept': '*/*',  'Range': 'string',  'Authorization': 'API_KEY'
}

fetch('http://auvious.video/composition/api/player/inline/{conversationId}/{compositionId}/{fileName}?Date=string&Expires=string&Signature=string', {
  method: 'GET',
  headers
})
.then(r => r.json())
.then((body) => {
    console.log(body)
})

// This sample needs improvement.
URL obj = new URL("http://auvious.video/composition/api/player/inline/{conversationId}/{compositionId}/{fileName}?Date=string&Expires=string&Signature=string");

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());

import requests

headers = {
  'Accept': '*/*',
  'Range': 'string',
  'Authorization': 'API_KEY'
}

r = requests.get(
  'http://auvious.video/composition/api/player/inline/{conversationId}/{compositionId}/{fileName}',
  params={
    'Date': 'string',
    'Expires': 'string',
    'Signature': 'string'},
  headers = headers)

print r.json()

require 'rest-client'
require 'json'

headers = {
  'Accept' => '*/*',
  'Range' => 'string',
  'Authorization' => 'API_KEY'
}

result = RestClient.get 'http://auvious.video/composition/api/player/inline/{conversationId}/{compositionId}/{fileName}',
  params: {
    'Date' => 'string',
    'Expires' => 'string',
    'Signature' => 'string'}, headers: headers

p JSON.parse(result)

getAttachment

GET http://auvious.video/composition/api/player/attachment/{conversationId}/{compositionId}/{fileName}?Date=string&Expires=string&Signature=string HTTP/1.1
Host: auvious.video
Accept: */*
Range: string

Parameters

Parameter	In	Type	Required	Description
conversationId	path	string	true	none
compositionId	path	string	true	none
fileName	path	string	true	none
Date	query	string	true	none
Expires	query	string	true	none
Signature	query	string	true	none
Range	header	string	false	none

Responses

Overview

Status	Meaning	Description	Schema
200	OK	OK	string

Examples

caution

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

Code samples

curl -X GET http://auvious.video/composition/api/player/attachment/{conversationId}/{compositionId}/{fileName}?Date=string&Expires=string&Signature=string \
  -H 'Accept: */*' \  -H 'Range: string' \  -H 'Authorization: API_KEY'

package main

import (
    "bytes"
    "net/http"
)

func main() {
    headers := map[string][]string{ 
        "Accept": []string{"*/*"},
        "Range": []string{"string"},
        "Authorization": []string{"API_KEY"},
    }

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

    req, err := http.NewRequest("GET", "http://auvious.video/composition/api/player/attachment/{conversationId}/{compositionId}/{fileName}", bytes.NewBuffer(body))
    req.Header = headers

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

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

const headers = {
  'Accept': '*/*',  'Range': 'string',  'Authorization': 'API_KEY'
}

fetch('http://auvious.video/composition/api/player/attachment/{conversationId}/{compositionId}/{fileName}?Date=string&Expires=string&Signature=string', {
  method: 'GET',
  headers
})
.then(r => r.json())
.then((body) => {
    console.log(body)
})

// This sample needs improvement.
URL obj = new URL("http://auvious.video/composition/api/player/attachment/{conversationId}/{compositionId}/{fileName}?Date=string&Expires=string&Signature=string");

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());

import requests

headers = {
  'Accept': '*/*',
  'Range': 'string',
  'Authorization': 'API_KEY'
}

r = requests.get(
  'http://auvious.video/composition/api/player/attachment/{conversationId}/{compositionId}/{fileName}',
  params={
    'Date': 'string',
    'Expires': 'string',
    'Signature': 'string'},
  headers = headers)

print r.json()

require 'rest-client'
require 'json'

headers = {
  'Accept' => '*/*',
  'Range' => 'string',
  'Authorization' => 'API_KEY'
}

result = RestClient.get 'http://auvious.video/composition/api/player/attachment/{conversationId}/{compositionId}/{fileName}',
  params: {
    'Date' => 'string',
    'Expires' => 'string',
    'Signature' => 'string'}, headers: headers

p JSON.parse(result)

Schemas

CreateCompositionWebCommand

{
  "conversationId": "string",
  "type": "VIDEO",
  "layout": "GRID",
  "name": "string",
  "videoFormat": "MP4",
  "audioFormat": "MP3",
  "resolution": "320x240",
  "priority": "0",
  "audioBitrateKbps": "48",
  "screenShareWidth": "640",
  "participantResolution": "320x240"
}

Properties

Name	Type	Required	Restrictions	Description
conversationId	string	true	none	none
type	string	true	none	none
layout	string	false	none	Default value: GRID
name	string	true	none	none
videoFormat	string	false	none	Default value: MP4
audioFormat	string	false	none	Default value: MP3
resolution	string	false	none	Deprecated compatibility metadata. Use participantResolution for structured rendering.
priority	integer(int32)	false	none	0 (Low priority), 1 (Normal priority), 2 (High priority). Default value: 1
audioBitrateKbps	integer(int32)	false	none	Structured audio bitrate in kbps. Default value: 96
screenShareWidth	integer(int32)	false	none	Structured screen-share canvas width. Default value: 1280
participantResolution	string	false	none	Structured participant tile resolution. Default value: 320x240

Enumerated Values

Property	Value
type	VIDEO
type	AUDIO
layout	GRID
videoFormat	MP4
audioFormat	MP3
resolution	320x240
priority	0
priority	1
priority	2
audioBitrateKbps	48
audioBitrateKbps	64
audioBitrateKbps	96
audioBitrateKbps	128
screenShareWidth	640
screenShareWidth	960
screenShareWidth	1280
participantResolution	320x240
participantResolution	640x480

CompositionIdentifier

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

Properties

Name	Type	Required	Restrictions	Description
id	string	true	none	none
conversationId	string	true	none	none

ReExecuteCompositionWebCommand

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

Properties

Name	Type	Required	Restrictions	Description
id	string	true	none	none
conversationId	string	true	none	none
priority	string	false	none	1 (Normal priority), 2 (High priority)

Enumerated Values

Property	Value
priority	1
priority	2

ComposedRecordingDataMessage

{
  "conversationId": "string",
  "audio": true,
  "video": true,
  "started": "string",
  "stopped": "string",
  "duration": "string",
  "totalParticipants": 0,
  "canExportVideo": true,
  "canExportAudio": true,
  "agentId": "string",
  "organizationId": "string"
}

Properties

Name	Type	Required	Restrictions	Description
conversationId	string	false	none	none
audio	boolean	false	none	none
video	boolean	false	none	none
started	string	false	none	none
stopped	string	false	none	none
duration	string	false	none	none
totalParticipants	integer(int32)	false	none	none
canExportVideo	boolean	false	none	none
canExportAudio	boolean	false	none	none
agentId	string	false	none	none
organizationId	string	false	none	none

CompositionMessage

{
  "recordingMetadata": {
    "conversationId": "string",
    "audio": true,
    "video": true,
    "started": "string",
    "stopped": "string",
    "duration": "string",
    "totalParticipants": 0,
    "canExportVideo": true,
    "canExportAudio": true,
    "agentId": "string",
    "organizationId": "string"
  },
  "compositions": [
    {
      "id": "string",
      "conversationId": "string",
      "userId": "string",
      "state": "string",
      "type": "string",
      "created": "string",
      "completed": "string",
      "name": "string",
      "format": "string",
      "layout": "GRID",
      "duration": "string",
      "ffmpegVersion": "string"
    }
  ]
}

Properties

Name	Type	Required	Restrictions	Description
recordingMetadata	ComposedRecordingDataMessage	false	none	none
compositions	[CompositionView]	false	none	none

CompositionView

{
  "id": "string",
  "conversationId": "string",
  "userId": "string",
  "state": "string",
  "type": "string",
  "created": "string",
  "completed": "string",
  "name": "string",
  "format": "string",
  "layout": "GRID",
  "duration": "string",
  "ffmpegVersion": "string"
}

Properties

Name	Type	Required	Restrictions	Description
id	string	false	none	none
conversationId	string	false	none	none
userId	string	false	none	none
state	string	false	none	none
type	string	false	none	none
created	string	false	none	none
completed	string	false	none	none
name	string	false	none	none
format	string	false	none	none
layout	string	false	none	none
duration	string	false	none	none
ffmpegVersion	string	false	none	none

Enumerated Values

Property	Value
layout	GRID

Pageable

{
  "page": 0,
  "size": 1,
  "sort": [
    "string"
  ]
}

Properties

Name	Type	Required	Restrictions	Description
page	integer(int32)	false	none	none
size	integer(int32)	false	none	none
sort	[string]	false	none	none

PageCompositionView

{
  "totalPages": 0,
  "totalElements": 0,
  "pageable": {
    "paged": true,
    "pageNumber": 0,
    "pageSize": 0,
    "offset": 0,
    "sort": {
      "sorted": true,
      "empty": true,
      "unsorted": true
    },
    "unpaged": true
  },
  "size": 0,
  "content": [
    {
      "id": "string",
      "conversationId": "string",
      "userId": "string",
      "state": "string",
      "type": "string",
      "created": "string",
      "completed": "string",
      "name": "string",
      "format": "string",
      "layout": "GRID",
      "duration": "string",
      "ffmpegVersion": "string"
    }
  ],
  "number": 0,
  "sort": {
    "sorted": true,
    "empty": true,
    "unsorted": true
  },
  "first": true,
  "last": true,
  "numberOfElements": 0,
  "empty": true
}

Properties

Name	Type	Required	Restrictions	Description
totalPages	integer(int32)	false	none	none
totalElements	integer(int64)	false	none	none
pageable	PageableObject	false	none	none
size	integer(int32)	false	none	none
content	[CompositionView]	false	none	none
number	integer(int32)	false	none	none
sort	SortObject	false	none	none
first	boolean	false	none	none
last	boolean	false	none	none
numberOfElements	integer(int32)	false	none	none
empty	boolean	false	none	none

PageableObject

{
  "paged": true,
  "pageNumber": 0,
  "pageSize": 0,
  "offset": 0,
  "sort": {
    "sorted": true,
    "empty": true,
    "unsorted": true
  },
  "unpaged": true
}

Properties

Name	Type	Required	Restrictions	Description
paged	boolean	false	none	none
pageNumber	integer(int32)	false	none	none
pageSize	integer(int32)	false	none	none
offset	integer(int64)	false	none	none
sort	SortObject	false	none	none
unpaged	boolean	false	none	none

SortObject

{
  "sorted": true,
  "empty": true,
  "unsorted": true
}

Properties

Name	Type	Required	Restrictions	Description
sorted	boolean	false	none	none
empty	boolean	false	none	none
unsorted	boolean	false	none	none

CompositionResourceMessage

{
  "url": "https://storage.googleapis.com/bucket/6e6d5224-1919-48fa-a982-66cef9fa4c08/7edf1e1e-0109-4d92-9bad-ab43059a28e3/ca900103-16d3-4b34-884a-003fd8b8e9ca/7edf1e1e-0109-4d92-9bad-ab43059a28e3.mp4?GoogleAccessId=rtc-recorder-gcs@auvious.iam.gserviceaccount.com&Expires=1610649825&Signature=t2f4bXWN842Z7eHHVKaMZs1KHUzcqX8EXX4QoaWinjcKrMcq1AnADJ7iV2MjLgScnJFhlFYiFosHiLNUSqbjuar9IKEtH9JTyLdvkljEzBPPrkvZ5X0XIi5%2FsEQTekwdzKmTjjGRUZWCix%2FIMbizCl0qnX6Tpi%2BbKhTD7u9PjXk1PEum2P2siAnB0s8D9sow6IDuH8%2FrKYMjCe3jb2P%2Fi6asce9xOwmNjW7lxnyLMAeydxCWyZ66kcas0wXZ5BillG%2BA9NvqvnBXKQrGV5im6%2FnleElz9JhcFS%2B2U5suXt9tok3SScbgMvSWfLQ0PyttJuKtQ%2FxTzUnvGOc5WGkTNg%3D%3D",
  "validFor": "PT5M",
  "validUntil": "2021-01-14T18:43:45.569343Z"
}

Properties

Name	Type	Required	Restrictions	Description
url	string(uri)	false	none	A signed URL of the given resource.
validFor	string	false	none	SignedUrl.validFor mirrored back to clients. Start countdown timers from this ISO-8601 duration to stay correct even if the consumer clock is fast/slow (example: PT5M).
validUntil	string	false	none	ISO-8601 instant when the link expires. Derived from validFor and current server time (STS TTL aware).

Authentication​

Composition Command Service​

Cancel a running Composition​

Parameters​

Responses​

Overview​

Response Schema​

Examples​

Code samples​

Create a new Composition​

Request body​

Parameters​

Responses​

Overview​

Examples​

Code samples​

Re-execute a previously completed composition​

Request body​

Parameters​

Responses​

Overview​

Examples​

Code samples​

Delete existing Composition​

Parameters​

Responses​

Overview​

Response Schema​

Examples​

Code samples​

Composition Query Service​

Get recording data and associated composition by conversationId​

Parameters​

Responses​

Overview​

Examples​

Code samples​

Get all compositions initiated by the currently authenticated user​

Parameters​

Responses​

Overview​

Examples​

Code samples​

Get a composition by compositionId​

Parameters​

Responses​

Overview​

Examples​

Code samples​

Composition Media Player​

Get a signed URL to play a media file by conversation id and composition Id​

Parameters​

Responses​

Overview​

Examples​

Code samples​

Get a signed URL to download a media file by conversation id and composition Id​

Parameters​

Responses​

Overview​

Examples​

Code samples​

getInline​

Parameters​

Responses​

Overview​

Examples​

Code samples​

getAttachment​

Parameters​

Responses​

Overview​

Examples​

Code samples​

Schemas​

CreateCompositionWebCommand​

Properties​

Enumerated Values​

CompositionIdentifier​

Properties​

Authentication

Composition Command Service

Cancel a running Composition

Parameters

Responses

Overview

Response Schema

Examples

Code samples

Create a new Composition

Request body

Parameters

Responses

Overview

Examples

Code samples

Re-execute a previously completed composition

Request body

Parameters

Responses

Overview

Examples

Code samples

Delete existing Composition

Parameters

Responses

Overview

Response Schema

Examples

Code samples

Composition Query Service

Get recording data and associated composition by conversationId

Parameters

Responses

Overview

Examples

Code samples

Get all compositions initiated by the currently authenticated user

Parameters

Responses

Overview

Examples

Code samples

Get a composition by compositionId

Parameters

Responses

Overview

Examples

Code samples

Composition Media Player

Get a signed URL to play a media file by conversation id and composition Id

Parameters

Responses

Overview

Examples

Code samples

Get a signed URL to download a media file by conversation id and composition Id

Parameters

Responses

Overview

Examples

Code samples

getInline

Parameters

Responses

Overview

Examples

Code samples

getAttachment

Parameters

Responses

Overview

Examples

Code samples

Schemas

CreateCompositionWebCommand

Properties

Enumerated Values

CompositionIdentifier

Properties