iva_whiteboard
Manage whiteboards in video conferences: run demonstrations, organize books and pages, edit or clear content, export to PNG, and undo changes.
Instructions
IVA whiteboard: start/stop demonstration, manage books and pages (add/delete/update/clear/copy/reorder), get whiteboard/books/pages, export to PNG, undo, save change, update cursor/demo state. Clients API v2.28.12.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| limit | No | Maximum number of results | |
| action | Yes | Operation to perform: - "load": Load/get the current whiteboard state of a conference session (incl. pages, books, demo info). - "start_demo": Start whiteboard demonstration. Начать демонстрацию доски. Показать доску участникам. Requires whiteboardState: {pageId, left, top, right, bottom} (all fields required per API). - "stop_demo": Stop whiteboard demonstration. Остановить демонстрацию доски. Прекратить показывать доску. - "update_cursor": Update presenter cursor position on the whiteboard (e.g. move pointer). - "update_demo_state": Update whiteboard demonstration state (running/paused/scrolling etc.). - "get_books": Get the list of whiteboard books in the conference session. - "add_book": Create a new whiteboard book. Создать новую книгу (раздел) на доске. - "get_book_pages": Get the list of pages inside a whiteboard book (with pagination). - "add_page": Add a new page to a whiteboard book. Добавить страницу в книгу доски. - "get_page": Get a single whiteboard page by ID (full content/strokes). - "delete_book": Delete a whiteboard book. Удалить книгу доски. - "update_book": Update whiteboard book metadata (title, settings, etc.). - "delete_page": Delete a whiteboard page. Удалить страницу доски. - "clear_page": Clear all content from a whiteboard page. Очистить страницу доски. - "copy_page": Copy a whiteboard page (e.g. duplicate slides). - "reorder_pages": Reorder whiteboard pages within a book (change slide order). - "save_change": Save a change/patch to a whiteboard page (strokes, drawings, annotations). Сохранить изменения на странице. - "undo": Undo the last change on a whiteboard page. Отменить последнее действие на доске. - "export_page": Export a whiteboard page to PNG image. - "export_book": Export an entire whiteboard book (e.g. as PDF/zip of pages). - "get_books_by_document": Get whiteboard books associated with a given document ID. | |
| bookId | No | Whiteboard book UUID | |
| offset | No | Number of results to skip (pagination offset) | |
| pageId | No | Whiteboard page UUID | |
| confirm | No | Set to true to confirm destructive actions (delete, remove, stop, etc.) when IVA_CONFIRM_DESTRUCTIVE is enabled. | |
| bookData | No | Book creation data | |
| copyData | No | Copy page data | |
| pageData | No | Page creation data | |
| bookUpdate | No | Book update data | |
| changeData | No | Page change data | |
| cursorData | No | Cursor state data | |
| documentId | No | Document UUID | |
| reorderData | No | Reorder pages data | |
| demoStateData | No | Demonstration state data | |
| whiteboardState | No | Whiteboard view state sent as the request body: {pageId, left, top, right, bottom}. All five fields are required by the API; pageId is a whiteboard page UUID, left/top/right/bottom are integer viewport coordinates. | |
| conferenceSessionId | No | Conference session UUID |