Hey, human!
This is what your agent sees atdocs.example.com/
HTTP/2 200 OK content-type: text/markdown; charset=utf-8 vary: accept, user-agent x-agent: [ai_agent]
Loading the agent response…
Use cases
Common tasks and patterns for this API. Pick one to get started.
No use cases have been added yet.
Categories
- List the files and folders inside a folder of the library (folders first, then files; the root by default)
- Get one file or folder, with its path and whether it is protected
- 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)
- Move a file or folder to the bin; if a transfer holds it, 409 transfer_active until confirm_delete_transfers=true
- A short-lived download link for a file
- Search the words inside the library's files; returns the best matching passages with file id, page and a snippet
- Ask a question about the files and get an answer with sources (body: question, folder, mode)
- The text of one file, by page range (about 12,000 characters per call)
- Create a folder (body: name, parent_id optional; a taken name is a 409)
- The workspaces this token can be used for, with the workspace_key to send as X-Workspace-Key (needs any API access)
- One file or folder by its path, without listing the folder around it (404 not found, 409 ambiguous_path)
- Restore a file or folder from the bin (same retention rule as the app)
- Copy a file inside storage (body: parent_id, name; a taken name is 409, plan limits apply)
- 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)
- 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)
- Write a new document from content (PDF, Word, PowerPoint, Excel, CSV or Markdown)
- Fill a Word template into a new .docx ({placeholders}, lists, repeated table rows)
- Change a copy of a Word, PowerPoint or Excel file (replace text, insert, change cells, append rows)
- Storage in use and the plan's limit (null when there is none)
- 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
- Where an upload stands (never finishes it)
- Abort an unfinished upload
- Fresh signed URLs for a range of parts (from_part, count up to 100)
- 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
- List brands
- Create a brand
- Get a brand
- Delete a brand (archives it, restorable)
- Update a brand
- List archived brands
- Restore an archived brand
- Check a brand's domain
- Connect a domain to a brand
- Remove a brand's domain
- Look up a brand from its website address
- Start uploading a brand file
- Remove a file from a brand
- Import a brand file from a web address
- Finish a brand file upload
- List a brand's files with short-lived download links
- The brand as markdown (brand.md)
- Page views, downloads and requests