Skip to navigation

Seek room playback

View as Markdown

Rate limit: Per room · Burst: 15 · Refill: 10 req/s

Seek the room’s current playback by a relative, signed offset. This command shares the room playback seek bucket (room.playback.seek). Live streams (type: stream) are not seekable and return 400 invalid_request. seek_ms is a step applied to the current position: positive = forward; a negative value rewinds. It must be non-zero — a value of 0 is rejected. Validated identically to the session-scoped POST /v1/sessions/{uuid}/playback/seek.

Accepts an optional Idempotency-Key header.

Returns 202 with {operation_uuid, status: "in_progress"}.

Authentication

AuthorizationBearer

Send Authorization: Bearer <app_uuid>:<api_key> using an active API key. See Authentication for details.

Path parameters

room_idstringRequired

Case-sensitive room identifier.

Headers

Idempotency-KeystringOptionalformat: "^[a-zA-Z0-9._-]*$"<=128 characters

Optional key for safely retrying mutating requests. An explicitly empty header is treated like omission and does not enable replay protection. See Idempotency for details.

Operation-IdstringOptionalformat: "uuid"

optional client-supplied lowercase RFC-4122 v4 UUID returned as operation_uuid; platform generates one when omitted; correlation metadata distinct from Idempotency-Key.

Request

This endpoint expects an object.
seek_msintegerRequired

Relative seek offset in milliseconds. Positive = forward, a negative value rewinds. Must be non-zero.

Response headers

traceparentstringOptionalformat: "^00-[0-9a-f]{32}-[0-9a-f]{16}-[0-9a-f]{2}$"=55 characters

Server-owned W3C Trace Context for correlating this response with support and observability data. It is present on successful and error responses. A valid incoming traceparent is linked to, but never becomes, the server-owned trace identifier.

Response

Room playback command accepted for asynchronous execution
operation_uuidstring
statusenum
Allowed values:

Errors

400
Bad Request Error
401
Unauthorized Error
404
Not Found Error
406
Not Acceptable Error
409
Conflict Error
413
Content Too Large Error
415
Unsupported Media Type Error
422
Unprocessable Entity Error
429
Too Many Requests Error
500
Internal Server Error
503
Service Unavailable Error