nimeet Docs
中文

Cloud Transcoding

ABR templates, builder tokens and transcoder tasks.

Generated from the public REST API definitions

Version v1.1.0 · Updated 2026-10-26 · revision 1

Group overview

Generated at build time from the public REST API definition: tag cloud-transcoding, 7 operations (out of 189). For authentication, envelope and pagination conventions see REST API overview.

MethodPathSummary
GET/v1/projects/{appId}/rtls/abr/config/codecsQuery the adaptive-bitrate templates
POST/v1/projects/{appId}/rtls/abr/config/codecs/{codecId}Create or update an adaptive-bitrate template
POST/v1/projects/{appId}/rtsc/cloud-transcoder/builderTokensAcquire a builder token
POST/v1/projects/{appId}/rtsc/cloud-transcoder/tasksCreate a cloud transcoding task
GET/v1/projects/{appId}/rtsc/cloud-transcoder/tasks/{taskId}Query the status of a transcoding task
PATCH/v1/projects/{appId}/rtsc/cloud-transcoder/tasks/{taskId}Update a transcoding task
DELETE/v1/projects/{appId}/rtsc/cloud-transcoder/tasks/{taskId}Destroy a transcoding task

Operation details

GET /v1/projects/{appId}/rtls/abr/config/codecs

Query the adaptive-bitrate templates

Authentication: project credentials (Base64 of customerId:customerSecret)

Parameters

NameLocationRequiredTypeDescription
appIdpathisstringpattern ^[a-f0-9]{32}$

Response

Status codesDescription / schema
200the templates — object{ status, data }
400Invalid parameter — Error
401Missing/invalid credentials — Error
403Banned or service not enabled — Error
404Resource not found — Error
415Content-Type must be application/json — Error
429Quota exceeded — Error

Example call

bash
curl -s -X GET "$NIMEET_API_BASE/v1/projects/appId/rtls/abr/config/codecs" \
  -H "Authorization: Basic $NIMEET_CUSTOMER_BASIC"

POST /v1/projects/{appId}/rtls/abr/config/codecs/{codecId}

Create or update an adaptive-bitrate template

Authentication: project credentials (Base64 of customerId:customerSecret)

Parameters

NameLocationRequiredTypeDescription
appIdpathisstringpattern ^[a-f0-9]{32}$
codecIdpathisstringlength 0..64

Request body

FieldTypeRequiredDescription
enabledbooleanis
videoobject{ width, height, fps }is
json
{
  "enabled": true,
  "video": {
    "width": 1,
    "height": 1,
    "fps": 1
  }
}

Response

Status codesDescription / schema
200the template was stored — object{ status }
400Invalid parameter — Error
401Missing/invalid credentials — Error
403Banned or service not enabled — Error
404Resource not found — Error
415Content-Type must be application/json — Error
429Quota exceeded — Error

Example call

bash
curl -s -X POST "$NIMEET_API_BASE/v1/projects/appId/rtls/abr/config/codecs/codecId" \
  -H "Authorization: Basic $NIMEET_CUSTOMER_BASIC" \
  -H "Content-Type: application/json" \
  -d '{"enabled":true,"video":{"width":1,"height":1,"fps":1}}'

POST /v1/projects/{appId}/rtsc/cloud-transcoder/builderTokens

Acquire a builder token

Mints a single-use builder token (5 minute validity) that the task endpoints require.

Authentication: project credentials (Base64 of customerId:customerSecret)

Parameters

NameLocationRequiredTypeDescription
appIdpathisstringpattern ^[a-f0-9]{32}$

Request body

FieldTypeRequiredDescription
instanceIdstringislength 0..64, pattern ^[A-Za-z0-9_-]+$
servicesobject{ cloudTranscoder }is
json
{
  "instanceId": "string",
  "services": {
    "cloudTranscoder": {
      "serviceType": "cloudTranscoderV2",
      "config": {}
    }
  }
}

Response

Status codesDescription / schema
200the builder token — object{ createTs, instanceId, tokenName }
400Invalid parameter — Error
401Missing/invalid credentials — Error
403Banned or service not enabled — Error
404Resource not found — Error
415Content-Type must be application/json — Error
429Quota exceeded — Error

Example call

bash
curl -s -X POST "$NIMEET_API_BASE/v1/projects/appId/rtsc/cloud-transcoder/builderTokens" \
  -H "Authorization: Basic $NIMEET_CUSTOMER_BASIC" \
  -H "Content-Type: application/json" \
  -d '{"instanceId":"string","services":{"cloudTranscoder":{"serviceType":"cloudTranscoderV2","config":{}}}}'

POST /v1/projects/{appId}/rtsc/cloud-transcoder/tasks

Create a cloud transcoding task

Authentication: project credentials (Base64 of customerId:customerSecret)

Parameters

NameLocationRequiredTypeDescription
appIdpathisstringpattern ^[a-f0-9]{32}$
builderTokenqueryisstring

Request body

FieldTypeRequiredDescription
servicesobject{ cloudTranscoder }is
instanceIdstringlength 0..64
json
{
  "services": {
    "cloudTranscoder": {
      "serviceType": "cloudTranscoderV2",
      "config": {}
    }
  },
  "instanceId": "string"
}

Response

Status codesDescription / schema
200the transcoding task — object
400Invalid parameter — Error
401Missing/invalid credentials — Error
403Banned or service not enabled — Error
404Resource not found — Error
415Content-Type must be application/json — Error
429Quota exceeded — Error

Example call

bash
curl -s -X POST "$NIMEET_API_BASE/v1/projects/appId/rtsc/cloud-transcoder/tasks?builderToken=value" \
  -H "Authorization: Basic $NIMEET_CUSTOMER_BASIC" \
  -H "Content-Type: application/json" \
  -d '{"services":{"cloudTranscoder":{"serviceType":"cloudTranscoderV2","config":{}}},"instanceId":"string"}'

GET /v1/projects/{appId}/rtsc/cloud-transcoder/tasks/{taskId}

Query the status of a transcoding task

Authentication: project credentials (Base64 of customerId:customerSecret)

Parameters

NameLocationRequiredTypeDescription
appIdpathisstringpattern ^[a-f0-9]{32}$
taskIdpathisstringlength 0..128
builderTokenquerystring

Response

Status codesDescription / schema
200the transcoding task — object
400Invalid parameter — Error
401Missing/invalid credentials — Error
403Banned or service not enabled — Error
404Resource not found — Error
415Content-Type must be application/json — Error
429Quota exceeded — Error

Example call

bash
curl -s -X GET "$NIMEET_API_BASE/v1/projects/appId/rtsc/cloud-transcoder/tasks/taskId?builderToken=value" \
  -H "Authorization: Basic $NIMEET_CUSTOMER_BASIC"

PATCH /v1/projects/{appId}/rtsc/cloud-transcoder/tasks/{taskId}

Update a transcoding task

Adds or removes inputs, moves a layout region and updates the output audio/video options of a running task.

Authentication: project credentials (Base64 of customerId:customerSecret)

Parameters

NameLocationRequiredTypeDescription
appIdpathisstringpattern ^[a-f0-9]{32}$
taskIdpathisstringlength 0..128
builderTokenqueryisstring

Request body

FieldTypeRequiredDescription
servicesobject{ cloudTranscoder }is
json
{
  "services": {
    "cloudTranscoder": {
      "serviceType": "cloudTranscoderV2",
      "config": {}
    }
  }
}

Response

Status codesDescription / schema
200the request succeeded; the response body is empty
400Invalid parameter — Error
401Missing/invalid credentials — Error
403Banned or service not enabled — Error
404Resource not found — Error
415Content-Type must be application/json — Error
429Quota exceeded — Error

Example call

bash
curl -s -X PATCH "$NIMEET_API_BASE/v1/projects/appId/rtsc/cloud-transcoder/tasks/taskId?builderToken=value" \
  -H "Authorization: Basic $NIMEET_CUSTOMER_BASIC" \
  -H "Content-Type: application/json" \
  -d '{"services":{"cloudTranscoder":{"serviceType":"cloudTranscoderV2","config":{}}}}'

DELETE /v1/projects/{appId}/rtsc/cloud-transcoder/tasks/{taskId}

Destroy a transcoding task

Authentication: project credentials (Base64 of customerId:customerSecret)

Parameters

NameLocationRequiredTypeDescription
appIdpathisstringpattern ^[a-f0-9]{32}$
taskIdpathisstringlength 0..128
builderTokenquerystring

Response

Status codesDescription / schema
200the stopped transcoding task — object
400Invalid parameter — Error
401Missing/invalid credentials — Error
403Banned or service not enabled — Error
404Resource not found — Error
415Content-Type must be application/json — Error
429Quota exceeded — Error

Example call

bash
curl -s -X DELETE "$NIMEET_API_BASE/v1/projects/appId/rtsc/cloud-transcoder/tasks/taskId?builderToken=value" \
  -H "Authorization: Basic $NIMEET_CUSTOMER_BASIC"

Schemas used by this group

Error — object{ code, message, reason, sdkCode, details }
FieldTypeRequiredDescription
codestringisstable machine code, see errors.json
messagestringis
reasonstring
sdkCodeintegerAgora-aligned client error number
detailsobject

Generated by the documentation build pipeline · 2026-10-31 01:24:02 UTC · Documentation center v1.1.0.

Content follows the public API definitions.

ni-meet is a self-hosted RTC PaaS with a LiveKit-based media plane (Apache-2.0) and an Agora-compatible API.