Wiki MCP tools¶
56 tools.
wiki_me_get¶
Get current Wiki user · read-only
The authenticated Yandex Wiki user (a safe auth probe).
wiki_pages_get¶
Get Wiki page · read-only
The page's markdown body for SLUG.
| Parameter | Type | Required | Description |
|---|---|---|---|
slug |
string | yes | Wiki page slug (its path), e.g. users/something/abc. |
revision_id |
integer or null | Show this past revision (an id from pages_revisions_list). |
|
raise_on_redirect |
boolean | Fail if the page is a redirect instead of following it. |
wiki_pages_meta¶
Get Wiki page metadata · read-only
Page metadata for SLUG (attributes + owner).
| Parameter | Type | Required | Description |
|---|---|---|---|
slug |
string | yes | Wiki page slug (its path), e.g. users/something/abc. |
wiki_pages_descendants¶
List Wiki page descendants · read-only
All descendant refs under SLUG, auto-paginated.
Capped at the configured item cap unless limit is given; narrow by SLUG for large trees.
| Parameter | Type | Required | Description |
|---|---|---|---|
slug |
string | yes | Wiki page slug (its path), e.g. users/something/abc. |
limit |
integer | Max descendant refs to return; 0 means the configured cap (YCLI__HTTP__MAX_ITEMS). | |
include_self |
boolean | Also return the ancestor page itself. | |
show_all |
boolean | The API's show_all flag. |
wiki_pages_grids_list¶
List Wiki page grids · read-only
Dynamic tables (grids) attached to a page id, auto-paginated (drains next_cursor).
Each grid ref is a UUID id + title + created_at. Capped at the configured item cap
unless limit is given. Reads a page's numeric id — pair with
pages_meta / pages_descendants (whose refs carry the ids) to find one.
| Parameter | Type | Required | Description |
|---|---|---|---|
page_id |
integer | yes | Numeric page id whose grids to list. |
limit |
integer | Max grids (0 = configured cap). | |
order_by |
string | Sort field: title or created_at. |
|
order_direction |
string | Sort direction for order_by: asc or desc. |
wiki_pages_get_by_id¶
Get Wiki page by id · read-only
A single page by its numeric id — the id-based twin of pages_get/pages_meta.
Use it when you hold a numeric page id (e.g. from a descendants listing or a write's
response) instead of the slug. fields follows the standard Wiki selector rules:
without it the response carries id/slug/title only; ask for content or
attributes explicitly.
| Parameter | Type | Required | Description |
|---|---|---|---|
page_id |
integer | yes | Numeric page id to fetch. |
fields |
string or null | Extra blocks (CSV), e.g. content,attributes,breadcrumbs. Omitted = id/slug/title only. |
|
revision_id |
integer or null | Show this past revision (an id from pages_revisions_list). |
|
raise_on_redirect |
boolean | Fail if the page is a redirect instead of following it. |
wiki_pages_descendants_by_id¶
List Wiki page descendants by id · read-only
All descendant page refs under a numeric page id, auto-paginated.
The id-based twin of pages_descendants. Capped at the configured item cap
unless limit is given; each ref carries the child's numeric id and permanent
slug.
| Parameter | Type | Required | Description |
|---|---|---|---|
page_id |
integer | yes | Numeric page id whose subtree to list. |
limit |
integer | Max refs (0 = configured cap). | |
include_self |
boolean | Also return the ancestor page itself. | |
show_all |
boolean | The API's show_all flag. |
wiki_pages_create¶
Create Wiki page · write
Create a wiki page at slug (POST /pages).
Treat the slug as permanent: pages_move can rename the page later, but the old address
then answers 404 and links to it break, so pick the slug carefully. Returns the created page
(its numeric id drives the id-based tools and every subsequent write).
| Parameter | Type | Required | Description |
|---|---|---|---|
slug |
string | yes | Target slug, e.g. data/x. Treat it as permanent (a move breaks links). |
title |
string | yes | Page title. |
content |
string | yes | Page body in YFM markdown. |
fields |
string or null | Extra blocks to include in the reply (CSV), e.g. content,attributes. |
|
is_silent |
boolean | Do not notify the page's subscribers. |
wiki_pages_update¶
Update Wiki page · idempotent write
Replace a wiki page's body (and optionally its title) by numeric id.
This REPLACES the whole body — to add to an existing page use pages_append
instead. The Wiki API updates via POST, not PATCH (PATCH returns 405); the SDK already
handles that quirk. Repeating the same call yields the same page state (idempotent).
| Parameter | Type | Required | Description |
|---|---|---|---|
page_id |
integer | yes | Numeric id of the page to update. |
content |
string | yes | New page body in YFM markdown (full replace). |
title |
string or null | New title (unchanged when omitted). | |
fields |
string or null | Extra blocks to include in the reply (CSV), e.g. content,attributes. |
|
is_silent |
boolean | Do not notify the page's subscribers. | |
allow_merge |
boolean | Merge with a concurrent edit (3-way merge) instead of failing. |
wiki_pages_delete¶
Delete Wiki page · destructive write
Delete a wiki page by numeric id (DELETE /pages/{id}).
KEEP the returned recovery_token — it is the only handle to undo the delete
(redeem it with recovery_restore). Deleting removes the page's descendants'
anchor too, so double-check the id (pages_get_by_id) before calling.
| Parameter | Type | Required | Description |
|---|---|---|---|
page_id |
integer | yes | Numeric id of the page to delete. |
recursive |
boolean | Also delete every page under it. |
wiki_pages_append¶
Append content to Wiki page · write
Append a YFM fragment to a wiki page without rewriting the whole body.
Unlike pages_update (full replace), this adds body.content at the chosen spot:
body.body.location (top/bottom of the page), a numbered body.section, or a named
text body.anchor. Returns the updated page.
| Parameter | Type | Required | Description |
|---|---|---|---|
page_id |
integer | yes | Numeric id of the page to append to. |
body |
object | yes | What to append and where: required content (YFM fragment) plus optional body (top/bottom), section or anchor placement. |
fields |
string or null | Extra blocks to include in the reply (CSV), e.g. content,attributes. |
|
is_silent |
boolean | Do not notify the page's subscribers. |
wiki_pages_clone¶
Clone Wiki page · write
Copy a page to a new address (POST /pages/{id}/clone — asynchronous).
Cloning leaves the original where it is; to give the page itself a new slug use
pages_move. The call returns a deferred operation reference — poll
operations_clone_get with the returned operation.id until it reaches a terminal status.
| Parameter | Type | Required | Description |
|---|---|---|---|
page_id |
integer | yes | Numeric id of the page to copy. |
body |
object | yes | Clone spec: required target (destination slug) plus optional title and subscribe_me. |
wiki_pages_move¶
Move Wiki page · write
Move or rename pages (POST /pages/move — asynchronous; undocumented by Yandex).
The only way to give a page a new slug. The call returns a deferred operation reference —
poll operations_move_get with the returned operation.id until it reaches a terminal
status. A page moves with its subtree and links to the old address may stop working, so try
dry_run=true first: it validates the request, applies nothing, and its operation id
cannot be polled. Yandex does not document this operation (it is in the live OpenAPI only)
and may change it.
| Parameter | Type | Required | Description |
|---|---|---|---|
body |
object | yes | Move spec: operations (each source slug and new target slug, optionally next_to_slug with position before/after) and optional copy_inherited_access. |
dry_run |
boolean | Validate the move without applying it. |
wiki_pages_revisions_list¶
List Wiki page revisions · read-only
Saved revisions of a page, auto-paginated (GET /pages/{id}/revisions).
Each revision has an id (what GET /pages takes as revision_id), its author,
created_at, page_type and publication state. Yandex does not document this operation
(it is in the live OpenAPI only) and may change it.
| Parameter | Type | Required | Description |
|---|---|---|---|
page_id |
integer | yes | Numeric page id whose revisions to list. |
ids |
string or null | Only these revision ids (comma separated). | |
limit |
integer | Max revisions (0 = configured cap). |
wiki_pages_backlinks_list¶
List Wiki page backlinks · read-only
Refs (id and slug) of the pages that link to a page (GET /pages/{id}/backlinks).
Auto-paginated. Yandex does not document this operation (it is in the live OpenAPI only) and may change it.
| Parameter | Type | Required | Description |
|---|---|---|---|
page_id |
integer | yes | Numeric id of the page that is linked to. |
for_cluster |
boolean | Links to the page's whole subtree, not just the page. | |
show_all |
boolean | The API's show_all flag (undocumented; no effect seen live). |
|
limit |
integer | Max refs (0 = configured cap). |
wiki_access_create¶
Grant Wiki page access · write
Grant a user or a group a role on a wiki page; returns the new access entry.
A user who already holds a personal access is refused: change it with access_update.
Read the current accesses with pages_get_by_id and
fields="access_policy,access_lists".
| Parameter | Type | Required | Description |
|---|---|---|---|
page_id |
integer | yes | Numeric id of the page. |
body |
object | yes | The grant: exactly one of user (uid / cloud_uid) and group (src + id), the role, and optionally inheritance. |
wiki_access_update¶
Update Wiki page access · idempotent write
Change the role or reach of one access entry on a wiki page.
The page owner's own entry cannot be changed.
| Parameter | Type | Required | Description |
|---|---|---|---|
page_id |
integer | yes | Numeric id of the page. |
access_id |
string | yes | Id of the access entry, from the page's access_lists. |
body |
object | yes | The new role and/or inheritance (one at least). |
prevent_selflock |
boolean | Refuse the change if it would leave you without read access or the right to change accesses. Set it unless you mean to lock yourself out. |
wiki_access_delete¶
Revoke Wiki page access · destructive write
Revoke one access entry on a wiki page — the holder loses that grant at once.
The page owner's own entry cannot be revoked.
| Parameter | Type | Required | Description |
|---|---|---|---|
page_id |
integer | yes | Numeric id of the page. |
access_id |
string | yes | Id of the access entry, from the page's access_lists. |
prevent_selflock |
boolean | Refuse the change if it would leave you without read access or the right to change accesses. Set it unless you mean to lock yourself out. |
wiki_access_clear¶
Clear Wiki page accesses · destructive write
Revoke every personal access on a wiki page except the owner's.
Everyone but the owner falls back to the page's access policy. Irreversible: the revoked entries are not kept.
| Parameter | Type | Required | Description |
|---|---|---|---|
page_id |
integer | yes | Numeric id of the page. |
prevent_selflock |
boolean | Refuse the change if it would leave you without read access or the right to change accesses. Set it unless you mean to lock yourself out. |
wiki_comments_list¶
List Wiki comments · read-only
Comments on a page id, auto-paginated (drains the next_cursor internally).
Capped at the configured item cap unless limit is given. Pair with
pages_meta (its attributes.comments_count tells you how many exist).
| Parameter | Type | Required | Description |
|---|---|---|---|
page_id |
integer | yes | Numeric page id, from pages_meta or a page ref. |
limit |
integer | Max comments to return; 0 means the configured cap (YCLI__HTTP__MAX_ITEMS). | |
order_by |
string | Sort field: created_at. |
|
order_direction |
string | Sort direction for order_by: asc or desc. |
|
status_filter |
string | Keep only resolved or only unresolved comments. |
wiki_comments_thread_list¶
List Wiki comment thread · read-only
A comment and its replies, reconstructed from the page's comment list.
The Wiki /thread endpoint (comments_thread_get) is dead (returns no replies), so this
fetches every comment on the page and chains parent_id from the target: the comment comes
first, then its descendants in depth-first order. Capped at the configured item cap unless
limit is given. Use comments_list first to discover a root comment id, then this to
read its thread.
| Parameter | Type | Required | Description |
|---|---|---|---|
page_id |
integer | yes | Numeric page id the comment lives on. |
comment_id |
integer | yes | Root comment id whose reply thread to fetch. |
limit |
integer | Max replies (0 = configured cap). |
wiki_comments_thread_get¶
Get Wiki comment thread from the server · read-only
The thread of a comment as the Wiki server returns it — an empty list for every real thread.
Checked live on 2026-10-02: the server's /thread endpoint has no replies to give, for a
root comment or a reply, plain or inline. Use comments_thread_list, which rebuilds the
thread from the page's comment list.
| Parameter | Type | Required | Description |
|---|---|---|---|
page_id |
integer | yes | Numeric page id the comment lives on. |
comment_id |
integer | yes | Comment id whose server-side thread to fetch. |
limit |
integer | Max comments (0 = configured cap). |
wiki_comments_create¶
Create Wiki comment · write
Add a comment (or a threaded reply) to a wiki page.
Pass body.parent_id to reply to an existing comment — find ids with
comments_list. Returns the created comment with its numeric id.
| Parameter | Type | Required | Description |
|---|---|---|---|
page_id |
integer | yes | Numeric id of the page to comment on. |
body |
object | yes | The comment: required body text plus optional placement — inline_text (pin to a page fragment), parent_id (reply), thread_id. |
wiki_comments_delete¶
Delete Wiki comment · destructive write
Delete a comment from a wiki page — irreversible (no recovery token).
Returns the page's remaining comments_count. Verify the target with
comments_list / comments_thread_list first: deleting a parent orphans its
replies' threading.
| Parameter | Type | Required | Description |
|---|---|---|---|
page_id |
integer | yes | Numeric id of the page the comment lives on. |
comment_id |
integer | yes | Numeric id of the comment to delete. |
wiki_attachments_list¶
List Wiki attachments · read-only
Attachments (name, size, mime type) on a page id, auto-paginated (drains next_cursor).
Capped at the configured item cap unless limit is given. This is the list surface;
downloading an attachment's bytes is CLI/SDK-only (binary blobs are not an MCP payload).
| Parameter | Type | Required | Description |
|---|---|---|---|
page_id |
integer | yes | Numeric page id, from pages_meta or a page ref. |
limit |
integer | Max attachments to return; 0 means the configured cap (YCLI__HTTP__MAX_ITEMS). | |
order_by |
string | Sort field: name, size or created_at. |
|
order_direction |
string | Sort direction for order_by: asc or desc. |
wiki_attachments_get¶
Get Wiki attachment · read-only
Metadata of one attachment (GET /pages/{id}/attachments/{file_id}).
Name, size, MIME type, download URL, whether a preview exists and the virus-check status.
Yandex does not document this operation (it is in the live OpenAPI only) and may change it.
Fetching the bytes (download, preview) is CLI/SDK-only.
| Parameter | Type | Required | Description |
|---|---|---|---|
page_id |
integer | yes | Numeric id of the page the file is attached to. |
file_id |
integer | yes | Numeric id of the attachment. |
wiki_attachments_attach¶
Attach uploaded files to Wiki page · write
Attach file(s) from finished upload sessions to a wiki page.
The final step of the upload pipeline: create the session (uploadsessions_create),
send the bytes (uploadsessions_upload_part), close it (uploadsessions_finish),
then attach here. For one small file, attachments_upload runs the whole pipeline in
a single call. Returns the newly-attached files.
| Parameter | Type | Required | Description |
|---|---|---|---|
page_id |
integer | yes | Numeric id of the page to attach to. |
session_ids |
array of string | yes | session_id of each FINISHED upload session to attach. |
wiki_attachments_upload¶
Upload file to Wiki page · write
Upload one small file and attach it to a wiki page in a single call.
Runs the whole pipeline end to end: opens an upload session sized to data, PUTs the
bytes as a single part, finishes the session, and attaches it to the page. Small-file
path — for large files drive uploadsessions_create / uploadsessions_upload_part
(chunked) / uploadsessions_finish + attachments_attach yourself. Returns the
newly-attached files.
| Parameter | Type | Required | Description |
|---|---|---|---|
page_id |
integer | yes | Numeric id of the page to attach the file to. |
file_name |
string | yes | Name to give the uploaded file. |
data |
string | yes | The file's bytes, base64-encoded. |
wiki_attachments_delete¶
Delete Wiki attachment · destructive write
Delete an attachment from a wiki page — irreversible (no recovery token).
The API answers 204 No Content; a typed acknowledgement is returned instead. Find
file_id with attachments_list and double-check it before calling.
| Parameter | Type | Required | Description |
|---|---|---|---|
page_id |
integer | yes | Numeric id of the page the file is attached to. |
file_id |
integer | yes | Numeric id of the attachment to delete. |
wiki_resources_list¶
List Wiki page resources · read-only
A page's resources — attachments AND grids — as {type, item} envelopes, auto-paginated.
The unified single-pass listing over what attachments_list and pages_grids_list
expose separately (drains next_cursor internally). Capped at the configured item cap
unless limit is given; narrow with q (title) or types (attachment,grid).
| Parameter | Type | Required | Description |
|---|---|---|---|
page_id |
integer | yes | Numeric page id whose resources to list. |
limit |
integer | Max resources (0 = configured cap). | |
q |
string | Optional title search filter. | |
types |
string | Comma-separated kinds to include: attachment,grid. |
|
order_by |
string | Sort field: name_title or created_at. |
|
order_direction |
string | Sort direction for order_by: asc or desc. |
wiki_recovery_restore¶
Restore deleted Wiki page · write
Undo a page delete: redeem a recovery_token and bring the page back.
pages_delete returns the token — it is the only handle to the deleted page. Returns
the restored page's numeric id and permanent slug, and pages_count, how many pages
came back (the page and those under it). No request body; the token in
the path is the whole request.
| Parameter | Type | Required | Description |
|---|---|---|---|
token |
string | yes | UUID4 recovery_token returned by pages_delete. |
wiki_search_query¶
Search Wiki · read-only
Full-text search over wiki pages and files; returns one page of hits.
Each hit has the page slug (read it with pages_get), title, a content
snippet, the type and modified_at. For the next page pass next_cursor back as
cursor; stop at the first page without hits, because next_cursor stays set after an
empty page. A new page can take seconds to appear in the index.
| Parameter | Type | Required | Description |
|---|---|---|---|
text |
string | yes | Text to search for. |
filters |
object or null | Narrow the search by type, authors, cluster (a page slug), created_at / modified_at (a window with both from and to) and show_obsolete. |
|
order_by |
relevancy · creation_date · modified_date |
How to sort the hits. | |
highlight |
boolean | Wrap the matches in <em> tags in title and content. |
|
limit |
integer | Hits per page. | |
cursor |
integer | Number of the result page to fetch, from 1. |
wiki_grids_get¶
Get Wiki grid · read-only
A single dynamic table (grid) by its UUID, with structure, rows and revision.
Grids are the modern dynamic tables attached to a page; find a grid's id with
pages_grids_list. Use filter/only_cols/only_rows/sort to narrow large
grids server-side, and fields=attributes,user_permissions for extra blocks. The returned
revision is the optimistic-lock token any subsequent write (via the CLI/SDK) must echo.
| Parameter | Type | Required | Description |
|---|---|---|---|
grid_id |
string | yes | The grid's permanent UUID4 id. |
fields |
string or null | Extra blocks to include (CSV), e.g. attributes,user_permissions. |
|
row_filter |
string or null | Server-side row filter, e.g. [slug] ~ wiki. |
|
only_cols |
string or null | Return only these column slugs (CSV). | |
only_rows |
string or null | Return only these row ids (CSV). | |
sort |
string or null | Row sort, e.g. slug,-slug2. |
wiki_grids_create¶
Create Wiki grid · write
Create an empty dynamic table (grid) as a resource of a page.
A new grid has no rows or columns — add them afterwards with grids_columns_add and
grids_rows_add. Returns the created grid; its revision seeds the optimistic lock
every subsequent write must echo.
| Parameter | Type | Required | Description |
|---|---|---|---|
body |
object | yes | Grid spec: title plus the page (by id or slug) to live on. |
wiki_grids_update¶
Update Wiki grid · idempotent write
Rename or re-sort a grid (POST-not-PATCH quirk handled by the SDK).
body.revision must match the grid's current revision (read it off grids_get);
a mismatch fails the write. Returns the grid's new revision.
| Parameter | Type | Required | Description |
|---|---|---|---|
grid_id |
string | yes | The grid's permanent UUID4 id. |
body |
object | yes | Editable fields (title, default_sort) plus the required revision (optimistic lock). |
wiki_grids_delete¶
Delete Wiki grid · destructive write
Delete a grid — irreversible (grids have NO recovery token, unlike pages).
Verify the target with grids_get first. The API answers 204 No Content; the
result is a typed acknowledgement.
| Parameter | Type | Required | Description |
|---|---|---|---|
grid_id |
string | yes | The grid's permanent UUID4 id. |
wiki_grids_rows_add¶
Add Wiki grid rows · write
Insert rows into a grid at a position (default: append at the end).
Column slugs come from grids_get's structure block. Returns the created rows plus
the grid's new revision.
| Parameter | Type | Required | Description |
|---|---|---|---|
grid_id |
string | yes | The grid's permanent UUID4 id. |
body |
object | yes | rows (each maps column slug → cell value) + revision; optional position / after_row_id placement. |
wiki_grids_rows_remove¶
Remove Wiki grid rows · destructive write
Delete rows from a grid by id — irreversible.
A rare DELETE-with-body: ids and revision travel in the JSON body. Find row ids with
grids_get. Returns the grid's new revision.
| Parameter | Type | Required | Description |
|---|---|---|---|
grid_id |
string | yes | The grid's permanent UUID4 id. |
body |
object | yes | row_ids to delete (at least one) + the current revision. |
wiki_grids_rows_move¶
Move Wiki grid rows · write
Reorder rows inside a grid (move a run of consecutive rows to a new position).
Returns the grid's new revision.
| Parameter | Type | Required | Description |
|---|---|---|---|
grid_id |
string | yes | The grid's permanent UUID4 id. |
body |
object | yes | row_id (first row to move) + destination (position or after_row_id) + optional rows_count + the current revision. |
wiki_grids_columns_add¶
Add Wiki grid columns · write
Add columns to a grid at a position (default: append after the last column).
Each column needs a title and a type (string, number, select,
staff, date, checkbox, ticket_field, …); type-specific fields such as
select_options shape it further. Returns the grid's new revision.
| Parameter | Type | Required | Description |
|---|---|---|---|
grid_id |
string | yes | The grid's permanent UUID4 id. |
body |
object | yes | columns (each needs title + type) + the current revision; optional position. |
wiki_grids_columns_remove¶
Remove Wiki grid columns · destructive write
Delete columns from a grid by slug — irreversible (every cell in them is lost).
A rare DELETE-with-body: slugs and revision travel in the JSON body. Returns the grid's
new revision.
| Parameter | Type | Required | Description |
|---|---|---|---|
grid_id |
string | yes | The grid's permanent UUID4 id. |
body |
object | yes | column_slugs to delete + the current revision. |
wiki_grids_columns_move¶
Move Wiki grid columns · write
Reorder columns inside a grid (move a run of consecutive columns to a new position).
Returns the grid's new revision.
| Parameter | Type | Required | Description |
|---|---|---|---|
grid_id |
string | yes | The grid's permanent UUID4 id. |
body |
object | yes | column_slug (first column to move) + position + optional columns_count + the current revision. |
wiki_grids_cells_update¶
Update Wiki grid cells · idempotent write
Set the value of individual grid cells (addressed by row id + column slug).
Repeating the same call sets the same values (idempotent). Returns the updated cells
plus the grid's new revision.
| Parameter | Type | Required | Description |
|---|---|---|---|
grid_id |
string | yes | The grid's permanent UUID4 id. |
body |
object | yes | cells (each: row_id + column_slug + value) + the current revision. |
wiki_grids_clone¶
Clone Wiki grid · write
Copy a grid onto another page (POST /grids/{id}/clone — asynchronous).
body.with_data=true copies the rows as well as the structure. Returns a deferred
operation reference — poll operations_gridclone_get with the returned
operation.id until it reaches a terminal status.
| Parameter | Type | Required | Description |
|---|---|---|---|
grid_id |
string | yes | The grid's permanent UUID4 id. |
body |
object | yes | Clone spec: target page slug (created if absent) + optional title and with_data (copy rows too). |
wiki_grids_columns_suggest¶
Suggest Wiki grid column slug · read-only
Check whether a column slug is free in a grid and get free alternatives (read-only).
The call is a POST but changes nothing. Yandex does not document this operation (it is in the live OpenAPI only) and may change it.
| Parameter | Type | Required | Description |
|---|---|---|---|
grid_id |
string | yes | The grid's permanent UUID4 id. |
body |
object | yes | slug to check, or a title to turn into a slug and check. |
wiki_grids_columns_update¶
Update Wiki grid column · idempotent write
Edit a grid column in place: only the fields sent change; its type and slug stay.
Repeating the same call leaves the same column (idempotent). revision is accepted but not
enforced, and every call moves the grid's revision on. Returns the grid's new revision and
the column as saved. Yandex does not document this operation (it is in the
live OpenAPI only) and may change it.
| Parameter | Type | Required | Description |
|---|---|---|---|
grid_id |
string | yes | The grid's permanent UUID4 id. |
column_slug |
string | yes | Slug of the column to edit. |
body |
object | yes | The fields to change (title, description, required, width, color, pinned, select_options, …); revision is optional. |
wiki_grids_rows_update¶
Update Wiki grid row · idempotent write
Pin or colour one grid row (cell values are set by grids_cells_update).
Repeating the same call leaves the same row (idempotent). The reply is a bare acknowledgement
without the new revision (read it with grids_get); revision is accepted but not
enforced. Yandex does not document this operation (it is in the live OpenAPI only) and may
change it.
| Parameter | Type | Required | Description |
|---|---|---|---|
grid_id |
string | yes | The grid's permanent UUID4 id. |
row_id |
string | yes | Id of the row to pin or colour. |
body |
object | yes | pinned and/or color to set; revision is optional. |
wiki_operations_clone_get¶
Get Wiki page-clone status · read-only
Status of an async page-clone operation — poll it until it finishes.
pages clone (a CLI/SDK write) returns an operation.id; pass it here and re-read until
status is success or failed. On success the result.page names the clone.
The sibling operations_gridclone_get polls inline-grid clones instead.
| Parameter | Type | Required | Description |
|---|---|---|---|
task_id |
string | yes | Task id from a page-clone trigger (operation.id). |
wiki_operations_gridclone_get¶
Get Wiki grid-clone status · read-only
Status of an async inline-grid-clone operation — poll it until it finishes.
grids clone (a CLI/SDK write) returns an operation.id; pass it here and re-read until
status is success or failed. On success the result.grid_id names the copy.
The sibling operations_clone_get polls page clones instead.
| Parameter | Type | Required | Description |
|---|---|---|---|
task_id |
string | yes | Task id from a grid-clone trigger (operation.id). |
wiki_operations_move_get¶
Get Wiki page-move status · read-only
Status of an async page-move operation — poll it until it finishes.
pages_move returns an operation.id; pass it here and re-read until status is
success or failed. On success the result.page_count says how many pages moved.
This operation is undocumented by Yandex (it is in the live OpenAPI only) and may change.
| Parameter | Type | Required | Description |
|---|---|---|---|
task_id |
string | yes | Task id from a page-move trigger (operation.id). |
wiki_uploadsessions_get¶
Get Wiki upload session · read-only
Current state of a Wiki file upload session by its UUID (status, file name/size, storage).
Poll this to watch a session move not_started → in_progress → finished before the
file is attached to a page.
| Parameter | Type | Required | Description |
|---|---|---|---|
session_id |
string | yes | UUID4 of the upload session to inspect. |
wiki_uploadsessions_create¶
Create Wiki upload session · write
Open an upload session — step 1 of the Wiki file-upload pipeline.
The returned session_id addresses the session for uploadsessions_upload_part /
uploadsessions_finish. For a single small file, attachments_upload runs the whole
pipeline in one call instead.
| Parameter | Type | Required | Description |
|---|---|---|---|
body |
object | yes | file_name + total file_size in bytes (sum of every part). |
wiki_uploadsessions_upload_part¶
Upload Wiki file part · idempotent write
Upload one file part to an open session — step 2 of the upload pipeline.
The base64 data is decoded and sent as raw application/octet-stream bytes.
Parts may be 5-16 MB except the last; a small file fits in a single part_number=1
call. Returns the session (poll status via uploadsessions_get).
| Parameter | Type | Required | Description |
|---|---|---|---|
session_id |
string | yes | UUID4 of the upload session. |
part_number |
integer | yes | 1-based part index (1 for the first part, +1 for each next). |
data |
string | yes | This part's bytes, base64-encoded. |
wiki_uploadsessions_finish¶
Finish Wiki upload session · write
Close an upload session after its last part — step 3 of the upload pipeline.
Only a finished session can be attached to a page (attachments_attach). Returns the
session with its final status.
| Parameter | Type | Required | Description |
|---|---|---|---|
session_id |
string | yes | UUID4 of the upload session. |
wiki_uploadsessions_abort¶
Abort Wiki upload session · destructive write
Cancel one in-progress upload session, discarding its uploaded parts.
Frees the session's quota; the session cannot be resumed afterwards. Returns the
session with status: aborted.
| Parameter | Type | Required | Description |
|---|---|---|---|
session_id |
string | yes | UUID4 of the upload session. |
wiki_uploadsessions_abort_all¶
Abort all Wiki upload sessions · destructive write
Cancel EVERY active upload session of the caller, discarding all uploaded parts.
A quota-freeing sweep — use it when stale sessions block new uploads; prefer
uploadsessions_abort to cancel a single known session.