Create or update a transcoding template

Updated

Creates or updates a transcoding template.

https://api.sd-rtn.com/v1/projects/{appId}/rtls/abr/config/codecs/{codecId}

Create or update a transcoding template under the specified App ID.

Path Parameters

appId
*
string

The App ID of your project from Agora Console.

codecId
*
string

The ID of the transcoding template.

Header Parameters

Content-Type
*
string

The request content type. Use application/json.

Allowed
application/json

Request Body

application/json

enabled
required
boolean

Whether to enable this transcoding template:

  • true: Enable the template
  • false: Do not enable the template
video
required
object

Response

  • If the returned status code is 200, the request was successful. The response body contains the result of the request.

  • If the returned status code is not 200, the request failed. The response body includes the detail and reason for failure. Refer to status codes to understand the possible reasons for failure.

Response Body

application/json

application/json

Response schema

200
application/json

The request succeeded.

status
optional
string

The status of the request.

Status of this request:

  • success: The request was successful.
  • error: The request failed.
Allowed
success | error
default
application/json

The request failed.

message
optional
string

Describes why the request failed.

status
optional
string

The status of the request.

Status of this request:

  • success: The request was successful.
  • error: The request failed.
Allowed
success | error

Response example

{
      "status": "Status of this request:\n- `success`: Request was successful.\n- `error`: Request failed.\n"
    }

Authorization

This endpoint requires authentication.

basicAuth

Request examples

curl --request post \
      --url https://api.sd-rtn.com/v1/projects/:appId/rtls/abr/config/codecs/:codecId \
      --header 'Authorization: Basic <credentials>' \
      --header 'Content-Type: <string>'

Response example

{  "status": "success"}