Auvious RTC API v1.9.26

Auvious RTC API is the core set of services providing the realtime communication capabilities of the Auvious Platform.

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
OAuth 2.0 Authorization.
- Flow: clientCredentials
- OAuth 2.0 Token URL = /security/oauth/token
- OAuth 2.0 Scope
  
  Scope Scope Description

Assets

Upload an asset

POST https://auvious.video/rtc-api/assets/{assetId} HTTP/1.1
Host: auvious.video
Content-Type: multipart/form-data
Accept: */*
X-Auvious-TransactionId: string

Request body

applicationId: string
category: string
filename: string
rolesAllowedAccess: string
file: string

Parameters

Parameter	In	Type	Required	Description
assetId	path	string	true	none
X-Auvious-TransactionId	header	string	false	used for detecting retries of the same request
body	body	object	true	none
» applicationId	body	string	true	none
» category	body	string	true	none
» filename	body	string	false	none
» rolesAllowedAccess	body	string	true	comma separated list of roles allowed to access the asset, e.g.: admin,customer
» file	body	string(binary)	true	none

Responses

Overview

Status	Meaning	Description	Schema
204	No Content	No Content	None
400	Bad Request	Bad Request	Inline

Response Schema

Status Code 400

Name	Type	Required	Restrictions	Description
» additionalProperties	string	false	none	none

Examples

400 Response

caution

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

Code samples

curl -X POST https://auvious.video/rtc-api/assets/{assetId} \
  -H 'Content-Type: multipart/form-data' \  -H 'Accept: */*' \  -H 'X-Auvious-TransactionId: string' \  -H 'Authorization: Bearer {access-token}'

package main

import (
    "bytes"
    "net/http"
)

func main() {
    headers := map[string][]string{ 
        "Content-Type": []string{"multipart/form-data"},
        "Accept": []string{"*/*"},
        "X-Auvious-TransactionId": []string{"string"},
        "Authorization": []string{"Bearer {access-token}"},
    }

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

    req, err := http.NewRequest("POST", "https://auvious.video/rtc-api/assets/{assetId}", bytes.NewBuffer(body))
    req.Header = headers

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

const fetch = require('node-fetch');
const input = '{
  "applicationId": "string",
  "category": "string",
  "filename": "string",
  "rolesAllowedAccess": "string",
  "file": "string"
}';
const headers = {
  'Content-Type': 'multipart/form-data',  'Accept': '*/*',  'X-Auvious-TransactionId': 'string',  'Authorization': 'Bearer {access-token}'
}

fetch('https://auvious.video/rtc-api/assets/{assetId}', {
  method: 'POST',
  body: input,
  headers
})
.then(r => r.json())
.then((body) => {
    console.log(body)
})

// This sample needs improvement.
URL obj = new URL("https://auvious.video/rtc-api/assets/{assetId}");

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': 'multipart/form-data',
  'Accept': '*/*',
  'X-Auvious-TransactionId': 'string',
  'Authorization': 'Bearer {access-token}'
}

r = requests.post(
  'https://auvious.video/rtc-api/assets/{assetId}',
  params={},
  headers = headers)

print r.json()

require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'multipart/form-data',
  'Accept' => '*/*',
  'X-Auvious-TransactionId' => 'string',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.post 'https://auvious.video/rtc-api/assets/{assetId}',
  params: {}, headers: headers

p JSON.parse(result)

Delete an asset

DELETE https://auvious.video/rtc-api/assets/{assetId} HTTP/1.1
Host: auvious.video
Accept: */*
X-Auvious-TransactionId: string

Parameters

Parameter	In	Type	Required	Description
assetId	path	string	true	id of asset to delete
X-Auvious-TransactionId	header	string	false	Optional header used for detecting retries of the same request

Responses

Overview

Status	Meaning	Description	Schema
204	No Content	No Content	None
400	Bad Request	Bad Request	Inline

Response Schema

Status Code 400

Name	Type	Required	Restrictions	Description
» additionalProperties	string	false	none	none

Examples

400 Response

caution

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

Code samples

curl -X DELETE https://auvious.video/rtc-api/assets/{assetId} \
  -H 'Accept: */*' \  -H 'X-Auvious-TransactionId: string' \  -H 'Authorization: Bearer {access-token}'

package main

import (
    "bytes"
    "net/http"
)

func main() {
    headers := map[string][]string{ 
        "Accept": []string{"*/*"},
        "X-Auvious-TransactionId": []string{"string"},
        "Authorization": []string{"Bearer {access-token}"},
    }

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

    req, err := http.NewRequest("DELETE", "https://auvious.video/rtc-api/assets/{assetId}", bytes.NewBuffer(body))
    req.Header = headers

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

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

const headers = {
  'Accept': '*/*',  'X-Auvious-TransactionId': 'string',  'Authorization': 'Bearer {access-token}'
}

fetch('https://auvious.video/rtc-api/assets/{assetId}', {
  method: 'DELETE',
  headers
})
.then(r => r.json())
.then((body) => {
    console.log(body)
})

// This sample needs improvement.
URL obj = new URL("https://auvious.video/rtc-api/assets/{assetId}");

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': '*/*',
  'X-Auvious-TransactionId': 'string',
  'Authorization': 'Bearer {access-token}'
}

r = requests.delete(
  'https://auvious.video/rtc-api/assets/{assetId}',
  params={},
  headers = headers)

print r.json()

require 'rest-client'
require 'json'

headers = {
  'Accept' => '*/*',
  'X-Auvious-TransactionId' => 'string',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.delete 'https://auvious.video/rtc-api/assets/{assetId}',
  params: {}, headers: headers

p JSON.parse(result)

create a signed url

POST https://auvious.video/rtc-api/assets/{assetId}/signedUrl HTTP/1.1
Host: auvious.video
Accept: application/json
X-Auvious-CreateInternalSignedUrl: true
Referer: string

Parameters

Parameter	In	Type	Required	Description
assetId	path	string	true	none
X-Auvious-CreateInternalSignedUrl	header	boolean	false	none
Referer	header	string	true	none

Responses

Overview

Status	Meaning	Description	Schema
200	OK	OK	SignedUrl
400	Bad Request	Bad Request	Inline

Response Schema

Status Code 400

Name	Type	Required	Restrictions	Description
» additionalProperties	string	false	none	none

Examples

200 Response

{
  "url": "https://cdn.example.com/path/to/file?signature=abc123",
  "validFor": "PT5M",
  "validUntil": "2025-03-27T12:00:00Z"
}

400 Response

caution

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

Code samples

curl -X POST https://auvious.video/rtc-api/assets/{assetId}/signedUrl \
  -H 'Accept: application/json' \  -H 'X-Auvious-CreateInternalSignedUrl: true' \  -H 'Referer: string' \  -H 'Authorization: Bearer {access-token}'

package main

import (
    "bytes"
    "net/http"
)

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

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

    req, err := http.NewRequest("POST", "https://auvious.video/rtc-api/assets/{assetId}/signedUrl", bytes.NewBuffer(body))
    req.Header = headers

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

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

const headers = {
  'Accept': 'application/json',  'X-Auvious-CreateInternalSignedUrl': 'true',  'Referer': 'string',  'Authorization': 'Bearer {access-token}'
}

fetch('https://auvious.video/rtc-api/assets/{assetId}/signedUrl', {
  method: 'POST',
  headers
})
.then(r => r.json())
.then((body) => {
    console.log(body)
})

// This sample needs improvement.
URL obj = new URL("https://auvious.video/rtc-api/assets/{assetId}/signedUrl");

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': 'application/json',
  'X-Auvious-CreateInternalSignedUrl': 'true',
  'Referer': 'string',
  'Authorization': 'Bearer {access-token}'
}

r = requests.post(
  'https://auvious.video/rtc-api/assets/{assetId}/signedUrl',
  params={},
  headers = headers)

print r.json()

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'X-Auvious-CreateInternalSignedUrl' => 'true',
  'Referer' => 'string',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.post 'https://auvious.video/rtc-api/assets/{assetId}/signedUrl',
  params: {}, headers: headers

p JSON.parse(result)

Find assets by application id

GET https://auvious.video/rtc-api/assets?applicationId=string HTTP/1.1
Host: auvious.video
Accept: application/json

Parameters

Parameter	In	Type	Required	Description
applicationId	query	string	true	none

Responses

Overview

Status	Meaning	Description	Schema
200	OK	OK	Inline
400	Bad Request	Bad Request	Inline

Response Schema

Status Code 400

Name	Type	Required	Restrictions	Description
» additionalProperties	string	false	none	none

Examples

200 Response

{}

400 Response

caution

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

Code samples

curl -X GET https://auvious.video/rtc-api/assets?applicationId=string \
  -H 'Accept: application/json' \  -H 'Authorization: Bearer {access-token}'

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", "https://auvious.video/rtc-api/assets", 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': 'Bearer {access-token}'
}

fetch('https://auvious.video/rtc-api/assets?applicationId=string', {
  method: 'GET',
  headers
})
.then(r => r.json())
.then((body) => {
    console.log(body)
})

// This sample needs improvement.
URL obj = new URL("https://auvious.video/rtc-api/assets?applicationId=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': 'Bearer {access-token}'
}

r = requests.get(
  'https://auvious.video/rtc-api/assets',
  params={
    'applicationId': 'string'},
  headers = headers)

print r.json()

require 'rest-client'
require 'json'

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

result = RestClient.get 'https://auvious.video/rtc-api/assets',
  params: {
    'applicationId' => 'string'}, headers: headers

p JSON.parse(result)

get a builtin signed url

GET https://auvious.video/rtc-api/assets/signed/{assetId}/{expiration}?signature=string HTTP/1.1
Host: auvious.video
Accept: */*

Parameters

Parameter	In	Type	Required	Description
assetId	path	string	true	none
expiration	path	integer(int64)	true	none
signature	query	string	true	none

Responses

Overview

Status	Meaning	Description	Schema
200	OK	OK	Inline
400	Bad Request	Bad Request	Inline

Response Schema

Status Code 400

Name	Type	Required	Restrictions	Description
» additionalProperties	string	false	none	none

Examples

200 Response

caution

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

Code samples

curl -X GET https://auvious.video/rtc-api/assets/signed/{assetId}/{expiration}?signature=string \
  -H 'Accept: */*' \  -H 'Authorization: Bearer {access-token}'

package main

import (
    "bytes"
    "net/http"
)

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

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

    req, err := http.NewRequest("GET", "https://auvious.video/rtc-api/assets/signed/{assetId}/{expiration}", bytes.NewBuffer(body))
    req.Header = headers

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

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

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

fetch('https://auvious.video/rtc-api/assets/signed/{assetId}/{expiration}?signature=string', {
  method: 'GET',
  headers
})
.then(r => r.json())
.then((body) => {
    console.log(body)
})

// This sample needs improvement.
URL obj = new URL("https://auvious.video/rtc-api/assets/signed/{assetId}/{expiration}?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': '*/*',
  'Authorization': 'Bearer {access-token}'
}

r = requests.get(
  'https://auvious.video/rtc-api/assets/signed/{assetId}/{expiration}',
  params={
    'signature': 'string'},
  headers = headers)

print r.json()

require 'rest-client'
require 'json'

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

result = RestClient.get 'https://auvious.video/rtc-api/assets/signed/{assetId}/{expiration}',
  params: {
    'signature' => 'string'}, headers: headers

p JSON.parse(result)

Schemas

SignedUrl

{
  "url": "https://cdn.example.com/path/to/file?signature=abc123",
  "validFor": "PT5M",
  "validUntil": "2025-03-27T12:00:00Z"
}

Properties

Name	Type	Required	Restrictions	Description
url	string(uri)	false	none	none
validFor	string(duration)	false	none	Use this ISO-8601 duration for countdowns to avoid clock drift
validUntil	string(date-time)	false	none	Timestamp when the signed link actually expires

Authentication​

Assets​

Upload an asset​

Request body​

Parameters​

Responses​

Overview​

Response Schema​

Examples​

Code samples​

Delete an asset​

Parameters​

Responses​

Overview​

Response Schema​

Examples​

Code samples​

create a signed url​

Parameters​

Responses​

Overview​

Response Schema​

Examples​

Code samples​

Find assets by application id​

Parameters​

Responses​

Overview​

Response Schema​

Examples​

Code samples​

get a builtin signed url​

Parameters​

Responses​

Overview​

Response Schema​

Examples​

Code samples​

Schemas​

SignedUrl​

Properties​

Authentication

Assets

Upload an asset

Request body

Parameters

Responses

Overview

Response Schema

Examples

Code samples

Delete an asset

Parameters

Responses

Overview

Response Schema

Examples

Code samples

create a signed url

Parameters

Responses

Overview

Response Schema

Examples

Code samples

Find assets by application id

Parameters

Responses

Overview

Response Schema

Examples

Code samples

get a builtin signed url

Parameters

Responses

Overview

Response Schema

Examples

Code samples

Schemas

SignedUrl

Properties