Hey, human!
HTTP/2 200 OK content-type: text/markdown; charset=utf-8 vary: accept, user-agent x-agent: [ai_agent]
Loading the agent response…
Change a copy of a Word, PowerPoint or Excel file (replace text, insert, change cells, append rows)
Saves the changes as a NEW file; the source is never changed. The kind of the file in the path decides the fields. .docx: edits ([{ find, replace }], exact text), inserts (a paragraph list, a table or a picture by file id of a PNG, JPG or GIF, placed after some text or at the end), track_changes (the changes become tracked changes by Tarkle that the person accepts or rejects in Word). .pptx: edits ([{ find, replace }] on every slide where the text appears). .xlsx: cells ([{ sheet, cell, value }], up to 100) and append_rows ([{ sheet, rows }], up to 200 rows); a cell with a formula, a merged cell, or a workbook with charts, pictures, pivot tables or macros is refused. Every text, anchor or sheet named must exist: 422 unprocessable_file with details.not_found, details.anchors_not_found and details.sheets_not_found. Needs files:write; 20 calls a minute per token.
What you provide
- Editsoptional: Exact text to find and its replacement (empty deletes), up to 50 for Word and PowerPoint
- Insertsoptional: Word only
- Track changesoptional: Word only: record the changes as tracked changes by Tarkle
- Cellsoptional: Excel only, up to 100; an empty value clears the cell
- Append rowsoptional: Excel only, up to 200 rows in all
- Nameoptional: The new file's name; default '<name> (edited).<ext>'
- Folder idoptional: The folder; omitted keeps the source's folder
Do this with AI
I want to change a copy of a Word, PowerPoint or Excel file (replace text, insert, change cells, append rows). Use the Tarkle API. Read the reference for this operation and follow it exactly: https://project-03b42162.restlessdocs.com/endpoint/editofficefile.md Authenticate with your API key as a Bearer token in the Authorization header. Then make the request for me and tell me what came back.
Paste this into Claude, Cursor, or any AI assistant and it will do it for you.
https://tarkle.com/api/v1/files/{id}/office-editcurl --request POST \
--url https://tarkle.com/api/v1/files/id/office-edit \
--header 'Authorization: Bearer $API_KEY' \
--header 'Content-Type: application/json' \
--header 'X-Workspace-Key: X-Workspace-Key' \
--data '
{
"edits": [
{
"find": "find",
"replace": "replace"
}
],
"inserts": [
{
"after": "after",
"paragraphs": [
"string"
],
"table": {},
"image": {}
}
],
"track_changes": true,
"cells": [
{
"sheet": "sheet",
"cell": "cell",
"value": "string"
}
],
"append_rows": [
{
"sheet": "sheet",
"rows": [
[
"string"
]
]
}
],
"name": "name",
"folder_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
}
'Path parameters
idstringrequiredA file id (digits) or a folder id (uuid)
Query parameters
workspace_keystringThe same key as the X-Workspace-Key header, for clients that cannot set headers. Send one of the two, or both with the same value (different values are 400 conflicting_workspace)
Header parameters
X-Workspace-KeystringrequiredThe 8-character key of the workspace this call acts on; GET /workspaces lists the keys a token can use. A workspace id is refused (400 workspace_key_required)
Idempotency-KeystringMakes a write safe to repeat. Send a random value (a UUID is fine) of up to 255 visible characters. A repeat of the same request gets the first answer again, with the header `Idempotent-Replayed: true`, and does nothing twice. The same key for a different request is 422 `idempotency_key_reused`; the same request while the first one is still running is 409 `idempotency_in_progress`. A 5xx or 429 is not remembered, so retrying it runs the request again. Keys last 24 hours and belong to the account that created the token.
Body
application/jsonrequiredExact text to find and its replacement (empty deletes), up to 50 for Word and PowerPoint
findstringrequiredreplacestringrequiredWord only
afterstringparagraphsstring[]tableobjectimageobjecttrack_changesbooleanWord only: record the changes as tracked changes by Tarkle
Excel only, up to 100; an empty value clears the cell
sheetstringrequiredcellstringrequiredExcel only, up to 200 rows in all
sheetstringrequiredrowsoneOf[][]requirednamestringThe new file's name; default '<name> (edited).<ext>'
folder_idstring · uuid | nullThe folder; omitted keeps the source's folder