API DocsWorkspace

Workspace

Files, folders, shares and mounted drives.

The workspace sits behind a feature release. Without it EVERY route here answers 404 NOT_FOUND, not 403: a gated route must not reveal that it exists. If you get 404 everywhere although the key is correct, the release is almost always the reason.

Files, folders, versions, shares and changes: the same store the /workspace UI shows, as an HTTP interface.

Everything is a node. A folder is a node with children, a file is a node with content. The id is the contract: it survives renames and moves. Build automation on ids, not on paths.

Every file carries a revision that increases by one on each write. Writing calls take the revision you last saw; if it no longer matches, the server answers 409 REVISION_CONFLICT instead of overwriting someone else's work. Re-read, re-apply your change, send again.

Authenticate with Authorization: Bearer YOUR-API-KEY or with a signed-in session. A key acts as the person who owns it: every file goes through the same permission check as in the browser, and that person's governance rules apply unchanged.

Anonymization is part of the contract, not an add-on. Every node carries anonymizationStatus and anonymizationStale. If your account configuration requires document anonymization, it is applied on upload even when your call does not ask for it.

Parameter	Type	Default	Description
`id`	`uuid`	-	Stable identifier of a node. Never changes, not on rename and not on move.
`type`	`"folder" \| "file"`	-	Folder or file. Decides which fields are set: childCount only on folders, sizeBytes and revision only on files.
`kind`	`"document" \| "presentation" \| "deck" \| "sheet" \| "sketch" \| "text" \| "markdown" \| "code" \| "pdf" \| "image" \| null`	-	The file kind, derived from the MIME type by the server. Do not rebuild it yourself or you maintain the same mapping twice.
`revision`	`integer`	-	Counter of the file content. Increases by one on every write and is the basis of every conflict check.
`role`	`"owner" \| "editor" \| "commenter" \| "viewer"`	-	Your role on this node, inherited along the folder chain. owner may do everything, editor may write, commenter may comment, viewer may read.
`projectId`	`uuid \| null`	-	Set when the node lives in a project space instead of the personal one. Moving between the two is not possible.
`mountId`	`uuid \| null`	-	Set when the node comes from a mounted drive. Such nodes belong to the source system: moving in or out is blocked.

1curl "https://app.anymize.ai/api/v1/workspace/usage" \
2  -H "Authorization: Bearer YOUR_API_KEY"

Nodes

Create, read, change and trash folders and files. This is the core of the API; everything else hangs off a node id.

List folder contents

Children of a folder, or the root when no parent is given. Folders carry childCount for the fill level, files the state of their preview.

GET/api/v1/workspace/nodes

Query

Parameter	Type	Default	Description
`parentId`	`uuid`	-	Parent folder. Omit for the root.
`projectId`	`uuid`	-	Project storage instead of personal storage.

200OK

{
  "nodes": [
    {
      "id": "1c9f6d2a-3b48-4c11-9a7e-2f5b8d0c4e63",
      "type": "folder",
      "name": "Angebote",
      "kind": null,
      "color": "teal",
      "icon": "chart",
      "childCount": 14,
      "thumbnailState": "unsupported",
      "updatedAt": "2026-08-11T09: 12: 00.000Z"
    },
    {
      "id": "7f2a5e91-0c6d-4b83-8e14-9d3f7a2c6b05",
      "type": "file",
      "name": "Q3.xlsx",
      "kind": "sheet",
      "sizeBytes": 48213,
      "revision": 3,
      "thumbnailState": "ready",
      "updatedAt": "2026-08-11T09: 20: 00.000Z"
    }
  ],
  "breadcrumbs": [],
  "role": "owner"
}

404 NOT_FOUND The node does not exist, or you may not see it. Both answer alike: an API that tells the two apart reveals the existence of other people's files.

1curl "https://app.anymize.ai/api/v1/workspace/nodes?parentId=1c9f6d2a-3b48-4c11-9a7e-2f5b8d0c4e63" \
2  -H "Authorization: Bearer YOUR_API_KEY"

Without parentId and without projectId you get the root of the personal space. System folders such as /memory and /agents only appear there when the account's developer mode is on.

Read one node

Metadata of a node. Breadcrumbs and content come only with content=1.

GET/api/v1/workspace/nodes/:id

Query

Parameter	Type	Default	Description
`content`	`"1"`	-	With 1, Word files additionally return the editor content as JSON, including paragraph styles, headers and footers and comments.

200OK

{
  "node": {
    "id": "6f1c2b7e-9a44-4f0d-8f2b-1e7d3c5a9b10",
    "parentId": null,
    "projectId": null,
    "type": "file",
    "name": "Angebot Q3.docx",
    "mimeType": "application/vnd.openxmlformats-officedocument.wordprocessingml.document",
    "sizeBytes": 48213,
    "revision": 3,
    "starred": false,
    "color": null,
    "icon": null,
    "description": null,
    "trashedAt": null,
    "role": "owner",
    "updatedAt": "2026-08-24T09: 20: 00.000Z"
  }
}

404	`NOT_FOUND`	The node does not exist, or you may not see it. Both answer alike: an API that tells the two apart reveals the existence of other people's files.
415	`NOT_READABLE`	This file cannot be read as editor content. Download it instead.
422	`IMPORT_FAILED`	The document could not be translated into the editor form. Downloading and opening it in Word still works.
502	`BLOB_UNAVAILABLE`	The row is alive, the stored object is not. Not a fault of your call; report the file if this happens repeatedly.

content=1 loads and translates the entire OOXML package. That is too expensive for a plain file list: fetch metadata without the parameter.

Create folder or file

Creates a folder, or an empty Word, Excel or PowerPoint file from the matching template.

POST/api/v1/workspace/nodes

Body

Parameter	Type	Default	Description
`kind`required	`"folder" \| "doc" \| "sheet" \| "slides" \| "sketch"`	-	Kind of the new node.
`name`required	`string (1-255)`	-	Name, up to 255 characters.
`parentId`	`uuid \| null`	-	Parent folder. Omit for the root.
`projectId`	`uuid \| null`	-	Project storage instead of personal storage.
`sheetName`	`string (1-31)`	-	Name of the first worksheet in a new workbook. Defaults to Tabelle1.

201Created

{
  "node": {
    "id": "6f1c2b7e-9a44-4f0d-8f2b-1e7d3c5a9b10",
    "parentId": null,
    "projectId": null,
    "type": "file",
    "name": "Angebot Q3.docx",
    "mimeType": "application/vnd.openxmlformats-officedocument.wordprocessingml.document",
    "kind": "document",
    "sizeBytes": 48213,
    "revision": 3,
    "starred": false,
    "isAnonymized": false,
    "anonymizationStatus": "none",
    "anonymizationStale": false,
    "color": null,
    "icon": null,
    "childCount": null,
    "thumbnailState": "ready",
    "updatedAt": "2026-08-24T09: 20: 00.000Z",
    "createdAt": "2026-08-11T09: 12: 00.000Z"
  }
}

400	`INVALID_BODY`	The body does not match the expected schema.
403	`FORBIDDEN`	You may not write in the target folder.
413	`QUOTA_EXCEEDED`	The account storage is full, or the file would blow it. Trash and kept versions count towards it.

1curl -X POST "https://app.anymize.ai/api/v1/workspace/nodes" \
2  -H "Authorization: Bearer YOUR_API_KEY" \
3  -H "Content-Type: application/json" \
4  -d '{"kind":"sheet","name":"Umsatz Q3","parentId":null}'

The server sets the file extension. A name without .docx, .xlsx or .pptx gets it appended; a name that already carries it is left alone.

Update a node

Rename, star, set the folder appearance, or save editor content. Exactly one of these shapes per call.

PATCH/api/v1/workspace/nodes/:id

Body

Parameter	Type	Default	Description
`name`	`string (1-255)`	-	New name.
`parentId`	`uuid \| null`	-	Move. null means the root of the personal space.
`description`	`string (0-2000) \| null`	-	Free-text description, at most 2000 characters. null removes it.
`starred`	`boolean`	-	Set or clear the personal star.
`color`	`string \| null`	-	Folder colour key (amber, tuareg, teal, green, red, purple, pink, slate). null resets it.
`icon`	`string \| null`	-	Folder icon key (star, team, project, document, image, chart, money, lock, code, cloud, flag, heart). null removes the icon.
`agentRead`	`boolean \| null`	-	Folder lock: may agents read here? null means the setting is inherited from above.
`agentWrite`	`boolean \| null`	-	Folder lock: may agents write here? null means the setting is inherited from above.
`doc`	`object`	-	Editor content; also requires revision.
`revision`	`integer`	-	The revision your change is based on. Required for every content write.

400	`INVALID_BODY`	The body carries none or more than one of the allowed shapes.
403	`FORBIDDEN`	You lack the permission for this change. Moving and the agent lock are reserved for the owner.
409	`REVISION_CONFLICT`	Someone changed the file in the meantime. Re-read, apply your change to the new state and send again.
400	`NOT_A_FOLDER`	Colour and icon exist on folders only. The server rejects them on a file instead of silently swallowing them.
422	`SCOPE_CHANGE`	Source and target lie in different scopes. Moving between personal and project space is not provided for.
422	`MOUNT_TARGET`	Source or target belongs to a mounted drive. The next sync would take the move apart.

1curl -X PATCH "https://app.anymize.ai/api/v1/workspace/nodes/1c9f6d2a-3b48-4c11-9a7e-2f5b8d0c4e63" \
2  -H "Authorization: Bearer YOUR_API_KEY" \
3  -H "Content-Type: application/json" \
4  -d '{"color":"teal","icon":"chart"}'

Exactly ONE form per call, and we mean it: the server takes the first form that fits the body (order: name, starred, parentId, description, appearance) and SILENTLY drops every further field. A body with name and parentId only renames, answers 200 and does not move anything. So send exactly one field per call.

Color and icon apply to folders only. They are ignored for files.

Only the owner may move, and only within the same scope. Switching between personal and project space answers 422 SCOPE_CHANGE; a mounted drive as source or target answers 422 MOUNT_TARGET.

Move to trash

Moves the node to the trash. For a folder the whole subtree goes with it.

DELETE/api/v1/workspace/nodes/:id

404 NOT_FOUND The node does not exist, or you may not see it. Both answer alike: an API that tells the two apart reveals the existence of other people's files.

Nothing disappears at once. Nodes in the trash keep counting against storage and are removed for good after 30 days.

Restore from trash

Puts the node back where it was. If the parent folder is gone it lands in the root.

POST/api/v1/workspace/nodes/:id/restore

404 NOT_FOUND The node does not exist, or you may not see it. Both answer alike: an API that tells the two apart reveals the existence of other people's files.

Delete permanently

Irreversibly removes a node that is already in the trash, together with all kept versions.

DELETE/api/v1/workspace/nodes/:id/permanent

404	`NOT_FOUND`	The node does not exist, or you may not see it. Both answer alike: an API that tells the two apart reveals the existence of other people's files.
409	`NOT_IN_TRASH`	The node is not in the trash.
409	`PURGE_CONFLICT`	The node is being changed right now. Try again shortly.

There is no way back. The node must be in the trash first, otherwise the route answers 409 NOT_IN_TRASH.

Add a star

Personal star. Read access is enough: whoever may see a node may star it for themselves. Idempotent.

PUT/api/v1/workspace/nodes/:id/star

200OK

{
  "starred": true
}

Remove the star

Removes the personal star. Idempotent.

DELETE/api/v1/workspace/nodes/:id/star

200OK

{
  "starred": false
}

Paths

The id is the contract, the path is the convenience. When you only know a file by its name, resolve it to an id once and work with that afterwards.

A path changes on rename and on move, an id never does. Store ids in your automation; use paths only where a human types them in.

Resolve a path to an id

Takes a path such as /Vertraege/Miete.docx and returns the node together with breadcrumbs. Meant as an entry point: afterwards you work with the returned id.

GET/api/v1/workspace/nodes/by-path

Query

Parameter	Type	Default	Description
`path`required	`string`	-	Absolute path starting with /. Segments are matched against child names, case-insensitively. A lone / means the root.
`children`	`"1"`	-	With 1, a folder additionally returns its direct children, saving the second call.

200OK

{
  "node": {
    "id": "7f2a5e91-0c6d-4b83-8e14-9d3f7a2c6b05",
    "type": "file",
    "name": "Miete.docx",
    "kind": "document",
    "revision": 4
  },
  "path": "/Vertraege/Miete.docx",
  "breadcrumbs": [
    {
      "id": "1c9f6d2a-3b48-4c11-9a7e-2f5b8d0c4e63",
      "name": "Vertraege"
    }
  ],
  "role": "owner"
}

400	`INVALID_PATH`	The path is empty, goes deeper than 32 levels, contains a segment made only of dots, or a forbidden character. A missing leading slash, by contrast, is allowed.
404	`NOT_FOUND`	A segment of the path does not exist, or you may not see it. Both answer alike so the route does not reveal other people's folder names.

1curl -G "https://app.anymize.ai/api/v1/workspace/nodes/by-path" \
2  --data-urlencode "path=/Vertraege/Miete.docx" \
3  -H "Authorization: Bearer YOUR_API_KEY"

This route works only inside the personal space of the signed-in account. For project spaces and shared trees use the node endpoints.

Path-based operations

One endpoint for reading, writing, replacing, creating, moving and deleting via paths: the same route the agent tools take. Handy for text files and workbooks when you do not want to manage ids.

POST/api/v1/workspace/fs

Body

Parameter	Type	Default	Description
`aktion`required	`"read" \| "write" \| "edit" \| "manage" \| "create_xlsx" \| "update_xlsx"`	-	Which operation. read reads a text file, write creates or replaces it, edit swaps a passage, manage creates folders, moves and deletes, create_xlsx and update_xlsx write workbooks.
`path`	`string`	-	Absolute path inside the personal space.
`content`	`string`	-	The complete new content for aktion=write.
`alt / neu`	`string`	-	For aktion=edit: alt is the passage to replace, neu the replacement. If alt occurs more than once you need alle_vorkommen.
`unteraktion`	`"mkdir" \| "move" \| "delete"`	-	For aktion=manage: mkdir creates a folder, move moves to to, delete puts it in the trash.
`name`	`string (1-200)`	-	Only with aktion=create_xlsx: name of the new workbook, at most 200 characters.
`folder_id`	`uuid \| null`	-	Only with aktion=create_xlsx: target folder. Without it, the root.
`workbook`	`object`	-	The workbook tree: sheets with rows and cells. Required for create_xlsx and update_xlsx.
`node_id`	`uuid`	-	Only with aktion=update_xlsx: which workbook is changed.
`revision`	`integer`	-	Only with aktion=update_xlsx: the revision your change is based on.

403	`FORBIDDEN`	The path points outside the personal space, or a folder lock blocks the folder.
409	`REVISION_CONFLICT`	Someone changed the file in the meantime. Re-read, apply your change to the new state and send again.
409	`WOULD_DESTROY_CONTENT`	Only with aktion=update_xlsx. Full replacement is blocked because the workbook was not created by anymize, or it carries content we cannot rebuild without loss (charts, merged cells). The hint names the reason. For targeted cell changes use PATCH /nodes/:id/sheet.
415	`NOT_A_XLSX`	The file is not an Excel workbook.

This route works only inside the personal space of the signed-in account. For project spaces and shared trees use the node endpoints.

Upload, download, delete

Getting content in and out again. Small files in one call, large ones in chunks, plus export to nine formats.

A single file may be 50 MiB, an account 2 GiB in total across at most 5000 files. Above roughly 8 MiB use the resumable session instead of a single call.

Upload a file

Creates a new file and generates its thumbnail in the same step. The server checks that the content matches the extension and rejects zip packages with a suspicious compression ratio.

POST/api/v1/workspace/upload

Request: multipart/form-data

Body

Parameter	Type	Default	Description
`file`required	`File`	-	The file content as the form field file.
`parentId`	`uuid`	-	Parent folder. Omit for the root.
`projectId`	`uuid`	-	Project storage instead of personal storage.
`withAnonymization`	`"true" \| "1"`	-	Asks for the document to be anonymized on upload.

400	`FILE_MISSING`	The form has no file field, or it does not contain a file.
413	`FILE_TOO_LARGE`	The file exceeds 50 MiB.
415	`CONTENT_MISMATCH`	The content does not match the file extension. A PDF named .docx is rejected so the editor does not choke on it later.
415	`ZIP_RATIO_SUSPICIOUS`	The Office package expands suspiciously far, holds too many entries or is too large when unpacked.

1curl -X POST "https://app.anymize.ai/api/v1/workspace/upload" \
2  -H "Authorization: Bearer YOUR_API_KEY" \
3  -F "file=@Angebot.docx" \
4  -F "parentId=1c9f6d2a-3b48-4c11-9a7e-2f5b8d0c4e63"

When the compliance setting force_document_anonymization applies to this account, anonymization happens regardless of what your call says. Do not rely on getting the raw text back.

Replace file content

Rewrites the raw bytes of an existing file without creating a second node. The previous state moves into the versions and the revision goes up by one.

PUT/api/v1/workspace/nodes/:id/content

Request: application/octet-stream

Query

Parameter	Type	Default	Description
`revision`	`integer`	-	The revision you last saw. If it differs the server answers 409 instead of overwriting. Leave it out and you overwrite blindly.

200OK

{
  "node": {
    "id": "7f2a…",
    "revision": 5,
    "sizeBytes": 51200
  }
}

403	`FORBIDDEN`	You have no write permission on this node.
409	`REVISION_CONFLICT`	Someone changed the file in the meantime. Re-read, apply your change to the new state and send again.
413	`FILE_TOO_LARGE`	The file exceeds 50 MiB.
415	`CONTENT_MISMATCH`	The content does not match the file extension. A PDF named .docx is rejected so the editor does not choke on it later.

1curl -X PUT "https://app.anymize.ai/api/v1/workspace/nodes/7f2a5e91-0c6d-4b83-8e14-9d3f7a2c6b05/content?revision=4" \
2  -H "Authorization: Bearer YOUR_API_KEY" \
3  -H "Content-Type: application/octet-stream" \
4  --data-binary @Angebot.docx

Without ?revision the call writes over any state. For a file nobody but you works on that is fine; everywhere else pass the revision.

Start a resumable upload

Creates an upload session. You get back an address to send the file to in ranges; if the connection drops you continue at the same offset instead of starting over.

POST/api/v1/workspace/uploads

Body

Parameter	Type	Default	Description
`name`required	`string (1-255)`	-	Name, up to 255 characters.
`sizeBytes`required	`integer`	-	The total size of the file in bytes. The server checks it upfront against the file limit and the quota instead of rejecting you after the last chunk.
`parentId`	`uuid \| null`	-	Parent folder. Omit for the root.
`projectId`	`uuid \| null`	-	Project storage instead of personal storage.
`nodeId`	`uuid`	-	Instead of creating a new file, replace the content of this existing node.
`revision`	`integer`	-	The revision you last saw. If it differs the server answers 409 instead of overwriting. Leave it out and you overwrite blindly.

201Created

{
  "uploadUrl": "https://app.anymize.ai/api/v1/workspace/uploads/8f4c1a02-77d3-4b6e-9c31-5ad0e2f81b64",
  "sessionId": "8f4c1a02-77d3-4b6e-9c31-5ad0e2f81b64",
  "expiresAt": "2026-08-24T11: 20: 00.000Z",
  "chunkSizeBytes": 8388608,
  "nextExpectedRanges": [
    "0-"
  ]
}

413	`FILE_TOO_LARGE`	The file exceeds 50 MiB.
413	`QUOTA_EXCEEDED`	The account storage is full, or the file would blow it. Trash and kept versions count towards it.
415	`BLOCKED_TYPE`	Files of this type are blocked in the workspace: executable, macro-enabled or scriptable.
415	`UNSUPPORTED_TYPE`	The extension is not on the allowlist, or the name has none at all.

A session lives one hour from the last chunk. The server names its preferred chunk size in chunkSizeBytes; stick to it unless you have a reason not to.

Send one range

Sends one range of the file. The Content-Range header says which one. While something is still missing the server answers 202 and names where to continue in nextExpectedRanges; with the last range it answers 201 and returns the finished node.

PUT/api/v1/workspace/uploads/:sessionId

Request: application/octet-stream

202Accepted

{
  "sessionId": "8f4c1a02…",
  "nextExpectedRanges": [
    "8388608-"
  ],
  "expiresAt": "2026-08-24T11: 20: 00.000Z"
}

201Created

{
  "node": {
    "id": "7f2a…",
    "name": "Praesentation.pptx",
    "revision": 1,
    "sizeBytes": 41943040
  }
}

400	`INVALID_RANGE`	The Content-Range header is missing or unreadable.
404	`SESSION_NOT_FOUND`	This session does not exist, or it belongs to another account.
409	`RANGE_MISMATCH`	The range sent does not start where the last one ended. The response names the right offset in nextExpectedRanges.
409	`REVISION_CONFLICT`	Someone changed the file in the meantime. Re-read, apply your change to the new state and send again.
410	`SESSION_EXPIRED`	The session has expired. Start a new one; the chunks already sent are discarded.
413	`QUOTA_EXCEEDED`	The account storage is full, or the file would blow it. Trash and kept versions count towards it.
415	`CONTENT_MISMATCH`	The content does not match the file extension. A PDF named .docx is rejected so the editor does not choke on it later.

1curl -X PUT "https://app.anymize.ai/api/v1/workspace/uploads/8f4c1a02-77d3-4b6e-9c31-5ad0e2f81b64" \
2  -H "Authorization: Bearer YOUR_API_KEY" \
3  -H "Content-Range: bytes 0-8388607/41943040" \
4  -H "Content-Type: application/octet-stream" \
5  --data-binary @teil-1.bin

Content-Range has the form bytes FROM-TO/TOTAL, with to inclusive. Ranges must arrive gapless and in order; re-sending a range that was already accepted is allowed and changes nothing.

Query the state of a session

Says how many bytes arrived gapless and where to continue. After a client crash this is the only question that matters: without it, starting blindly from zero is all that is left.

GET/api/v1/workspace/uploads/:sessionId

200OK

{
  "sessionId": "8f4c1a02-77d3-4b6e-9c31-5ad0e2f81b64",
  "name": "Praesentation.pptx",
  "sizeBytes": 41943040,
  "receivedBytes": 16777216,
  "nextExpectedRanges": [
    "16777216-"
  ],
  "chunkSizeBytes": 8388608,
  "expiresAt": "2026-08-24T11: 20: 00.000Z"
}

404	`SESSION_NOT_FOUND`	This session does not exist, or it belongs to another account.
410	`SESSION_EXPIRED`	The session has expired. Start a new one; the chunks already sent are discarded.

Abort the session

Aborts the session and clears the chunks already sent. Without this call the one-hour expiry does it by itself.

DELETE/api/v1/workspace/uploads/:sessionId

Download and export

Without format the file comes exactly as stored. With format it is converted.

GET/api/v1/workspace/nodes/:id/download

Response: application/octet-stream

Query

Parameter	Type	Default	Description
`format`	`"docx" \| "pdf" \| "odt" \| "rtf" \| "epub" \| "md" \| "txt" \| "html" \| "csv"`	-	Target format of the conversion. Without it the original file comes back.
`sheet`	`string \| integer`	-	Only with format=csv: which worksheet, by name or by zero-based index. Without it the first visible one.

400	`INVALID_FORMAT`	The server does not know the requested format, or format was given more than once.
400	`INVALID_QUERY`	A query parameter is missing, given twice or unreadable.
415	`NOT_EXPORTABLE`	The requested format does not exist for this file type.
502	`CONVERSION_FAILED`	The converter could not process the file. Retrying rarely helps; download the original instead.
503	`CONVERTER_UNAVAILABLE`	The conversion service is not answering right now. This is temporary: try again later.

1curl "https://app.anymize.ai/api/v1/workspace/nodes/7f2a5e91-0c6d-4b83-8e14-9d3f7a2c6b05/download?format=pdf" \
2  -H "Authorization: Bearer YOUR_API_KEY" \
3  -o Angebot.pdf

CSV is the only export for Excel workbooks and always returns exactly ONE sheet. The other eight formats apply to Word documents.

Create a copy

Creates a copy of a file. The copy starts at revision 1 and carries neither the versions nor the comments of the original.

POST/api/v1/workspace/nodes/:id/copy

Body

Parameter	Type	Default	Description
`name`required	`string (1-255)`	-	Name of the copy. The original extension is kept.

400	`NOT_A_FILE`	The node is a folder; this endpoint only works on files.
409	`NAME_TAKEN`	That name already exists in the target folder.

The copy always lands in the folder of the original. To put it elsewhere, move it afterwards with PATCH and parentId.

File preview

Serves the finished preview image. It is generated on upload, not on request - that is why it appears instantly.

GET/api/v1/workspace/nodes/:id/thumbnail

Response: image/webp

404 NO_THUMBNAIL There is no thumbnail. The state field of the response says why: unsupported for formats without one, failed after a failure.

thumbnailState separates the cases: pending = still being generated, ready = available, unsupported = no preview for this format, failed = generation failed. For the last two the route answers 404 so your UI falls back to a format icon instead of loading forever.

Presentation preview

Renders a PowerPoint file as PDF so you can display it without downloading. The result is cached per node and revision.

GET/api/v1/workspace/nodes/:id/preview

Response: application/pdf

404	`UNSUPPORTED_TYPE`	Only presentations have such a preview.
503	`PREVIEW_UNAVAILABLE`	The conversion failed. Temporary; you can still download the original.

Get an Office view

Private view of a DOCX, XLSX or PPTX file. Requires CoWork access and permission to read the file. The source and revision stay unchanged; responses are not cached.

GET/api/v1/workspace/nodes/:id/office-view

Response: application/pdf | Office MIME | application/json

Query

Parameter	Type	Default	Description
`view`	`"clear" \| "anonymized"`	`clear`	clear resolves your available mappings; missing values stay as placeholders. anonymized uses the text service to anonymize text. Images and embedded content stay unchanged.
`format`	`"pdf" \| "native" \| "metadata"`	`pdf`	pdf returns the styled preview; native returns the original Office format in the selected view. metadata returns revision, hasPlaceholders and canEdit as JSON.

200metadata

{
  "revision": 7,
  "hasPlaceholders": true,
  "canEdit": false
}

400	`INVALID_VIEW`	A query parameter is missing, given twice or unreadable.
404	`NOT_FOUND`	The node does not exist, or you may not see it. Both answer alike: an API that tells the two apart reveals the existence of other people's files.
415	`OFFICE_VIEW_UNSUPPORTED`	DOCX, XLSX and PPTX are supported.
503	`DOCUMENT_ANONYMIZATION_FAILED`	Text anonymization failed. No unanonymized fallback file is returned.

1curl "https://app.anymize.ai/api/v1/workspace/nodes/6f1c2b7e-9a44-4f0d-8f2b-1e7d3c5a9b10/office-view?view=anonymized&format=native" \
2  -H "Authorization: Bearer YOUR_API_KEY" \
3  -o Angebot.docx

The clear view is intended for the authenticated user. Use anonymized Workspace tools for models. Switching views does not save a change.

Save clear text as a new Office revision

Only after an explicit user action and with write permission: resolve all text placeholders and save a new revision. The previous version is retained. People with file access can see the original values. Missing mappings or a changed revision prevent the write.

POST/api/v1/workspace/nodes/:id/office-view

Request: application/json

Body

Parameter	Type	Default	Description
`baseRevision`required	`integer >= 0`	-	The revision your change is based on. Required for every content write.

200OK

{
  "revision": 8,
  "hasPlaceholders": false
}

403	`FORBIDDEN`	This request is not yours, or your role does not allow overriding.
409	`REVISION_CONFLICT`	Someone changed the file in the meantime. Re-read, apply your change to the new state and send again.
415	`OFFICE_VIEW_UNSUPPORTED`	DOCX, XLSX and PPTX are supported.
422	`OFFICE_MAPPINGS_UNAVAILABLE`	At least one of your mappings is missing or expired. The source file stays unchanged.

The clear view is intended for the authenticated user. Use anonymized Workspace tools for models. Switching views does not save a change.

Store an editor image

Stores an image meant to sit inside a document and returns its address. PNG, JPEG, GIF and WebP are allowed; the check reads the first bytes, not the name.

POST/api/v1/workspace/images

Request: multipart/form-data

Body

Parameter	Type	Default	Description
`file`required	`File (png, jpeg, gif, webp)`	-	The image as the form field file.

201Created

{
  "url": "/api/v1/workspace/images/9f3c…webp"
}

415 UNSUPPORTED_TYPE The content is not a PNG, JPEG, GIF or WebP.

Images are content-addressed: uploading the same image twice takes the space once. They therefore do not count against the account's file storage.

Fetch an image from a URL

Fetches an image from an https address and stores it exactly like an uploaded one.

POST/api/v1/workspace/images/from-url

Body

Parameter	Type	Default	Description
`url`required	`string (https)`	-	The source address. https only.

400	`INVALID_URL`	The address is unusable or not https.
502	`FETCH_FAILED`	The source did not answer, or answered with an error.

Addresses inside the internal network are blocked, redirects are re-checked at every hop, and the response is cut off at the image limit. This route is not a way to make the server fetch arbitrary addresses.

Fetch an editor image

Serves a stored image. Its address comes from the response of the store call.

GET/api/v1/workspace/images/:name

Response: image/*

Versions

Every write keeps the previous state. You can list, compare and roll back.

Rolling back asks first: taking someone else's work out of the current state raises a consent request instead of silently discarding it. Only when nobody but you has written does the rollback happen at once.

List versions

The kept versions of a file, newest first. Anyone who may see the file may read them.

GET/api/v1/workspace/versions

Query

Parameter	Type	Default	Description
`node_id`required	`uuid`	-	The file in question.

200OK

{
  "node_id": "7f2a5e91-0c6d-4b83-8e14-9d3f7a2c6b05",
  "current_revision": 5,
  "max_versionen": 10,
  "versions": [
    {
      "id": "b41f…",
      "revision": 4,
      "size_bytes": 51200,
      "actor": "user",
      "agent_id": null,
      "author": {
        "id": "9b2e…",
        "name": "Nora Berg"
      },
      "agent": null,
      "author_source": "direct",
      "pinned": false,
      "label": null,
      "created_at": "2026-08-24T09: 20: 00.000Z"
    }
  ]
}

400 NOT_A_FILE The node is a folder; this endpoint only works on files.

Which version is current is stated only in current_revision at the top of the response. The entries under versions are all SUPERSEDED states; none of them carries a flag for it.

Roll back to a version

Makes an older version the current state again, or first asks the person whose work would drop out of it.

POST/api/v1/workspace/versions

Body

Parameter	Type	Default	Description
`node_id`required	`uuid`	-	The file in question.
`revision`required	`integer`	-	The version that should apply again.

200art: wiederhergestellt

{
  "art": "wiederhergestellt",
  "revision": 5
}

200art: angefragt

{
  "art": "angefragt",
  "requestId": "5b1e…"
}

409	`ALREADY_PENDING`	A consent request is already running for this file.
409	`STALE`	Someone was faster: the state changed since you listed it.

The response carries an art field. On wiederhergestellt the new revision sits next to it; on angefragt there is NO revision, because nothing has been written yet. Always read art before touching revision.

Answer a consent request

approve agrees, reject declines, override goes ahead anyway. The three end in different states and read differently in an audit report: an override never looks like an approval. Whether you may override is decided by the server from your team role, not by the call.

POST/api/v1/workspace/restore-requests/:id

Body

Parameter	Type	Default	Description
`action`required	`"approve" \| "reject" \| "override"`	-	What you decide.

403	`FORBIDDEN`	This request is not yours, or your role does not allow overriding.
409	`NOT_PENDING`	The request has already been answered.

Compare versions

Shows line by line what changed between a version and the current state.

GET/api/v1/workspace/nodes/:id/diff

Query

Parameter	Type	Default	Description
`revision`required	`integer`	-	The version to compare against.

409	`NO_BASELINE`	There is no kept version for this revision.
410	`BLOB_UNAVAILABLE`	The row is alive, the stored object is not. Not a fault of your call; report the file if this happens repeatedly.
413	`TOO_LARGE`	The file is too large for a comparison.
415	`UNSUPPORTED_FORMAT`	There is no comparison for this format.

Who may see and change what. Shares go to people and to team groups.

Shares inherit downwards: whoever may see a folder also sees everything inside. A share on a single file adds to that, it never narrows it.

List shares

All shares on this node, plus the groups you could still grant to.

GET/api/v1/workspace/nodes/:id/shares

200OK

{
  "shares": [
    {
      "id": "3a7f0c15-8b62-4d09-91ae-6c0f2d84b731",
      "kind": "user",
      "email": "kollege@firma.de",
      "role": "editor",
      "source": "manual",
      "syncedAt": null
    }
  ],
  "pendingShares": [],
  "availableGroups": [
    {
      "id": "b2c9…",
      "name": "Vertrieb"
    }
  ],
  "isTeamMember": true,
  "canManage": true,
  "canManageGroups": true,
  "role": "owner"
}

pendingShares lists permissions read from a mounted drive that have no counterpart in anymize, usually because no account exists for that address yet. Only the owner sees them.

Grant a share

Grants access to a person or a team group. With kind=user pass email, with kind=group pass groupId.

POST/api/v1/workspace/nodes/:id/shares

Body

Parameter	Type	Default	Description
`kind`required	`"user" \| "group"`	-	Person or team group.
`email`	`string`	-	The person's address. Only with kind=user.
`groupId`	`uuid`	-	Id of the team group. Only with kind=group.
`role`required	`"viewer" \| "editor"`	-	viewer may read, editor may change.

400	`INVALID_ROLE`	role must be viewer or editor.
400	`INVALID_KIND`	kind must be user or group, and the matching field must be set.
403	`FORBIDDEN`	You may not manage shares on this node. Groups may additionally only be granted by the owner.
404	`USER_NOT_FOUND`	There is no account for that address. Invite the person first.
409	`MANAGED_BY_SYNC`	This share belongs to the source system and cannot be changed here.

Revoke a share

Takes back a single share.

DELETE/api/v1/workspace/nodes/:id/shares

Query

Parameter	Type	Default	Description
`shareId`required	`uuid`	-	The id from the share list.

409 MANAGED_BY_SYNC This share belongs to the source system and cannot be changed here.

Shares with source=mount_sync belong to the source system. Changing them here answers 409 MANAGED_BY_SYNC, because the next sync would undo the change anyway. Revoke the permission where the drive comes from.

Collaboration

Comments on the document, the change history, your own inbox and the agent lock.

Read comments

All comment threads on a file, each with its messages and its anchor in the text.

GET/api/v1/workspace/nodes/:id/comments

200OK

{
  "comments": [
    {
      "id": "c41f8e07-3b52-4a90-9d16-2c8e5b7a0f43",
      "nodeId": "7f2a5e91-0c6d-4b83-8e14-9d3f7a2c6b05",
      "status": "open",
      "version": 1,
      "anchor": {
        "revision": 4,
        "from": 120,
        "to": 168,
        "exactQuote": "Umsatz im dritten Quartal",
        "prefix": "",
        "suffix": ""
      },
      "author": {
        "id": "9b2e…",
        "displayName": "Nora Berg"
      },
      "resolvedBy": null,
      "resolvedAt": null,
      "createdAt": "2026-08-24T09: 22: 00.000Z",
      "updatedAt": "2026-08-24T09: 22: 00.000Z",
      "messages": [
        {
          "id": "m_1",
          "body": "Zahl bitte pruefen.",
          "isRoot": true,
          "author": {
            "id": "9b2e…",
            "displayName": "Nora Berg"
          },
          "createdAt": "2026-08-24T09: 22: 00.000Z",
          "updatedAt": "2026-08-24T09: 22: 00.000Z"
        }
      ],
      "messagesTruncated": false
    }
  ],
  "commentsTruncated": false,
  "documentRevision": 4,
  "portability": "workspace_only"
}

portability says how far a comment travels. workspace_only means it lives in anymize and does not end up in the exported Word file.

version is the state of the thread and required for every change to it: reply, edit, delete. It comes from this list and goes up by one on each change; a stale value answers 409 instead of overwriting someone else's reply.

Create a comment

Starts a new thread, optionally anchored to a passage.

POST/api/v1/workspace/nodes/:id/comments

Body

Parameter	Type	Default	Description
`body`required	`string (1-…)`	-	The comment text.
`anchor`required	`object`	-	Where in the document the comment hangs. The server checks that the anchor fits the file.
`anchor.revision`required	`integer`	-	The document revision the passage refers to.
`anchor.from / to`required	`integer`	-	Start and end of the passage. to must be greater than from.
`anchor.exactQuote`required	`string`	-	The quoted text itself, not empty. It is what finds the spot again when the document shifts.
`anchor.prefix / suffix`	`string`	`""`	Text before and after. Helps find the spot again when the quote occurs more than once.

400	`INVALID_BODY`	anchor is missing or incomplete. A comment without a passage is not provided for in the workspace; the schema also accepts no unknown field.
403	`FORBIDDEN`	You have no write permission on this node.

Change a comment

Changes the text, anchor or state of a thread, for instance to mark it resolved.

PATCH/api/v1/workspace/nodes/:id/comments/:threadId

Body

Parameter	Type	Default	Description
`version`required	`integer`	-	The thread state you saw. Protects against deleting a reply that arrived in between.
`status`	`"open" \| "resolved"`	-	open or resolved. This is how you tick off a thread.
`anchor`	`object`	-	Where in the document the comment hangs. The server checks that the anchor fits the file.
`body`	`string`	-	The comment text.

400	`INVALID_BODY`	The body changes nothing. Give at least one of status, anchor or body.
404	`COMMENT_NOT_FOUND`	That thread does not exist on this file.
409	`COMMENT_VERSION_CONFLICT`	Someone changed the thread in the meantime. Re-read it and send the new version along.

Delete a comment

Removes a thread with its messages. Answers 204 with no body.

DELETE/api/v1/workspace/nodes/:id/comments/:threadId

Query

Parameter	Type	Default	Description
`version`required	`integer`	-	The thread state you saw. Protects against deleting a reply that arrived in between.

400	`INVALID_VERSION`	version is missing from the query or is not a positive number.
409	`COMMENT_VERSION_CONFLICT`	Someone changed the thread in the meantime. Re-read it and send the new version along.

Reply to a comment

Appends a message to an existing thread.

POST/api/v1/workspace/nodes/:id/comments/:threadId/messages

Body

Parameter	Type	Default	Description
`version`required	`integer`	-	The thread state you saw. Protects against deleting a reply that arrived in between.
`body`required	`string`	-	The comment text.

409 COMMENT_VERSION_CONFLICT Someone changed the thread in the meantime. Re-read it and send the new version along.

Change history

For a file its own history, for a folder the history of its content.

GET/api/v1/workspace/nodes/:id/activity

Query

Parameter	Type	Default	Description
`limit`	`integer`	-	How many entries at most. The server caps it on top.

Read the inbox

What concerns you: new shares, comments addressed to you, consent requests. Always your own inbox: the user id comes from the authentication, never from the call.

GET/api/v1/workspace/inbox

Query

Parameter	Type	Default	Description
`limit`	`integer`	-	How many entries at most.
`unread`	`"1"`	-	With 1, only the unread ones.

Mark inbox as read

Either a list of ids or everything at once. One of the two must be set.

PATCH/api/v1/workspace/inbox

Body

Parameter	Type	Default	Description
`ids`	`uuid[] (max 200)`	-	The entries to mark. At most 200.
`all`	`boolean`	-	Mark everything.

Read the agent lock

Says whether agents may read and write this node. The lock is set via PATCH on the node, and only by the owner.

GET/api/v1/workspace/nodes/:id/agent-lock

200OK

{
  "read": true,
  "write": false,
  "readGeerbt": true,
  "writeGeerbt": false
}

readGeerbt and writeGeerbt say whether the setting sits on this node itself or comes from a folder above.

Search and overview

Finding files and fetching the home views.

Search

Searches case-insensitively in the name of every node you may see. All parameters are optional and can be combined.

GET/api/v1/workspace/search

Query

Parameter	Type	Default	Description
`q`	`string (max 255)`	-	The search term. Without it you get every visible node, filtered by the remaining parameters.
`kind`	`"all" \| "folder" \| "file"`	`all`	Folders only, files only, or both.
`owner`	`"alle" \| "ich" \| "andere"`	`alle`	ich limits to your own nodes, andere to those shared with you.
`locationId`	`uuid`	-	Folder to search in.
`modifiedFrom`	`ISO-8601`	-	Only nodes changed since this point in time.
`modifiedTo`	`ISO-8601`	-	Only nodes changed up to this point in time.

400 INVALID_QUERY A query parameter is missing, given twice or unreadable.

Two limits worth knowing: the search covers the NAME only, not the content, and locationId filters the DIRECT children of the folder, not the whole subtree.

Fetch the overview

The home views: recently used, shared with you, starred, trash and the activity stream. home additionally returns the folders.

GET/api/v1/workspace/overview

Query

Parameter	Type	Default	Description
`view`	`"home" \| "activity" \| "recent" \| "shared" \| "starred" \| "trash"`	`home`	Which view.

400 INVALID_VIEW That view does not exist.

Fetch changes

What changed since the last call? This keeps a copy up to date without walking the whole tree.

The loop is always the same: first call without cursor, then with the last one received. The response ALWAYS carries a new cursor, even when nothing came. How it is built is none of your business: pass it back unchanged.

Store the cursor durably, not just in memory. If it is lost you have to start over and walk the whole store again.

has_more: true means ask again at once, do not wait. Whoever pauses a minute on true never catches up on a backlog.

Page of changes

One page of the change stream together with the cursor for the next call.

GET/api/v1/workspace/delta

Query

Parameter	Type	Default	Description
`cursor`	`string`	-	The cursor from the last response. Omit it on the first call.
`limit`	`integer`	-	How many changes per page at most. The server caps it on top.

200OK

{
  "changes": [
    {
      "id": "3f8a1c47-2e5b-4d90-8a16-7c0e9b4d2f31",
      "action": "updated",
      "at": "2026-08-24T09: 20: 00.000Z",
      "node": {
        "id": "7f2a5e91-0c6d-4b83-8e14-9d3f7a2c6b05",
        "name": "Q3.xlsx",
        "type": "file",
        "parent_id": "1c9f6d2a-3b48-4c11-9a7e-2f5b8d0c4e63",
        "revision": 4,
        "trashed_at": null
      },
      "actor": {
        "user_id": "9b2e…",
        "agent_id": null
      }
    },
    {
      "id": "5d0c7b22-9a13-4e68-b7f4-3e1a8c0d5629",
      "action": "trashed",
      "at": "2026-08-24T09: 24: 00.000Z",
      "node": {
        "id": "1c9f6d2a-3b48-4c11-9a7e-2f5b8d0c4e63",
        "name": "Angebote",
        "type": "folder",
        "parent_id": null,
        "revision": null,
        "trashed_at": "2026-08-24T09: 24: 00.000Z"
      },
      "actor": {
        "user_id": "9b2e…",
        "agent_id": null
      }
    }
  ],
  "cursor": "eyJ0IjoiMjAyNi0wOC0yNFQwOToyNDowMFoiLCJpIjoiMWM5Zi4uLiJ9",
  "has_more": false
}

1let cursor = null
2for (;;) {
3  const url = new URL("https://app.anymize.ai/api/v1/workspace/delta")
4  if (cursor) url.searchParams.set("cursor", cursor)
5  const page = await fetch(url, {
6    headers: { Authorization: `Bearer ${process.env.ANYMIZE_API_KEY}` },
7  }).then((r) => r.json())
8
9  // change.action + change.node.* - siehe die Antwortform oben.
10  for (const change of page.changes) apply(change.action, change.node)
11  cursor = page.cursor
12
13  // has_more heisst: sofort weiterfragen. Erst bei false warten.
14  if (!page.has_more) break
15}

action is one of created, updated, renamed, moved, trashed, restored, shared, agent_edit. A deletion arrives as trashed, and node.trashed_at carries the moment: that is what the other side cleans up by. There is no separate deleted.

Spreadsheets

Read, search, analyse and change Excel workbooks sheet by sheet.

Writing calls work surgically: only the affected parts of the package are touched. Formatting, charts and everything else you do not touch stay unchanged; the workbook is not rebuilt.

Read a sheet

Returns a window of one worksheet. Formulas are evaluated locally when possible; when not, the last stored value comes back.

GET/api/v1/workspace/nodes/:id/sheet

Query

Parameter	Type	Default	Description
`sheet`	`string \| integer`	-	Which sheet, by name or zero-based index. Without it the first visible one.
`fromRow`	`integer`	`1`	First row of the window, counted from 1.
`toRow`	`integer`	-	Last row of the window. The server caps the window size.
`view`	`"externalData"`	-	With externalData the directory of external references comes back instead of the sheet projection.

400	`XLSX_INVALID_ADDRESS`	A cell or range address is unreadable.
404	`XLSX_SHEET_NOT_FOUND`	That sheet does not exist in the workbook.
415	`NOT_A_XLSX`	The file is not an Excel workbook.

Change a sheet

Takes a list of operations: write cells, insert or delete rows and columns, sort and import, create or rename sheets, set rules, cut external data. Exactly one of the six lists per call, otherwise 400 INVALID_BODY.

PATCH/api/v1/workspace/nodes/:id/sheet

Body

Parameter	Type	Default	Description
`revision`required	`integer`	-	The revision your change is based on. Required for every content write.
`operations`	`object[]`	-	Cell operations: values, formulas, formats.
`structureOperations`	`object[]`	-	Insert, delete, hide or resize rows and columns.
`dataOperations`	`object[]`	-	Sort, remove duplicates, import text, split text into columns.
`sheetOperations`	`object[]`	-	Create, rename, move or delete sheets.
`ruleOperations`	`object[]`	-	Create, change or remove conditional formatting and pivot rules.
`externalDataOperations`	`object[]`	-	Maintain the workbook's external references. The same directory that GET with view=externalData reads.

400	`INVALID_BODY`	The body does not match the schema, or it does not set exactly one of the six operation lists. Two lists at once is the same error as none.
400	`FORMULA_TRANSLATION_FAILED`	The formula could not be parsed. The hint names sheet, cell and position. Almost always a localized notation is behind it: semicolon instead of comma between arguments, or a function name in a national language.
409	`REVISION_CONFLICT`	Someone changed the file in the meantime. Re-read, apply your change to the new state and send again.
409	`DATA_VALIDATION_CONFIRMATION_REQUIRED`	The change violates a validation rule of the workbook. The response lists the violations; repeat the call with the supplied confirmation if you want it anyway.
413	`BODY_TOO_LARGE`	The body exceeds 8 MiB. Split the import into several calls.
422	`WOULD_OVERWRITE_CELLS`	The operation would have overwritten occupied cells. State explicitly that you want that, or choose another range.

Formulas must already arrive here in file form: English function names, dot as the decimal separator, comma between arguments, so ROUND(B8,2). This route does NOT translate. A localized notation such as RUNDEN(B8;2) ends in 400 FORMULA_TRANSLATION_FAILED or comes back under unknownFunctions and then sits unusable in the cell. Only dataOperations know a formula language, and the server reads it from the locale cookie, falling back to German without one.

Search and replace in a workbook

Searches across all sheets and replaces on request. Replacing needs write permission and the current revision.

POST/api/v1/workspace/nodes/:id/sheet/search

Analyse a workbook

Returns figures about a range without changing the workbook.

POST/api/v1/workspace/nodes/:id/sheet/analysis

Word documents

Page setup, headers and footers, and the two writing aids.

You read the content of a Word document with GET on the node and ?content=1, and write it with PATCH and the fields doc and revision. The endpoints here only cover what sits outside the body text.

Set the page setup

Format, orientation and margins of the document.

POST/api/v1/workspace/nodes/:id/docx/page-setup

Body

Parameter	Type	Default	Description
`revision`required	`integer`	-	The revision your change is based on. Required for every content write.
`format`	`"A4" \| "Letter"`	-	Page format.
`orientation`	`"portrait" \| "landscape"`	-	Portrait or landscape.
`margins`	`{ top, right, bottom, left }`	-	Margins in twips, settable individually. A twip is one twentieth of a point.

400	`INVALID_BODY`	The body contains no change. Give at least one of format, orientation or margins.
400	`INVALID_PAGE_SETUP`	The values do not form a valid page setup, for instance because the margins are wider than the page.
415	`NOT_EDITABLE`	This route only edits .docx files, and this file is not one. Not to be confused with 422 UNSUPPORTED_FEATURE: that is a .docx whose formatting we cannot write back without loss.
422	`UNSUPPORTED_FEATURE`	The document contains formatting we cannot write back without loss. The response names it in features.

The three fields sit FLAT in the body, not under a shared object. At least one must be present; without an effective change no new revision is created either.

Set headers and footers

Sets the document's headers and footers, optionally separately for the first page and for even and odd pages.

POST/api/v1/workspace/nodes/:id/docx/header-footer

Body

Parameter	Type	Default	Description
`revision`required	`integer`	-	The revision your change is based on. Required for every content write.
`header / footer`	`object`	-	The new content. Leaving it out keeps that line unchanged.

422 UNSUPPORTED_FEATURE The document contains formatting we cannot write back without loss. The response names it in features.

Continue writing

Suggests the next three or four words. When nothing obvious fits, completion: null comes back.

POST/api/v1/workspace/nodes/:id/complete

Body

Parameter	Type	Default	Description
`prefix`required	`string`	-	The text immediately before the caret.
`language`	`"de" \| "en" \| "fr" \| "da" \| "es" \| "no"`	`de`	Which language to answer in.

200OK

{
  "completion": " im dritten Quartal"
}

Runs on an EU-hosted model without reasoning and aborts after eight seconds. Both endpoints count against the AI rate limit, not the write limit.

Proofread text

Reports spelling and grammar spots with suggestions. Names, product names, addresses and numbers are left alone.

POST/api/v1/workspace/nodes/:id/proofread

Body

Parameter	Type	Default	Description
`text`required	`string`	-	The text to check.
`language`	`"de" \| "en" \| "fr" \| "da" \| "es" \| "no"`	`de`	Which language to answer in.

200OK

{
  "spelling": [
    {
      "word": "Angbot",
      "suggestion": "Angebot"
    }
  ],
  "grammar": []
}

Runs on an EU-hosted model without reasoning and aborts after eight seconds. Both endpoints count against the AI rate limit, not the write limit.

Mounted drives

Mount a drive from another storage system and sync it. Supported providers are google, microsoft, nextcloud and webdav.

Credentials stay with the drive's owner. Only nodes are shared, never credentials: whoever sees a mounted file sees it through anymize, not through the owner's account.

List drives

All mounted drives of the account with their sync state.

GET/api/v1/workspace/mounts

Mount a drive

Mounts a folder of a connected provider as a drive. The provider must be connected as a connector beforehand.

POST/api/v1/workspace/mounts

Body

Parameter	Type	Default	Description
`provider`required	`"google" \| "microsoft" \| "nextcloud" \| "webdav"`	-	The drive's provider.
`label`required	`string`	-	Display name of the drive in the workspace.
`remoteToken`	`string`	-	Folder reference from the provider's file picker. Without it, the root.
`remoteName`	`string`	-	Name of the folder at the provider, for display only.
`syncMode`	`"manual" \| "auto"`	`manual`	manual syncs on request, auto by itself.

400	`NOT_A_FOLDER`	The reference points at a file, not at a folder.
409	`CONNECTOR_MISSING`	No account is connected for this provider, or the access has expired. Connect it in the settings first.

Change a drive

Changes the display name, sync mode, state or permission takeover.

PATCH/api/v1/workspace/mounts/:id

Body

Parameter	Type	Default	Description
`label`	`string`	-	Display name of the drive in the workspace.
`syncMode`	`"manual" \| "auto"`	-	manual syncs on request, auto by itself.
`status`	`"idle" \| "paused"`	-	paused halts the sync, idle resumes it.
`syncPermissions`	`boolean`	-	Take over permissions as well. Switching it off removes the shares already taken over from this drive.

Unmount a drive

Removes the mount. Nothing is deleted at the provider itself.

DELETE/api/v1/workspace/mounts/:id

Trigger a sync

Syncs the drive now and reports what came out of it.

POST/api/v1/workspace/mounts/:id/sync

200OK

{
  "success": true,
  "imported": 42,
  "skipped": 3,
  "folders": 7,
  "permissions": {
    "granted": 12,
    "unchanged": 30,
    "revoked": 1,
    "pending": 2,
    "skipped": 4
  },
  "permissionsTruncated": false,
  "filesTruncated": false
}

409	`BUSY`	A sync is already running for this drive.
409	`CONNECTOR_MISSING`	No account is connected for this provider, or the access has expired. Connect it in the settings first.

With syncPermissions=true the permissions are taken over as well. Shares granted by hand in anymize stay untouched; ones revoked in the source system get revoked here. Only google and microsoft hand out an access list.

permissionsTruncated and filesTruncated say that a cap kicked in and the run is therefore incomplete. Another call fetches the rest: do not treat half a run like a finished one.

MCP server and chat skill

The same API and the same documentation, for assistants instead of your code. An MCP-capable client (Claude, Cursor, your own agent) gets tools here for the documentation, for your files and for your workflows.

Thirteen tools in three groups. docs_list, docs_search and docs_get look things up in this documentation. workspace_list, workspace_resolve_path, workspace_search, workspace_read_file, workspace_write_file, workspace_manage and workspace_changes work on your files. workflows_list, workflows_get and workflows_run drive your workflows.

What the MCP server serves as documentation is character for character this page, and the same thing the anymize chat looks up. All three read one source; a change to an endpoint arrives everywhere without anyone doing anything.

Authentication is by API key in the Authorization header only. Session cookies are deliberately NOT accepted: a cookie-authenticated endpoint reachable from foreign pages would be a CSRF surface. The tools act as the key owner and see exactly what that person sees in the browser.

Inside the anymize chat you do not need to set anything up. The agent has the same documentation as a tool and looks things up before talking about an endpoint, instead of inventing one.

1{
2  "mcpServers": {
3    "anymize": {
4      "type": "http",
5      "url": "https://app.anymize.ai/api/mcp/anymize",
6      "headers": {
7        "Authorization": "Bearer YOUR_API_KEY"
8      }
9    }
10  }
11}

MCP server and chat skill

POST/api/mcp/anymize

Request: application/json·Response: application/json

Limits and errors

What an account may hold, how fast you may ask, and what errors look like.

Errors arrive as a CODE, never as a finished sentence: "error": "NOT_FOUND". Translation happens on your side. When you show an error to a person, map the code to your own wording: a server's raw text does not belong in a user interface.

The application does not throttle requests itself: application-level rate limiting is deliberately switched off, because shared IP addresses would otherwise take out whole customers. Throttling happens at the network edge. So do NOT rely on a 429 as your signal; keep your call rate reasonable on your own and retry with growing gaps when a response fails to arrive. Should we ever switch throttling on, it counts per API key, never per address: behind a shared connection you will not get in each other's way.

Parameter	Type	Default	Description
`maxBytesPerUser`	`2 GiB`	-	Storage per account. Trash and kept versions count towards it.
`maxFiles`	`5000`	-	Number of files per account.
`maxFileSizeBytes`	`50 MiB`	-	Size of a single file.

Storage usage

How much space the account takes and how many files it holds.

GET/api/v1/workspace/usage

200OK

{
  "bytesUsed": 184320119,
  "maxBytes": 2147483648,
  "fileCount": 312,
  "maxFiles": 5000
}

The number is an honest lower bound: files including kept versions and trash count, content-addressed editor images do not.