API center

The server validates credentials, tenant, environment and permissions. This page does not send requests. Replace example values; deployed server validation remains authoritative.

Parameters

reservation_id path · string · required

Request body

current_participants integer · int32

current_quality string

execution_key string

observed_at string

operation_id string

provider_session_id string

quality_slices array

Expand fields

participant_seconds string

quality string

room_seconds string

reservation_id string

sequence_no string

source_event_id string

stage string

PROGRESS keeps the execution open. FINAL freezes authoritative media usage before the caller invokes CommitExecution with the returned amount.

curl --request POST 'https://nexus-api.rainlib.com/v1/executions/{reservation_id}:media-heartbeat' \
  --header 'Authorization: Bearer <NEXUS_ACCESS_TOKEN>' \
  --header 'Content-Type: application/json' \
  --data '{
  "current_participants": 0,
  "current_quality": "<value>",
  "execution_key": "<value>",
  "observed_at": "<value>",
  "operation_id": "<value>",
  "provider_session_id": "<value>",
  "quality_slices": [
    {
      "participant_seconds": "<value>",
      "quality": "<value>",
      "room_seconds": "<value>"
    }
  ],
  "sequence_no": "<value>",
  "source_event_id": "<value>",
  "stage": "<value>"
}'

Response contract

Generated responses do not enumerate every runtime error. See the integration guide for authentication, conflicts and retries.