# Tarkle > Machine-readable index for the Tarkle API. Each endpoint below links to a Markdown reference (with its OpenAPI slice inlined). The full narrative docs and the complete spec are linked under Reference. Written for agents, not human skimming. # MCP Server There's an MCP server at `https://project-03b42162.restlessdocs.com/mcp` exposing tools like `search_endpoints`, `get_endpoint`, and operation lookup. When you need specifics about an endpoint - parameters, status codes, examples - query the MCP server first; do not guess. If the user has not yet connected the MCP server in their client, they can install it from the docs at `https://project-03b42162.restlessdocs.com`. # Reference - [Full documentation](https://project-03b42162.restlessdocs.com/llms-full.txt): every endpoint, auth, SDKs, and guides inlined as one document. - The complete OpenAPI spec (internal operations removed) is available at `https://project-03b42162.restlessdocs.com/openapi.yaml`. # Feedback If this API or its docs were confusing, missing something, or behaved differently than documented, tell the maintainers so they can fix it. Send `POST https://project-03b42162.restlessdocs.com/feedback` with a JSON body: ```json {"message": "what was confusing, missing, or broken", "requestIds": [""]} ``` `message` is required. Optional: `context` (what you were trying to do), `subject` (the endpoint or doc it concerns), `email` (a contact address, only if you already have one), `requestIds` (ids from the `x-request-id` header or the end of an `x-log-url`, so the maintainer can open the exact log). Don't wait to be asked: if something slowed you down or blocked you, report it and carry on. Over MCP, the same note is the `send_feedback` tool. # Installation - [Use with Claude](https://project-03b42162.restlessdocs.com/install/claude.md) - connect Claude to the API over MCP, with a paste-ready prompt - [Use with ChatGPT](https://project-03b42162.restlessdocs.com/install/chatgpt.md) - connect ChatGPT to the API over MCP, with a paste-ready prompt - [Use with Any AI assistant](https://project-03b42162.restlessdocs.com/install/ai-other.md) - connect Any AI assistant to the API over MCP, with a paste-ready prompt - [Set up with Node.js](https://project-03b42162.restlessdocs.com/install/node.md) - install steps and an agent setup prompt for Node.js - [Set up with Python](https://project-03b42162.restlessdocs.com/install/python.md) - install steps and an agent setup prompt for Python - [Set up with Ruby](https://project-03b42162.restlessdocs.com/install/ruby.md) - install steps and an agent setup prompt for Ruby - [Set up with PHP](https://project-03b42162.restlessdocs.com/install/php.md) - install steps and an agent setup prompt for PHP - [Set up with Go](https://project-03b42162.restlessdocs.com/install/go.md) - install steps and an agent setup prompt for Go - [Set up with React](https://project-03b42162.restlessdocs.com/install/react.md) - install steps and an agent setup prompt for React - [Set up with Java](https://project-03b42162.restlessdocs.com/install/java.md) - install steps and an agent setup prompt for Java - [Set up with C#](https://project-03b42162.restlessdocs.com/install/csharp.md) - install steps and an agent setup prompt for C# - [Set up with Rust](https://project-03b42162.restlessdocs.com/install/rust.md) - install steps and an agent setup prompt for Rust - [Any other language](https://project-03b42162.restlessdocs.com/install/other.md) - a generic prompt for calling the API from any language # Endpoints Base URL: `https://tarkle.com/api/v1` - [List brands](https://project-03b42162.restlessdocs.com/endpoint/listbrands.md) - `GET https://tarkle.com/api/v1/brands` - [Create a brand](https://project-03b42162.restlessdocs.com/endpoint/createbrand.md) - `POST https://tarkle.com/api/v1/brands` - [Get a brand](https://project-03b42162.restlessdocs.com/endpoint/getbrand.md) - `GET https://tarkle.com/api/v1/brands/{brand}` - [Delete a brand (archives it, restorable)](https://project-03b42162.restlessdocs.com/endpoint/deletebrand.md) - `DELETE https://tarkle.com/api/v1/brands/{brand}` - [Update a brand](https://project-03b42162.restlessdocs.com/endpoint/updatebrand.md) - `PATCH https://tarkle.com/api/v1/brands/{brand}` - [List archived brands](https://project-03b42162.restlessdocs.com/endpoint/listarchivedbrands.md) - `GET https://tarkle.com/api/v1/archived-brands` - [Restore an archived brand](https://project-03b42162.restlessdocs.com/endpoint/restorearchivedbrand.md) - `POST https://tarkle.com/api/v1/archived-brands/{brand}/restore` - [Check a brand's domain](https://project-03b42162.restlessdocs.com/endpoint/getbranddomain.md) - `GET https://tarkle.com/api/v1/brands/{brand}/domain` - [Connect a domain to a brand](https://project-03b42162.restlessdocs.com/endpoint/setbranddomain.md) - `PUT https://tarkle.com/api/v1/brands/{brand}/domain` - [Remove a brand's domain](https://project-03b42162.restlessdocs.com/endpoint/deletebranddomain.md) - `DELETE https://tarkle.com/api/v1/brands/{brand}/domain` - [Look up a brand from its website address](https://project-03b42162.restlessdocs.com/endpoint/lookupbrandfromdomain.md) - `POST https://tarkle.com/api/v1/brand-lookup` - [Start uploading a brand file](https://project-03b42162.restlessdocs.com/endpoint/startbrandfileupload.md) - `POST https://tarkle.com/api/v1/brands/{brand}/files` - [Remove a file from a brand](https://project-03b42162.restlessdocs.com/endpoint/removebrandfile.md) - `DELETE https://tarkle.com/api/v1/brands/{brand}/files` - [Import a brand file from a web address](https://project-03b42162.restlessdocs.com/endpoint/importbrandfile.md) - `POST https://tarkle.com/api/v1/brands/{brand}/files/import` - [Finish a brand file upload](https://project-03b42162.restlessdocs.com/endpoint/completebrandfileupload.md) - `POST https://tarkle.com/api/v1/brands/{brand}/files/{file}/complete` - [List a brand's files with short-lived download links](https://project-03b42162.restlessdocs.com/endpoint/listbrandassets.md) - `GET https://tarkle.com/api/v1/brands/{brand}/assets` - [The brand as markdown (brand.md)](https://project-03b42162.restlessdocs.com/endpoint/getbrandmarkdown.md) - `GET https://tarkle.com/api/v1/brands/{brand}/markdown` - [Page views, downloads and requests](https://project-03b42162.restlessdocs.com/endpoint/getbrandanalytics.md) - `GET https://tarkle.com/api/v1/brands/{brand}/analytics` - [List download and view requests](https://project-03b42162.restlessdocs.com/endpoint/listbrandrequests.md) - `GET https://tarkle.com/api/v1/brands/{brand}/requests` - [List the files and folders inside a folder of the library (folders first, then files; the root by default)](https://project-03b42162.restlessdocs.com/endpoint/listfiles.md) - `GET https://tarkle.com/api/v1/files` - [Get one file or folder, with its path and whether it is protected](https://project-03b42162.restlessdocs.com/endpoint/getfile.md) - `GET https://tarkle.com/api/v1/files/{id}` - [Rename and/or move a file or folder, and/or set a file's own modification time (body: name, parent_id: a folder id or null for the root, modified_at)](https://project-03b42162.restlessdocs.com/endpoint/updatefile.md) - `PATCH https://tarkle.com/api/v1/files/{id}` - [Move a file or folder to the bin; if a transfer holds it, 409 transfer_active until confirm_delete_transfers=true](https://project-03b42162.restlessdocs.com/endpoint/deletefile.md) - `DELETE https://tarkle.com/api/v1/files/{id}` - [A short-lived download link for a file](https://project-03b42162.restlessdocs.com/endpoint/getfiledownloadlink.md) - `GET https://tarkle.com/api/v1/files/{id}/download` - [Search the words inside the library's files; returns the best matching passages with file id, page and a snippet](https://project-03b42162.restlessdocs.com/endpoint/searchfiles.md) - `GET https://tarkle.com/api/v1/files/search` - [Ask a question about the files and get an answer with sources (body: question, folder, mode)](https://project-03b42162.restlessdocs.com/endpoint/askfiles.md) - `POST https://tarkle.com/api/v1/ai/ask` - [The text of one file, by page range (about 12,000 characters per call)](https://project-03b42162.restlessdocs.com/endpoint/getfiletext.md) - `GET https://tarkle.com/api/v1/files/{id}/text` - [Create a folder (body: name, parent_id optional; a taken name is a 409)](https://project-03b42162.restlessdocs.com/endpoint/createfolder.md) - `POST https://tarkle.com/api/v1/folders` - [The workspaces this token can be used for, with the workspace_key to send as X-Workspace-Key (needs any API access)](https://project-03b42162.restlessdocs.com/endpoint/listworkspaces.md) - `GET https://tarkle.com/api/v1/workspaces` - [One file or folder by its path, without listing the folder around it (404 not found, 409 ambiguous_path)](https://project-03b42162.restlessdocs.com/endpoint/getfilebypath.md) - `GET https://tarkle.com/api/v1/files/by-path` - [Restore a file or folder from the bin (same retention rule as the app)](https://project-03b42162.restlessdocs.com/endpoint/restorefile.md) - `POST https://tarkle.com/api/v1/files/{id}/restore` - [Copy a file inside storage (body: parent_id, name; a taken name is 409, plan limits apply)](https://project-03b42162.restlessdocs.com/endpoint/copyfile.md) - `POST https://tarkle.com/api/v1/files/{id}/copy` - [Page tools on a PDF, saved as a new PDF (merge, keep or remove, reorder, rotate, crop, blank pages, page numbers, watermark, title and author)](https://project-03b42162.restlessdocs.com/endpoint/editpdf.md) - `POST https://tarkle.com/api/v1/files/{id}/pdf-edit` - [Convert a file into a new file (PDF to text, pictures, Word, Excel or split parts; pictures or an Office file to PDF; OCR, redact, compress, protect, unlock)](https://project-03b42162.restlessdocs.com/endpoint/convertfile.md) - `POST https://tarkle.com/api/v1/files/{id}/convert` - [Write a new document from content (PDF, Word, PowerPoint, Excel, CSV or Markdown)](https://project-03b42162.restlessdocs.com/endpoint/createdocument.md) - `POST https://tarkle.com/api/v1/documents` - [Fill a Word template into a new .docx ({placeholders}, lists, repeated table rows)](https://project-03b42162.restlessdocs.com/endpoint/filltemplate.md) - `POST https://tarkle.com/api/v1/files/{id}/fill-template` - [Change a copy of a Word, PowerPoint or Excel file (replace text, insert, change cells, append rows)](https://project-03b42162.restlessdocs.com/endpoint/editofficefile.md) - `POST https://tarkle.com/api/v1/files/{id}/office-edit` - [Storage in use and the plan's limit (null when there is none)](https://project-03b42162.restlessdocs.com/endpoint/getusage.md) - `GET https://tarkle.com/api/v1/usage` - [Start an upload into a folder (body: name, size, folder_id, content_type, sha256, on_conflict); returns signed URLs, or creates an empty file directly when size is 0](https://project-03b42162.restlessdocs.com/endpoint/startupload.md) - `POST https://tarkle.com/api/v1/uploads` - [Where an upload stands (never finishes it)](https://project-03b42162.restlessdocs.com/endpoint/getupload.md) - `GET https://tarkle.com/api/v1/uploads/{id}` - [Abort an unfinished upload](https://project-03b42162.restlessdocs.com/endpoint/abortupload.md) - `DELETE https://tarkle.com/api/v1/uploads/{id}` - [Fresh signed URLs for a range of parts (from_part, count up to 100)](https://project-03b42162.restlessdocs.com/endpoint/signuploadparts.md) - `POST https://tarkle.com/api/v1/uploads/{id}/parts` - [Finish the upload into the folder chosen at the start; optional body: sha256, modified_at (multipart_id is stored by the server); returns the file](https://project-03b42162.restlessdocs.com/endpoint/completeupload.md) - `POST https://tarkle.com/api/v1/uploads/{id}/complete` - [Approve or reject a request](https://project-03b42162.restlessdocs.com/endpoint/decidebrandrequest.md) - `POST https://tarkle.com/api/v1/brands/{brand}/requests/{request}` - [List webhook endpoints](https://project-03b42162.restlessdocs.com/endpoint/listwebhookendpoints.md) - `GET https://tarkle.com/api/v1/webhooks` - [Add a webhook endpoint](https://project-03b42162.restlessdocs.com/endpoint/createwebhookendpoint.md) - `POST https://tarkle.com/api/v1/webhooks` - [Get a webhook endpoint](https://project-03b42162.restlessdocs.com/endpoint/getwebhookendpoint.md) - `GET https://tarkle.com/api/v1/webhooks/{id}` - [Change a webhook endpoint](https://project-03b42162.restlessdocs.com/endpoint/updatewebhookendpoint.md) - `PATCH https://tarkle.com/api/v1/webhooks/{id}` - [Delete a webhook endpoint](https://project-03b42162.restlessdocs.com/endpoint/deletewebhookendpoint.md) - `DELETE https://tarkle.com/api/v1/webhooks/{id}` - [Rotate the signing secret](https://project-03b42162.restlessdocs.com/endpoint/rotatewebhooksecret.md) - `POST https://tarkle.com/api/v1/webhooks/{id}/rotate-secret` - [Send a test event](https://project-03b42162.restlessdocs.com/endpoint/sendwebhooktestevent.md) - `POST https://tarkle.com/api/v1/webhooks/{id}/test` - [List an endpoint's deliveries](https://project-03b42162.restlessdocs.com/endpoint/listwebhookdeliveries.md) - `GET https://tarkle.com/api/v1/webhooks/{id}/deliveries` - [Send an event again](https://project-03b42162.restlessdocs.com/endpoint/redeliverwebhookevent.md) - `POST https://tarkle.com/api/v1/webhooks/{id}/deliveries/{delivery}/redeliver` - [Create a shareable transfer link](https://project-03b42162.restlessdocs.com/endpoint/createtransfer.md) - `POST https://tarkle.com/api/v1/transfers` - [Get a transfer](https://project-03b42162.restlessdocs.com/endpoint/gettransfer.md) - `GET https://tarkle.com/api/v1/transfers/{id}` - [End a transfer early](https://project-03b42162.restlessdocs.com/endpoint/deletetransfer.md) - `DELETE https://tarkle.com/api/v1/transfers/{id}` - [Change a transfer: view only, expiry or password](https://project-03b42162.restlessdocs.com/endpoint/updatetransfer.md) - `PATCH https://tarkle.com/api/v1/transfers/{id}` - [Share a folder of photos as a gallery, free or paid (body: folder_id, title, price, currency, preview_mode, preview_count, watermark, client_name, client_email)](https://project-03b42162.restlessdocs.com/endpoint/creategallery.md) - `POST https://tarkle.com/api/v1/galleries` - [Get a gallery, its links and who paid](https://project-03b42162.restlessdocs.com/endpoint/getgallery.md) - `GET https://tarkle.com/api/v1/galleries/{id}` - [Deliver a transfer to contacts' client portals](https://project-03b42162.restlessdocs.com/endpoint/delivertransfertocontacts.md) - `POST https://tarkle.com/api/v1/transfers/{id}/contacts` - [Add a contact](https://project-03b42162.restlessdocs.com/endpoint/createcontact.md) - `POST https://tarkle.com/api/v1/contacts` - [List contacts](https://project-03b42162.restlessdocs.com/endpoint/listcontacts.md) - `GET https://tarkle.com/api/v1/contacts` - [Turn client portal access on or off](https://project-03b42162.restlessdocs.com/endpoint/setcontactportalaccess.md) - `POST https://tarkle.com/api/v1/contacts/{id}/portal-access` - [Resend a contact's portal sign-in email](https://project-03b42162.restlessdocs.com/endpoint/resendcontactportalinvite.md) - `POST https://tarkle.com/api/v1/contacts/{id}/portal-invite` - [Set a contact's portal upload limit](https://project-03b42162.restlessdocs.com/endpoint/setcontactstoragelimit.md) - `POST https://tarkle.com/api/v1/contacts/{id}/storage-limit` - [Read a contact's portal upload limit and use](https://project-03b42162.restlessdocs.com/endpoint/getcontactstoragelimit.md) - `GET https://tarkle.com/api/v1/contacts/{id}/storage-limit` - [Create a file request](https://project-03b42162.restlessdocs.com/endpoint/createfilerequest.md) - `POST https://tarkle.com/api/v1/file-requests` - [List file requests](https://project-03b42162.restlessdocs.com/endpoint/listfilerequests.md) - `GET https://tarkle.com/api/v1/file-requests` - [List team folders](https://project-03b42162.restlessdocs.com/endpoint/listteams.md) - `GET https://tarkle.com/api/v1/teams` - [Create a team folder](https://project-03b42162.restlessdocs.com/endpoint/createteam.md) - `POST https://tarkle.com/api/v1/teams`