Hey, human!
This is what your agent sees atdocs.example.com/integrate
HTTP/2 200 OK content-type: text/markdown; charset=utf-8 vary: accept, user-agent x-agent: [ai_agent]
Loading the agent response…
Code integrations
Set up the API in your codebase.
Endpoints
- List brandsGET/brands
- Create a brandPOST/brands
- Get a brandGET/brands/{brand}
- Delete a brand (archives it, restorable)DELETE/brands/{brand}
- Update a brandPATCH/brands/{brand}
- List archived brandsGET/archived-brands
- Restore an archived brandPOST/archived-brands/{brand}/restore
- Check a brand's domainGET/brands/{brand}/domain
- Connect a domain to a brandPUT/brands/{brand}/domain
- Remove a brand's domainDELETE/brands/{brand}/domain
- Look up a brand from its website addressPOST/brand-lookup
- Start uploading a brand filePOST/brands/{brand}/files
- Remove a file from a brandDELETE/brands/{brand}/files
- Import a brand file from a web addressPOST/brands/{brand}/files/import
- Finish a brand file uploadPOST/brands/{brand}/files/{file}/complete
- List a brand's files with short-lived download linksGET/brands/{brand}/assets
- The brand as markdown (brand.md)GET/brands/{brand}/markdown
- Page views, downloads and requestsGET/brands/{brand}/analytics
- List download and view requestsGET/brands/{brand}/requests
- List the files and folders inside a folder of the library (folders first, then files; the root by default)GET/files
- Get one file or folder, with its path and whether it is protectedGET/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)PATCH/files/{id}
- Move a file or folder to the bin; if a transfer holds it, 409 transfer_active until confirm_delete_transfers=trueDELETE/files/{id}
- A short-lived download link for a fileGET/files/{id}/download
- Search the words inside the library's files; returns the best matching passages with file id, page and a snippetGET/files/search
- Ask a question about the files and get an answer with sources (body: question, folder, mode)POST/ai/ask
- The text of one file, by page range (about 12,000 characters per call)GET/files/{id}/text
- Create a folder (body: name, parent_id optional; a taken name is a 409)POST/folders
- The workspaces this token can be used for, with the workspace_key to send as X-Workspace-Key (needs any API access)GET/workspaces
- One file or folder by its path, without listing the folder around it (404 not found, 409 ambiguous_path)GET/files/by-path
- Restore a file or folder from the bin (same retention rule as the app)POST/files/{id}/restore
- Copy a file inside storage (body: parent_id, name; a taken name is 409, plan limits apply)POST/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)POST/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)POST/files/{id}/convert
- Write a new document from content (PDF, Word, PowerPoint, Excel, CSV or Markdown)POST/documents
- Fill a Word template into a new .docx ({placeholders}, lists, repeated table rows)POST/files/{id}/fill-template
- Change a copy of a Word, PowerPoint or Excel file (replace text, insert, change cells, append rows)POST/files/{id}/office-edit
- Storage in use and the plan's limit (null when there is none)GET/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 0POST/uploads
- Where an upload stands (never finishes it)GET/uploads/{id}
- Abort an unfinished uploadDELETE/uploads/{id}
- Fresh signed URLs for a range of parts (from_part, count up to 100)POST/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 filePOST/uploads/{id}/complete
- Approve or reject a requestPOST/brands/{brand}/requests/{request}
- List webhook endpointsGET/webhooks
- Add a webhook endpointPOST/webhooks
- Get a webhook endpointGET/webhooks/{id}
- Change a webhook endpointPATCH/webhooks/{id}
- Delete a webhook endpointDELETE/webhooks/{id}
- Rotate the signing secretPOST/webhooks/{id}/rotate-secret
- Send a test eventPOST/webhooks/{id}/test
- List an endpoint's deliveriesGET/webhooks/{id}/deliveries
- Send an event againPOST/webhooks/{id}/deliveries/{delivery}/redeliver
- Create a shareable transfer linkPOST/transfers
- Get a transferGET/transfers/{id}
- End a transfer earlyDELETE/transfers/{id}
- Change a transfer: view only, expiry or passwordPATCH/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)POST/galleries
- Get a gallery, its links and who paidGET/galleries/{id}
- Deliver a transfer to contacts' client portalsPOST/transfers/{id}/contacts
- Add a contactPOST/contacts
- List contactsGET/contacts
- Turn client portal access on or offPOST/contacts/{id}/portal-access
- Resend a contact's portal sign-in emailPOST/contacts/{id}/portal-invite
- Set a contact's portal upload limitPOST/contacts/{id}/storage-limit
- Read a contact's portal upload limit and useGET/contacts/{id}/storage-limit
- Create a file requestPOST/file-requests
- List file requestsGET/file-requests
- List team foldersGET/teams
- Create a team folderPOST/teams