Fetch stream device parameters

GET

/v3/streams/{stream_id}/params

curl --request GET \
  --url https://api.cardio.ai/v3/streams/1/params \
  --header 'X-Api-Token: <X-Api-Token>'

• Production REST API endpoint.

Returns device state, pending device command, and custom duration for a stream.

Authorizations

• ApiToken

Parameters

Path Parameters

stream_id

required

integer format: int64

>= 1

Stream identifier.

Responses

200

Stream parameters successfully retrieved.

Media typeapplication/json

Device-facing stream parameters.

object

device_state

Current device state.

string

Allowed values: UNKNOWN_DEVICE_STATE WAITING_FOR_START RECORDING RECORDING_COMPLETED UPLOADING UPLOADING_FAILED

device_command

Pending command for the device.

string

Allowed values: UNKNOWN_DEVICE_COMMAND START_DEVICE STOP_DEVICE RETRY_UPLOADING

custom_duration

Custom stream duration in milliseconds, rounded down.

integer format: int64

Example

{
  "device_state": "UNKNOWN_DEVICE_STATE",
  "device_command": "UNKNOWN_DEVICE_COMMAND"
}

400

Bad Request - missing or invalid parameters.

Media typeapplication/json

Error payload carried by every non-2xx response.

object

message

required

Human-readable description of the failure. The wording is not part of the API contract; do not match on it programmatically.

string

reason

Stable machine-readable failure code in snake_case, e.g. “api_token_missing” or “invalid_task_id”. Omitted for 500 responses.

string

Example^generated

{
  "message": "example",
  "reason": "example"
}

401

Unauthorized - missing, expired, or invalid token.

Media typeapplication/json

Error payload carried by every non-2xx response.

object

message

required

Human-readable description of the failure. The wording is not part of the API contract; do not match on it programmatically.

string

reason

Stable machine-readable failure code in snake_case, e.g. “api_token_missing” or “invalid_task_id”. Omitted for 500 responses.

string

Example^generated

{
  "message": "example",
  "reason": "example"
}

403

Forbidden - the provided token is not authorized to call this endpoint.

Media typeapplication/json

Error payload carried by every non-2xx response.

object

message

required

Human-readable description of the failure. The wording is not part of the API contract; do not match on it programmatically.

string

reason

Stable machine-readable failure code in snake_case, e.g. “api_token_missing” or “invalid_task_id”. Omitted for 500 responses.

string

Example^generated

{
  "message": "example",
  "reason": "example"
}

404

Not Found - requested resource does not exist or is unavailable.

Media typeapplication/json

Error payload carried by every non-2xx response.

object

message

required

Human-readable description of the failure. The wording is not part of the API contract; do not match on it programmatically.

string

reason

Stable machine-readable failure code in snake_case, e.g. “api_token_missing” or “invalid_task_id”. Omitted for 500 responses.

string

Example^generated

{
  "message": "example",
  "reason": "example"
}

429

Too Many Requests - rate limit exceeded.

Media typeapplication/json

Error payload carried by every non-2xx response.

object

message

required

Human-readable description of the failure. The wording is not part of the API contract; do not match on it programmatically.

string

reason

Stable machine-readable failure code in snake_case, e.g. “api_token_missing” or “invalid_task_id”. Omitted for 500 responses.

string

Example^generated

{
  "message": "example",
  "reason": "example"
}