nimeet Docs
中文

Media Pull

Cloud player lifecycle and Media Pull endpoints.

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 media-pull, 6 operations (out of 189). For authentication, envelope and pagination conventions see REST API overview.

MethodPathSummary
GET/v1/projects/{appId}/cloud-player/playersList the cloud players of a project
POST/{region}/v1/projects/{appId}/cloud-player/playersCreate a cloud player
GET/{region}/v1/projects/{appId}/cloud-player/players/{id}Get one cloud player
PATCH/{region}/v1/projects/{appId}/cloud-player/players/{id}Update a cloud player
DELETE/{region}/v1/projects/{appId}/cloud-player/players/{id}Destroy a cloud player
PATCH/{region}/v1/projects/{appId}/cloud-player/{playerid}Update a cloud player (legacy path spelling)

Operation details

GET /v1/projects/{appId}/cloud-player/players

List the cloud players of a project

Authentication: project credentials (Base64 of customerId:customerSecret)

Parameters

NameLocationRequiredTypeDescription
appIdpathisstringpattern ^[a-f0-9]{32}$
filterquerystring
pageSizequeryinteger1..500，default 200
pageTokenquerystring

Response

Status codesDescription / schema
200cloud players — object{ totalSize, players, fields, nextPageToken }
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/cloud-player/players?filter=value&pageSize=0&pageToken=value" \
  -H "Authorization: Basic $NIMEET_CUSTOMER_BASIC"

POST /{region}/v1/projects/{appId}/cloud-player/players

Create a cloud player

Creates a player that pulls an online media stream into an RTC channel as a user. The player is connecting until the injected participant is observed in the channel, then running.

Authentication: project credentials (Base64 of customerId:customerSecret)

Parameters

NameLocationRequiredTypeDescription
regionpathisenum(cn | ap | na | eu)
appIdpathisstringpattern ^[a-f0-9]{32}$
streamIpquerystringformat ipv4

Request body

FieldTypeRequiredDescription
playerobjectis
json
{
  "player": {
    "streamUrl": "string",
    "channelName": "weekly-sync",
    "uid": 1,
    "account": "string"
  }
}

Response

Status codesDescription / schema
200player created — object{ player, fields }
400Invalid parameter — Error
401Missing/invalid credentials — Error
403Banned or service not enabled — Error
404Resource not found — Error
409a cloud player with the same name already exists — Error
415Content-Type must be application/json — Error
429Quota exceeded — Error

Example call

bash
curl -s -X POST "$NIMEET_API_BASE/cn-shanghai/v1/projects/appId/cloud-player/players?streamIp=value" \
  -H "Authorization: Basic $NIMEET_CUSTOMER_BASIC" \
  -H "Content-Type: application/json" \
  -d '{"player":{"streamUrl":"string","channelName":"weekly-sync","uid":1,"account":"string"}}'

GET /{region}/v1/projects/{appId}/cloud-player/players/{id}

Get one cloud player

Authentication: project credentials (Base64 of customerId:customerSecret)

Parameters

NameLocationRequiredTypeDescription
regionpathisenum(cn | ap | na | eu)
appIdpathisstringpattern ^[a-f0-9]{32}$
idpathisstringlength 0..128

Response

Status codesDescription / schema
200the cloud player — object{ player, fields }
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/cn-shanghai/v1/projects/appId/cloud-player/players/weekly-sync_1a2b" \
  -H "Authorization: Basic $NIMEET_CUSTOMER_BASIC"

PATCH /{region}/v1/projects/{appId}/cloud-player/players/{id}

Update a cloud player

Changes the source address, the transcoding options, the playback position or the paused state.

Authentication: project credentials (Base64 of customerId:customerSecret)

Parameters

NameLocationRequiredTypeDescription
regionpathisenum(cn | ap | na | eu)
appIdpathisstringpattern ^[a-f0-9]{32}$
idpathisstringlength 0..128
sequencequeryinteger>= 0

Request body

FieldTypeRequiredDescription
playerobject{ streamUrl, audioOptions, videoOptions, seekPosition, isPause }
json
{
  "player": {
    "streamUrl": "string",
    "audioOptions": {},
    "videoOptions": {}
  }
}

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/cn-shanghai/v1/projects/appId/cloud-player/players/weekly-sync_1a2b?sequence=0" \
  -H "Authorization: Basic $NIMEET_CUSTOMER_BASIC" \
  -H "Content-Type: application/json" \
  -d '{"player":{"streamUrl":"string","audioOptions":{},"videoOptions":{}}}'

DELETE /{region}/v1/projects/{appId}/cloud-player/players/{id}

Destroy a cloud player

Authentication: project credentials (Base64 of customerId:customerSecret)

Parameters

NameLocationRequiredTypeDescription
regionpathisenum(cn | ap | na | eu)
appIdpathisstringpattern ^[a-f0-9]{32}$
idpathisstringlength 0..128

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 DELETE "$NIMEET_API_BASE/cn-shanghai/v1/projects/appId/cloud-player/players/weekly-sync_1a2b" \
  -H "Authorization: Basic $NIMEET_CUSTOMER_BASIC"

PATCH /{region}/v1/projects/{appId}/cloud-player/{playerid}

Update a cloud player (legacy path spelling)

Documented legacy spelling of the player update; identical behaviour to /cloud-player/players/{id}.

Authentication: project credentials (Base64 of customerId:customerSecret)

Parameters

NameLocationRequiredTypeDescription
regionpathisenum(cn | ap | na | eu)
appIdpathisstringpattern ^[a-f0-9]{32}$
playeridpathisstringlength 0..128
sequencequeryinteger>= 0

Request body

FieldTypeRequiredDescription
playerobject{ streamUrl, audioOptions, videoOptions, seekPosition, isPause }
json
{
  "player": {
    "streamUrl": "string",
    "audioOptions": {},
    "videoOptions": {}
  }
}

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/cn-shanghai/v1/projects/appId/cloud-player/playerid?sequence=0" \
  -H "Authorization: Basic $NIMEET_CUSTOMER_BASIC" \
  -H "Content-Type: application/json" \
  -d '{"player":{"streamUrl":"string","audioOptions":{},"videoOptions":{}}}'

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.