Voice Platform APIRoom Playback

Seek room playback

View as Markdown
**Rate limit: Per room** · **Burst:** 15 · **Refill:** 10 req/s Shared by room playback seek commands (the `room.playback.seek` bucket). Seek the room's current playback by a relative, signed offset. `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
Application auth. Send `Authorization: Bearer <app_uuid>:<api_key>`. See [Authentication](https://voice-platform.docs.buildwithfern.com/api/authentication) for details.

Path parameters

room_idstringRequired

Room ID (format {prefix}-room-{uuid}). The UUID portion is lowercase hexadecimal — uppercase hex is rejected with 400.

Headers

Idempotency-KeystringOptionalformat: "^[a-zA-Z0-9._-]+$"<=128 characters
Optional client-generated key for a mutating endpoint. It identifies one method, route, query, content type, and exact raw body within the authenticated app. Reusing it for a different request returns 422. While its record exists, a retry replays the original accepted response when available. Keys are valid for 1 hour. Allowed characters: letters, digits, dot, hyphen, underscore; max 128 characters. See the Idempotency guide.

Request

This endpoint expects an object.
seek_msintegerRequired

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

Response

Room playback command accepted for asynchronous execution
operation_uuidstringformat: "uuid"
statusenum

Errors

400
Bad Request Error
401
Unauthorized Error
404
Not Found 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