API Reference — Ambiguous
v04d4182ae4f03cc1a5b58ba3919d79de2fbe41aa
OpenAPI 3.1.0
Ambiguous Workspace API
Download OpenAPI Document json Download OpenAPI Document yaml
Public REST API for the Ambiguous Workspace. Same surface every client uses — web, desktop, mobile, CLI, and AI agents. Authenticate with Authorization: Bearer . REST API major version 1 is selected with the optional API-Version: 1 request header (the default). Responses echo API-Version. Unsupported versions return 400. Additive fields and endpoints may be introduced within a major version; incompatible changes require a new major version. Deprecated operations are marked deprecated in OpenAPI; a scheduled removal must advertise Deprecation and Sunset headers before removal. Rate-limited responses advertise RateLimit-Policy and RateLimit (remaining quota and reset seconds); 429 responses include Retry-After. Email sends accept Idempotency-Key for safe retries; consult the operation's header schema for its scope. A disposable task API sandbox is available at https://app.ambiguous.ai/sandbox with a separate contract at /sandbox/openapi.json and setup at https://ambiguous.ai/sandbox.md. It uses synthetic data and sandbox-only credentials; only its documented subset is supported.
Server
Server:https://app.ambiguous.ai
Production
AuthenticationRequired
Selected Auth Type: bearerAuth
JWT (humans) or API key with ak_ prefix (agents). Both via Authorization: Bearer <token>. |
| Bearer Token : Show Password |
Client Libraries
Shell
Ruby
Node.js
PHP
Python
MoreSelect from all clients
Shell Curl
Documents (Collapsed)
Copy link
Collaborative documents: create, read, edit, share, version, comment on and export Docs, plus the document family operations Sheets, Slides and Canvas share.
Documents Operations
- get/api/documents/{id}/source-reader-snapshot
- get/api/documents
- post/api/docs
- post/api/documents/import
- get/api/documents/dictionary
- get/api/documents/settings/page-layout
- put/api/documents/settings/page-layout
- get/api/documents/shared-with-me
- get/api/documents/trash
- post/api/documents/completions
- post/api/documents/{id}/restore
- delete/api/documents/{id}/permanent
- post/api/documents/{id}/duplicate
- post/api/documents/{id}/export
- post/api/documents/{id}/export-jobs
- get/api/documents/{id}/export-jobs/{jobId}
- get/api/documents/{id}/export-jobs/{jobId}/content
- get/api/documents/{id}
- patch/api/documents/{id}
- delete/api/documents/{id}
- post/api/documents/{id}/source-migration
- post/api/documents/{id}/suggestion-operations
- post/api/documents/{id}/format-revision-readers
- post/api/documents/{id}/logical-ownership
- get/api/documents/{id}/suggestions
- post/api/documents/{id}/suggestions/review
- post/api/documents/{id}/change-details
- post/api/documents/{id}/named-styles
- get/api/documents/{id}/thumbnail
- patch/api/documents/{id}/pin
- post/api/documents/{id}/star
- get/api/documents/{id}/headers-footers
- put/api/documents/{id}/headers-footers
- get/api/documents/{id}/footnotes
- put/api/documents/{id}/footnotes
- get/api/documents/{id}/page-style
- patch/api/documents/{id}/page-style
- get/api/documents/{id}/permissions
- post/api/documents/{id}/permissions
- patch/api/documents/{id}/permissions/{principalId}
- delete/api/documents/{id}/permissions/{principalId}
- post/api/documents/{id}/share-invite
- delete/api/documents/{id}/pending-shares/{pendingId}
- patch/api/documents/{id}/visibility
- post/api/documents/{id}/revoke-link
- post/api/documents/{id}/transfer-ownership
- post/api/documents/{id}/claim
- get/api/documents/{id}/comments
- post/api/documents/{id}/comments
- post/api/documents/{id}/comments/mark-read
- post/api/documents/{id}/comments/{commentId}/mark-read
- post/api/documents/{id}/comments/{commentId}/mark-unread
- patch/api/documents/{id}/comments/{commentId}
- delete/api/documents/{id}/comments/{commentId}
- post/api/documents/{id}/comments/{commentId}/reactions
- delete/api/documents/{id}/comments/{commentId}/reactions/{emoji}
- get/api/documents/{id}/versions
- post/api/documents/{id}/versions
- get/api/documents/{id}/versions/{versionId}
- patch/api/documents/{document_id}/versions/{version_id}
- delete/api/documents/{document_id}/versions/{version_id}
- post/api/documents/{id}/versions/{versionId}/revert
- post/api/documents/{id}/named-ranges
- get/api/documents/{id}/named-ranges
- delete/api/documents/{id}/named-ranges/{name}
- post/api/documents/{id}/named-ranges/{name}/replace
- post/api/documents/{id}/page-breaks
- post/api/documents/{id}/section-breaks
- post/api/documents/{id}/page-numbers
- post/api/documents/{id}/pinned-header-rows
- post/api/documents/{id}/tasks/adopt
- post/api/documents/{id}/leave
- get/api/documents/{id}/access-requests/current
- post/api/documents/{id}/access-requests
- post/api/documents/{id}/access-requests/{requestId}/decision
- patch/api/resources/{id}/star
- get/api/resources/{id}/comments
- post/api/resources/{id}/comments
- patch/api/comments/{id}
- delete/api/comments/{id}
- patch/api/reactions/{id}
- patch/api/comments/{id}/read
- post/api/resources/{id}/comments/read
- get/api/resources/{id}/access
- post/api/resources/{id}/access
- patch/api/resources/{id}/access
- delete/api/resources/{id}/access
- patch/api/resources/{id}/visibility
- post/api/resources/{id}/transfer-ownership
- post/api/resources/{id}/leave
- post/api/resources/{id}/access-requests
- get/api/resources/{id}/access-requests/current
- post/api/access-requests/{id}/decision
Show More
Sheets (Collapsed)
Copy link
Spreadsheets: cells, ranges, tabs, formulas, charts, pivots, validation, protection and data connectors.
Sheets Operations
- get/api/sheets/{id}/tables
- put/api/sheets/{id}/tables
- patch/api/sheets/{id}/tables/{table_id}
- delete/api/sheets/{id}/tables/{table_id}
- get/api/sheets/{id}/table-styles
- put/api/sheets/{id}/table-styles
- delete/api/sheets/{id}/table-styles/{style_id}
- put/api/sheets/{id}/table-theme
- get/api/sheets/{id}/sparklines
- post/api/sheets/{id}/sparklines
- patch/api/sheets/{id}/sparklines/{sparkline_id}
- delete/api/sheets/{id}/sparklines/{sparkline_id}
- get/api/sheets
- post/api/sheets
- post/api/sheets/import
- post/api/sheets/{id}/values/append
- post/api/sheets/{id}/values/batchGet
- post/api/sheets/{id}/values/batchClear
- post/api/sheets/{id}/sheets/copy
- post/api/sheets/{id}/named-ranges
- get/api/sheets/{id}/named-ranges
- delete/api/sheets/{id}/named-ranges/{name}
- patch/api/sheets/{id}/named-ranges/{name}
- post/api/sheets/{id}/validations
- delete/api/sheets/{id}/validations
- get/api/sheets/{id}/validations
- get/api/sheets/{id}/conditional-formats
- post/api/sheets/{id}/conditional-formats
- patch/api/sheets/{id}/conditional-formats/{ruleId}
- delete/api/sheets/{id}/conditional-formats/{ruleId}
- get/api/sheets/{id}/protected-ranges
- post/api/sheets/{id}/protected-ranges
- delete/api/sheets/{id}/protected-ranges/{rangeId}
- get/api/sheets/{id}
- get/api/sheets/{id}/data
- get/api/sheets/{id}/range
- patch/api/sheets/{id}/cells
- patch/api/sheets/{id}/merges
- post/api/sheets/{id}/tabs
- patch/api/sheets/{id}/tabs/{tab_name}
- delete/api/sheets/{id}/tabs/{tab_name}
- put/api/sheets/{id}/tabs/{tab_name}
- patch/api/sheets/{id}/tabs/{tab_name}/validation-settings
- patch/api/sheets/{id}/columns/{column_id}/type
- post/api/sheets/{id}/columns
- delete/api/sheets/{id}/columns/{column_id}
- post/api/sheets/{id}/delete-columns
- post/api/sheets/{id}/rows
- delete/api/sheets/{id}/rows
- post/api/sheets/{id}/sort
- post/api/sheets/{id}/move-column
- post/api/sheets/{id}/move-row
- post/api/sheets/{id}/restore-structure
- get/api/sheets/{id}/data-connectors
- post/api/sheets/{id}/data-connectors
- get/api/sheets/{id}/data-connectors/{connector_id}
- patch/api/sheets/{id}/data-connectors/{connector_id}
- delete/api/sheets/{id}/data-connectors/{connector_id}
- post/api/sheets/{id}/data-connectors/{connector_id}/run
- get/api/sheets/{id}/data-connectors/{connector_id}/run-history
- get/api/sheets/{id}/pivot-tables
- post/api/sheets/{id}/pivot-tables
- get/api/sheets/{id}/pivot-tables/{pivot_id}/computed
- patch/api/sheets/{id}/pivot-tables/{pivot_id}
- delete/api/sheets/{id}/pivot-tables/{pivot_id}
- get/api/sheets/{id}/picture-groups
- post/api/sheets/{id}/picture-groups
- patch/api/sheets/{id}/picture-groups/{group_id}
- delete/api/sheets/{id}/picture-groups/{group_id}
- get/api/sheets/{id}/images
- post/api/sheets/{id}/images
- patch/api/sheets/{id}/images/{image_id}
- delete/api/sheets/{id}/images/{image_id}
- get/api/sheets/{id}/shapes
- post/api/sheets/{id}/shapes
- patch/api/sheets/{id}/shapes/{shape_id}
- delete/api/sheets/{id}/shapes/{shape_id}
- get/api/sheets/{id}/charts
- post/api/sheets/{id}/charts
- patch/api/sheets/{id}/charts/{chart_id}
- delete/api/sheets/{id}/charts/{chart_id}
- get/api/sheets/{id}/slicers
- post/api/sheets/{id}/slicers
- patch/api/sheets/{id}/slicers/{slicer_id}
- delete/api/sheets/{id}/slicers/{slicer_id}
Show More
Slides (Collapsed)
Copy link
Presentations: slides, elements, masters, layouts, themes, templates and deck settings.
Slides Operations
- get/api/slides/layouts
- post/api/slides/import
- get/api/slides/templates
- post/api/slides/{id}/save-as-template
- post/api/slides/use-template
- get/api/slides/stars
- post/api/slides
- post/api/slides/{id}/star
- delete/api/slides/{id}/star
- get/api/slides/{id}/data
- post/api/slides/{id}/slides
- patch/api/slides/{id}/slides/{index}
- delete/api/slides/{id}/slides/{index}
- post/api/slides/{id}/slides/{index}/apply-master
- post/api/slides/{id}/slides/{index}/group
- post/api/slides/{id}/slides/{index}/ungroup/{group_id}
- post/api/slides/{id}/slides/{index}/duplicate
- get/api/slides/{id}/slides/{index}/thumbnail
- post/api/slides/{id}/slides/{index}/detach-master
- post/api/slides/{id}/transition-all
- patch/api/slides/{id}/reorder
- patch/api/slides/{id}/settings
- get/api/slides/{id}/masters
- post/api/slides/{id}/masters
- patch/api/slides/{id}/masters/{master_id}
- delete/api/slides/{id}/masters/{master_id}
- post/api/slides/{id}/masters/{master_id}/detach-and-delete
- post/api/slides/{id}/find-replace
- post/api/slides/{id}/fonts
- post/api/slides/{id}/replace-shapes-with-image
- get/api/slides/{id}/thumbnail
- post/api/slides/{id}/apply-template
- patch/api/resources/{id}/star
Show More
Canvas (Collapsed)
Copy link
Whiteboards: boards, elements, connectors, frames, comments and board previews.
Canvas Operations
- post/api/canvas
- get/api/canvas/{id}
- patch/api/canvas/{id}
- patch/api/canvas/{id}/timer
- get/api/canvas/{id}/manifest
- get/api/canvas/{id}/thumbnail
- post/api/canvas/{id}/export
- get/api/canvas/{id}/frames/{frameId}
- get/api/canvas/{id}/elements
- post/api/canvas/{id}/elements
- post/api/canvas/{id}/elements/batch
- post/api/canvas/{id}/elements/connected
- patch/api/canvas/{id}/elements/{elId}
- delete/api/canvas/{id}/elements/{elId}
- post/api/canvas/{id}/elements/{elId}/embed-url
Show More
Chat (Collapsed)
Copy link
Messaging: channels, direct messages, threads, reactions, pins, drafts, scheduled messages and polls.
Chat Operations
- get/api/channels
- post/api/channels
- get/api/channels/browse
- post/api/channels/mark-all-read
- get/api/channels/last-messages
- get/api/channels/engagement
- get/api/channels/messages/search
- post/api/channels/thread-activity/ack
- get/api/channels/thread-activity
- post/api/channels/mentions-activity/ack
- get/api/channels/saved-messages
- get/api/channels/scheduled-messages
- patch/api/channels/scheduled-messages/{message_id}
- delete/api/channels/scheduled-messages/{message_id}
- post/api/channels/scheduled-messages/{message_id}/send-now
- get/api/channels/emoji
- post/api/channels/emoji
- post/api/channels/emoji/fetch-url
- get/api/channels/emoji/{id}/image
- delete/api/channels/emoji/{emoji_id}
- post/api/channels/unfurl
- get/api/channels/status
- put/api/channels/status
- delete/api/channels/status
- put/api/channels/dnd
- get/api/channels/statuses
- get/api/channels/keywords
- put/api/channels/keywords
- post/api/channels/{id}/archive
- post/api/channels/{id}/unarchive
- post/api/channels/{id}/mute
- post/api/channels/{id}/unmute
- post/api/channels/{id}/star
- delete/api/channels/{id}/star
- post/api/channels/{id}/typing
- patch/api/channels/{id}/notification-preference
- post/api/channels/{id}/join
- post/api/channels/{id}/leave
- post/api/channels/{channel_id}/read
- post/api/channels/{channel_id}/unread
- get/api/channels/{channel_id}/read-receipts
- get/api/channels/{channel_id}/pins
- get/api/channels/{id}/saved-ids
- post/api/channels/{id}/members
- delete/api/channels/{id}/members/{userId}
- patch/api/channels/{channel_id}/members/{user_id}
- delete/api/channels/{id}/groups/{groupId}
- get/api/channels/{channel_id}/messages
- post/api/channels/{channel_id}/messages
- get/api/channels/{channel_id}/messages/{message_id}
- patch/api/channels/{channel_id}/messages/{message_id}
- delete/api/channels/{id}/messages/{msgId}
- post/api/channels/{channel_id}/messages/bulk-delete
- get/api/channels/{channel_id}/messages/{message_id}/readers
- post/api/channels/{channel_id}/messages/{message_id}/save
- delete/api/channels/{channel_id}/messages/{message_id}/save
- post/api/channels/{channel_id}/messages/{message_id}/remind
- delete/api/channels/{channel_id}/messages/{message_id}/remind
- patch/api/channels/{channel_id}/messages/{message_id}/remind
- post/api/channels/{id}/messages/{msgId}/reactions
- delete/api/channels/{id}/messages/{msgId}/reactions/{emoji}
- get/api/channels/{id}/messages/{msgId}/thread
- post/api/channels/{channel_id}/messages/{message_id}/thread/read
- post/api/channels/{channel_id}/messages/{message_id}/thread/unread
- get/api/channels/send-receipts/{key}
- get/api/channels/reactions-inbox
- get/api/channels/mentions-inbox
- get/api/channels/preferences
- get/api/channels/settings/link-previews
- put/api/channels/settings/link-previews
- patch/api/channels/{id}/notification-prefs
- get/api/channels/{id}
- patch/api/channels/{id}
- delete/api/channels/{id}
- post/api/polls
- get/api/polls/by-message/{message_id}
- get/api/polls/{poll_id}
- delete/api/polls/{poll_id}
- post/api/polls/{poll_id}/vote
- post/api/polls/{poll_id}/unvote
- get/api/polls/{poll_id}/results
- post/api/polls/{poll_id}/close
- get/api/chat-sidebar/sections
- post/api/chat-sidebar/sections
- patch/api/chat-sidebar/channel-placement
- patch/api/chat-sidebar/sections/reorder
- patch/api/chat-sidebar/sections/{id}
- delete/api/chat-sidebar/sections/{id}
- get/api/chat-drafts/slot
- get/api/chat-drafts
- put/api/chat-drafts
- post/api/chat-drafts
- patch/api/chat-drafts/{id}
- delete/api/chat-drafts/{id}
- get/api/channels/{channel_id}/slack-bridge
- post/api/channels/{channel_id}/slack-bridge
- delete/api/channels/{channel_id}/slack-bridge
- get/api/channels/{channel_id}/slack-bridge/channels
- get/api/channels/{channel_id}/slack-bridge/issues
- post/api/channels/{channel_id}/slack-bridge/reconcile
- patch/api/resource-actions/chat/channels/{id}/archived
- patch/api/resource-actions/chat/channels/{id}/muted
- patch/api/resources/{id}/star
- patch/api/reactions/{id}
Show More
Mail (Collapsed)
Copy link
Email: compose and send, inbox and folders, threads, labels, rules, templates, shared mailboxes, aliases and agent approvals.
Mail Operations
- get/api/mail/external/auth-url
- get/api/mail/external/callback
- get/api/mail/external/connections
- delete/api/mail/external/connections/{id}
- get/api/mail/external/connections/{id}/test
- get/api/mail/search
- post/api/mail/smart-compose
- post/api/mail/import/preview
- post/api/mail/import
- get/api/mail/{id}/export
- get/api/mail/folder-counts
- get/api/mail/unread-summary
- post/api/mail/html-preview
- get/api/mail/html-availability
- get/api/mail/send-as
- patch/api/mail/send-as
- get/api/mail/aliases
- post/api/mail/aliases
- put/api/mail/aliases/{id}/default
- delete/api/mail/aliases/{id}
- get/api/mail/approvals
- get/api/mail/approvals/{id}
- get/api/mail/approvals/{id}/attachments/{index}/download
- get/api/mail/approvals/{id}/attachments/{index}/content
- post/api/mail/approvals/{id}/decision
- get/api/mail/shared-mailboxes
- post/api/mail/shared-mailboxes
- get/api/mail/shared-mailboxes/{mailboxId}
- patch/api/mail/shared-mailboxes/{mailboxId}
- delete/api/mail/shared-mailboxes/{mailboxId}
- post/api/mail/shared-mailboxes/{mailboxId}/restore
- get/api/mail/shared-mailboxes/{mailboxId}/assignees
- post/api/mail/shared-mailboxes/{mailboxId}/members
- delete/api/mail/shared-mailboxes/{mailboxId}/members/{memberId}
- get/api/mail/signature
- put/api/mail/signature
- post/api/mail/send
- get/api/mail/inbox
- get/api/mail/sent
- get/api/mail/starred
- get/api/mail/snoozed
- get/api/mail/archive
- get/api/mail/muted
- get/api/mail/trash
- get/api/mail/drafts
- post/api/mail/drafts
- patch/api/mail/drafts/{id}
- post/api/mail/drafts/{id}/send
- get/api/mail/scheduled
- post/api/mail/{id}/reschedule
- get/api/mail/settings/undo-send
- put/api/mail/settings/undo-send
- post/api/mail/{id}/undo
- get/api/mail/settings/read-receipts
- put/api/mail/settings/read-receipts
- get/api/mail/settings/snooze-presets
- put/api/mail/settings/snooze-presets
- get/api/mail/settings/swipe-actions
- put/api/mail/settings/swipe-actions
- get/api/mail/{id}/opens
- get/api/mail/label/{label}
- get/api/mail/rule-changesets/{changeset_id}
- post/api/mail/rule-changesets/{changeset_id}/undo
- get/api/mail/rule-applications/{application_id}
- get/api/mail/rule-applications/{application_id}/conflicts
- post/api/mail/rule-applications/{application_id}/cancel
- post/api/mail/rule-applications/{application_id}/undo
- post/api/mail/rule-applications/{application_id}/retry
- post/api/mail/rules/from-search/preview
- post/api/mail/rules/from-search
- post/api/mail/rules/import/preview
- post/api/mail/rules/import
- post/api/mail/rules/export/preview
- post/api/mail/rules/export
- get/api/mail/rules
- post/api/mail/rules
- post/api/mail/rules/preview
- post/api/mail/rules/{rule_id}/applications
- post/api/mail/rules/bulk
- post/api/mail/rules/{rule_id}/duplicate
- post/api/mail/rules/reorder
- get/api/mail/rules/{rule_id}
- patch/api/mail/rules/{rule_id}
- delete/api/mail/rules/{rule_id}
- get/api/mail/templates
- post/api/mail/templates
- get/api/mail/templates/{template_id}
- patch/api/mail/templates/{template_id}
- delete/api/mail/templates/{template_id}
- post/api/mail/templates/{template_id}/use
- get/api/mail/labels
- post/api/mail/labels
- get/api/mail/label-counts
- post/api/mail/labels/reorder
- patch/api/mail/labels/{label_id}
- delete/api/mail/labels/{label_id}
- get/api/mail/vacation
- put/api/mail/vacation
- get/api/mail/blocklist
- post/api/mail/blocklist
- delete/api/mail/blocklist
- post/api/mail/blocklist/unblock
- delete/api/mail/blocklist/{id}
- post/api/mail/{id}/unsubscribe
- get/api/mail/forwarding
- post/api/mail/forwarding
- post/api/mail/forwarding/{id}/resend
- delete/api/mail/forwarding/{id}
- post/api/mail/merge-preview
- post/api/mail/merge-send
- post/api/mail/merge-parse-csv
- get/api/mail/thread/{thread_id}
- delete/api/mail/thread/{thread_id}
- post/api/mail/thread/{thread_id}/mute
- delete/api/mail/thread/{thread_id}/mute
- get/api/mail/thread/{threadId}/mute
- put/api/mail/thread/{thread_id}/assignee
- delete/api/mail/thread/{thread_id}/assignee
- post/api/mail/thread/{thread_id}/archive
- post/api/mail/thread/{thread_id}/trash
- post/api/mail/thread/{thread_id}/untrash
- get/api/mail/thread/{thread_id}/comments
- post/api/mail/thread/{thread_id}/comments
- patch/api/mail/thread/{thread_id}/comments/{comment_id}
- delete/api/mail/thread/{thread_id}/comments/{comment_id}
- patch/api/mail/thread/{thread_id}/comments/{comment_id}/read
- post/api/mail/thread/{thread_id}/comments/mark-read
- post/api/mail/thread/{thread_id}/comments/{comment_id}/reactions
- delete/api/mail/thread/{thread_id}/comments/{comment_id}/reactions/{emoji}
- post/api/mail/batch/archive
- post/api/mail/batch/trash
- post/api/mail/batch/modify
- post/api/mail/batch/delete
- post/api/mail/bulk
- get/api/mail/{id}/invite
- post/api/mail/{id}/rsvp
- get/api/mail/{id}/attachments
- get/api/mail/{id}/attachments/{attachment_id}/download
- get/api/mail/{id}/attachments/{attachment_id}/content
- post/api/mail/{id}/archive
- delete/api/mail/{id}/archive
- post/api/mail/{id}/untrash
- delete/api/mail/{id}/permanent
- post/api/mail/{id}/snooze
- post/api/mail/{id}/cancel
- get/api/mail/{id}
- patch/api/mail/{id}
- delete/api/mail/{id}
- post/api/mail-forwarding-public/verify
- patch/api/resource-actions/mail/emails/{id}/archived
- patch/api/resource-actions/mail/threads/{id}/muted
- patch/api/resource-actions/mail/threads/{id}/assignee
- get/api/resources/{id}/comments
- post/api/resources/{id}/comments
- patch/api/comments/{id}
- delete/api/comments/{id}
- patch/api/reactions/{id}
- patch/api/comments/{id}/read
- post/api/resources/{id}/comments/read
Show More
Drive (Collapsed)
Copy link
File storage: uploads, folders, sharing, shared drives, versions, tags, trash and file requests.
Drive Operations
- get/api/public/file-requests/{token}/meta
- post/api/public/file-requests/{token}/upload
- get/api/public/file-requests/by-id/{requestId}/meta
- post/api/public/file-requests/by-id/{requestId}/upload
- get/api/drive
- get/api/drive/{id}/children
- get/api/drive/folders
- post/api/drive/folders
- get/api/drive/folders/{id}/ancestors
- post/api/drive/folders/{folderId}/file-requests
- get/api/drive/folders/{folderId}/file-requests
- post/api/drive/folders/{folderId}/file-requests/{requestId}/remint
- post/api/drive/folders/{folderId}/file-requests/{requestId}/revoke
- post/api/drive/upload
- post/api/drive/upload-proxy
- post/api/drive/import
- post/api/drive/{id}/confirm-upload
- get/api/drive/storage
- get/api/drive/storage/breakdown
- get/api/drive/recent
- get/api/drive/suggested
- get/api/drive/starred
- get/api/drive/shared-with-me
- get/api/drive/tags
- post/api/drive/tags
- patch/api/drive/tags/{id}
- delete/api/drive/tags/{id}
- get/api/drive/tags/{id}/files
- get/api/drive/batch
- get/api/drive/batch/permissions
- post/api/drive/batch/move
- post/api/drive/batch/copy
- post/api/drive/download-zip
- get/api/drive/trash
- delete/api/drive/trash
- get/api/drive/shared-drives
- post/api/drive/shared-drives
- get/api/drive/shared-drives/{driveId}
- patch/api/drive/shared-drives/{driveId}
- delete/api/drive/shared-drives/{driveId}
- get/api/drive/shared-drives/{driveId}/members
- post/api/drive/shared-drives/{driveId}/members
- patch/api/drive/shared-drives/{driveId}/members/{userId}
- delete/api/drive/shared-drives/{driveId}/members/{userId}
- get/api/drive/shared-drives/{driveId}/files
- post/api/drive/shared-drives/{driveId}/folders
- post/api/drive/shared-drives/{driveId}/upload
- get/api/drive/{id}/download
- get/api/drive/{id}/view
- post/api/drive/{id}/view
- post/api/drive/{id}/star
- post/api/drive/{id}/tags
- delete/api/drive/{id}/tags/{tagId}
- get/api/drive/{id}/content
- get/api/drive/{id}/permissions
- post/api/drive/{id}/permissions
- patch/api/drive/{id}/permissions/{principalId}
- delete/api/drive/{id}/permissions/{principalId}
- get/api/drive/{id}/comments
- post/api/drive/{id}/comments
- patch/api/drive/{id}/comments/{commentId}
- delete/api/drive/{id}/comments/{commentId}
- patch/api/drive/{id}/comments/{commentId}/read
- post/api/drive/{id}/comments/mark-read
- post/api/drive/{id}/comments/{commentId}/reactions
- delete/api/drive/{id}/comments/{commentId}/reactions/{emoji}
- post/api/drive/{id}/extract-text
- get/api/drive/{id}/extract-text/jobs/{jobId}
- patch/api/drive/{id}/visibility
- post/api/drive/{id}/revoke-link
- post/api/drive/{id}/publish-gallery
- post/api/drive/{id}/revoke-gallery
- post/api/drive/{id}/transfer-ownership
- post/api/drive/{id}/share-invite
- delete/api/drive/{id}/pending-shares/{pendingId}
- post/api/drive/{id}/restore
- delete/api/drive/{id}/permanent
- post/api/drive/{id}/export
- get/api/drive/{id}
- patch/api/drive/{id}
- delete/api/drive/{id}
- post/api/drive/{id}/versions
- get/api/drive/{id}/versions
- get/api/drive/{id}/versions/{versionId}
- delete/api/drive/{id}/versions/{versionId}
- post/api/drive/{id}/versions/{versionId}/restore
- post/api/drive/{id}/leave
- get/api/drive/{id}/access-requests/current
- post/api/drive/{id}/access-requests
- post/api/drive/{id}/access-requests/{requestId}/decision
- patch/api/resources/{id}/star
- get/api/resources/{id}/comments
- post/api/resources/{id}/comments
- patch/api/comments/{id}
- delete/api/comments/{id}
- patch/api/reactions/{id}
- patch/api/comments/{id}/read
- post/api/resources/{id}/comments/read
- get/api/resources/{id}/access
- post/api/resources/{id}/access
- patch/api/resources/{id}/access
- delete/api/resources/{id}/access
- patch/api/resources/{id}/visibility
- post/api/resources/{id}/transfer-ownership
- post/api/resources/{id}/leave
- post/api/resources/{id}/access-requests
- get/api/resources/{id}/access-requests/current
- post/api/access-requests/{id}/decision
Show More
Tasks (Collapsed)
Copy link
Task management: tasks, subtasks, statuses, assignment, labels, views, relations, time tracking and templates.
Tasks Operations
- get/api/tasks/templates
- post/api/tasks/templates
- post/api/tasks/templates/{template_id}/apply
- get/api/tasks/templates/{templateId}
- patch/api/tasks/templates/{templateId}
- delete/api/tasks/templates/{templateId}
- get/api/tasks/export
- get/api/tasks/batch
- get/api/tasks/statuses
- post/api/tasks/statuses
- post/api/tasks/statuses/reorder
- patch/api/tasks/statuses/{status_id}
- delete/api/tasks/statuses/{status_id}
- get/api/tasks/custom-fields
- post/api/tasks/custom-fields
- post/api/tasks/custom-fields/reorder
- patch/api/tasks/custom-fields/{field_id}
- delete/api/tasks/custom-fields/{field_id}
- get/api/tasks/labels
- post/api/tasks/labels
- patch/api/tasks/labels/{labelId}
- delete/api/tasks/labels/{labelId}
- get/api/tasks/sla/thresholds
- get/api/tasks/sla/dashboard
- get/api/tasks/views
- post/api/tasks/views
- patch/api/tasks/views/{viewId}
- delete/api/tasks/views/{viewId}
- get/api/tasks/views/{viewId}/layout
- patch/api/tasks/views/{viewId}/layout
- get/api/tasks/subscribed
- get/api/tasks/analytics
- get/api/tasks/workload
- get/api/tasks/goals
- post/api/tasks/goals
- get/api/tasks/goals/{id}
- patch/api/tasks/goals/{id}
- delete/api/tasks/goals/{id}
- get/api/tasks/goals/{goal_id}/tasks
- post/api/tasks/bulk/update
- post/api/tasks/bulk/delete
- post/api/tasks/bulk/archive
- post/api/tasks/clear
- get/api/tasks/inbox-count
- post/api/tasks/maintenance/auto-close
- post/api/tasks/maintenance/auto-archive
- get/api/tasks/timer/active
- get/api/tasks/favorites
- post/api/tasks/favorites
- delete/api/tasks/favorites
- put/api/tasks/favorites/reorder
- get/api/tasks/by-key/{taskKey}
- get/api/tasks/by-keys
- get/api/tasks/relations/batch
- get/api/tasks/trash
- get/api/tasks
- post/api/tasks
- post/api/tasks/{id}/labels
- delete/api/tasks/{id}/labels/{labelId}
- get/api/tasks/{id}/subscriptions
- post/api/tasks/{id}/subscribe
- delete/api/tasks/{id}/subscribe
- delete/api/tasks/{id}/subscriptions/{userId}
- get/api/tasks/{id}/subscription-status
- get/api/tasks/{id}/collaborators
- post/api/tasks/{id}/collaborators
- delete/api/tasks/{id}/collaborators/{userId}
- get/api/tasks/{id}/pr-links
- post/api/tasks/{id}/pr-links
- patch/api/tasks/{id}/pr-links/{linkId}
- delete/api/tasks/{id}/pr-links/{linkId}
- get/api/tasks/{id}/subtasks
- post/api/tasks/{id}/subtasks
- get/api/tasks/{task_id}/comments
- post/api/tasks/{task_id}/comments
- patch/api/tasks/{task_id}/comments/{comment_id}
- delete/api/tasks/{task_id}/comments/{comment_id}
- patch/api/tasks/{task_id}/comments/{comment_id}/read
- post/api/tasks/{task_id}/comments/mark-read
- post/api/tasks/{task_id}/comments/{comment_id}/reactions
- delete/api/tasks/{task_id}/comments/{comment_id}/reactions/{emoji}
- post/api/tasks/{task_id}/timer/start
- post/api/tasks/{task_id}/timer/stop
- get/api/tasks/{task_id}/time-entries
- post/api/tasks/{task_id}/time-entries
- delete/api/tasks/{task_id}/time-entries/{entry_id}
- get/api/tasks/{id}/activity
- get/api/tasks/{id}/status-history
- get/api/tasks/{id}/relations
- post/api/tasks/{id}/relations
- delete/api/tasks/{id}/relations/{relationId}
- post/api/tasks/{id}/restore
- post/api/tasks/{id}/archive
- post/api/tasks/{id}/unarchive
- delete/api/tasks/{id}/permanent
- post/api/tasks/{id}/duplicate
- get/api/tasks/{id}/attachments
- post/api/tasks/{id}/attachments
- post/api/tasks/{id}/attachments/upload
- delete/api/tasks/{id}/attachments/{attachmentId}
- get/api/tasks/{id}
- patch/api/tasks/{id}
- delete/api/tasks/{id}
- get/api/tasks/{id}/permissions
- get/api/tasks/{id}/access-requests/current
- post/api/tasks/{id}/access-requests
- post/api/tasks/{id}/access-requests/{requestId}/decision
- patch/api/resource-actions/tasks/{id}/archived
- patch/api/resource-actions/tasks/{id}/subscription
- get/api/resources/{id}/comments
- post/api/resources/{id}/comments
- patch/api/comments/{id}
- delete/api/comments/{id}
- patch/api/reactions/{id}
- patch/api/comments/{id}/read
- post/api/resources/{id}/comments/read
- post/api/resources/{id}/access-requests
- get/api/resources/{id}/access-requests/current
- post/api/access-requests/{id}/decision
Show More
Projects (Collapsed)
Copy link
Task projects: members, visibility, templates, updates and notification preferences.
Projects Operations
- get/api/projects/templates
- post/api/projects/templates
- post/api/projects/templates/{templateId}/apply
- get/api/projects/templates/{templateId}
- delete/api/projects/templates/{templateId}
- get/api/projects
- post/api/projects
- get/api/projects/{id}
- patch/api/projects/{id}
- delete/api/projects/{id}
- get/api/projects/{id}/members
- post/api/projects/{id}/members
- patch/api/projects/{id}/members/{userId}
- delete/api/projects/{id}/members/{userId}
- get/api/projects/{project_id}/updates
- post/api/projects/{project_id}/updates
- patch/api/projects/{id}/updates/{updateId}
- delete/api/projects/{id}/updates/{updateId}
- get/api/projects/{id}/notification-preference
- patch/api/projects/{id}/notification-preference
- get/api/projects/{id}/github
- post/api/projects/{id}/github
- patch/api/projects/{id}/github/{mappingId}
- delete/api/projects/{id}/github/{mappingId}
- get/api/projects/{id}/access-requests/current
- post/api/projects/{id}/access-requests
- post/api/projects/{id}/access-requests/{requestId}/decision
- post/api/resources/{id}/access-requests
- get/api/resources/{id}/access-requests/current
- post/api/access-requests/{id}/decision
Show More
Cycles (Collapsed)
Copy link
Time-boxed cycles that group tasks, with analytics and velocity.
Cycles Operations
- get/api/cycles
- post/api/cycles
- get/api/cycles/velocity
- get/api/cycles/{id}
- patch/api/cycles/{id}
- delete/api/cycles/{id}
- get/api/cycles/{id}/analytics
- post/api/cycles/{id}/complete
- post/api/cycles/{id}/tasks
- delete/api/cycles/{id}/tasks
Show More
Code (Collapsed)
Copy link
Pull-request review backed by GitHub: repositories, grants, pull requests, reviews and merges.
Code Operations
- get/api/code/repositories/{id}/compare
- get/api/code/pulls/{id}/commits/{sha}
- get/api/code/pulls/{id}/changes-since-review
- get/api/code/repositories/{id}/principals
- get/api/code/connections
- get/api/code/repositories
- post/api/code/repositories
- patch/api/code/repositories/{id}
- get/api/code/repositories/{id}/grants
- post/api/code/repositories/{id}/grants
- get/api/code/repositories/{id}/reviewers
- get/api/code/repositories/{id}/metadata
- get/api/code/pulls
- post/api/code/pulls
- get/api/code/pulls/{id}
- patch/api/code/pulls/{id}
- get/api/code/pulls/{id}/tasks
- post/api/code/pulls/{id}/refresh
- post/api/code/pulls/{id}/reviews
- post/api/code/pulls/{id}/dismiss-review
- post/api/code/pulls/{id}/resolve-review
- post/api/code/pulls/{id}/auto-merge
- get/api/code/pulls/{id}/comments
- post/api/code/pulls/{id}/comments
- patch/api/code/pulls/{id}/comments/{commentId}
- post/api/code/pulls/{id}/resolve-thread
- post/api/code/pulls/{id}/thread-read
- post/api/code/pulls/{id}/comments/mark-read
- post/api/code/pulls/{id}/reviews/draft
- post/api/code/pulls/{id}/merge
- get/api/code/pulls/{id}/export
- get/api/resources/{id}/comments
- post/api/resources/{id}/comments
- patch/api/comments/{id}
- delete/api/comments/{id}
- patch/api/reactions/{id}
- patch/api/comments/{id}/read
- post/api/resources/{id}/comments/read
Show More
CRM (Collapsed)
Copy link
Contacts, companies, deals, pipelines, activities, quotes, products, sequences, lead scoring and scheduling links.
CRM Operations
- get/api/crm/lifecycle-stages
- post/api/crm/lifecycle-stages
- patch/api/crm/lifecycle-stages/{key}
- get/api/crm/workspace-users
- get/api/crm/address-book
- post/api/crm/address-book/purge
- get/api/crm/user-contacts/{id}/promotion-candidates
- post/api/crm/user-contacts/{id}/promote
- get/api/crm/property-definitions
- post/api/crm/property-definitions
- patch/api/crm/property-definitions/{id}
- delete/api/crm/property-definitions/{id}
- get/api/crm/metrics
- get/api/crm/reports
- get/api/crm/contacts
- post/api/crm/contacts
- get/api/crm/contacts/batch
- post/api/crm/contacts/merge
- post/api/crm/contacts/bulk-delete
- post/api/crm/contacts/bulk-update
- post/api/crm/contacts/bulk-export
- post/api/crm/contacts/import/preview
- post/api/crm/contacts/import
- get/api/crm/contacts/{id}
- patch/api/crm/contacts/{id}
- delete/api/crm/contacts/{id}
- get/api/crm/contacts/{id}/activities
- get/api/crm/contacts/{id}/score
- get/api/crm/contacts/{id}/files
- post/api/crm/contacts/{id}/files
- delete/api/crm/contacts/{id}/files/{fileId}
- post/api/crm/contacts/{id}/photo
- get/api/crm/contacts/{id}/photo
- delete/api/crm/contacts/{id}/photo
- get/api/crm/contact-groups
- post/api/crm/contact-groups
- patch/api/crm/contact-groups/{id}
- delete/api/crm/contact-groups/{id}
- get/api/crm/contact-groups/{id}/members
- post/api/crm/contact-groups/{id}/members
- get/api/crm/deals
- post/api/crm/deals
- get/api/crm/deals/batch
- get/api/crm/deals/{id}
- patch/api/crm/deals/{id}
- delete/api/crm/deals/{id}
- get/api/crm/deals/{id}/activities
- post/api/crm/deals/bulk-delete
- post/api/crm/deals/bulk-update
- post/api/crm/deals/bulk-export
- get/api/crm/deals/{id}/line-items
- post/api/crm/deals/{id}/line-items
- patch/api/crm/deals/line-items/{id}
- delete/api/crm/deals/line-items/{id}
- get/api/crm/deals/{id}/files
- post/api/crm/deals/{id}/files
- delete/api/crm/deals/{id}/files/{fileId}
- get/api/crm/deal-templates
- post/api/crm/deal-templates
- get/api/crm/deal-templates/{id}
- patch/api/crm/deal-templates/{id}
- delete/api/crm/deal-templates/{id}
- post/api/crm/deal-templates/{id}/apply
- get/api/crm/pipelines
- post/api/crm/pipelines
- get/api/crm/pipelines/{id}
- patch/api/crm/pipelines/{id}
- delete/api/crm/pipelines/{id}
- get/api/crm/analytics
- get/api/crm/pipelines/{id}/permissions
- post/api/crm/pipelines/{id}/permissions
- delete/api/crm/pipelines/{id}/permissions/{principalId}
- get/api/crm/activities
- post/api/crm/activities
- get/api/crm/activities/{id}
- delete/api/crm/activities/{id}
- get/api/crm/sequences
- post/api/crm/sequences
- get/api/crm/sequences/{id}
- patch/api/crm/sequences/{id}
- delete/api/crm/sequences/{id}
- post/api/crm/sequences/process
- get/api/crm/sequences/{id}/enrollments
- post/api/crm/sequences/{id}/enroll
- post/api/crm/sequences/enrollments/{id}/unenroll
- get/api/crm/sequences/enrollments/{id}/events
- get/api/crm/scoring/fields
- post/api/crm/scoring/recalculate
- get/api/crm/scoring/rules
- post/api/crm/scoring/rules
- patch/api/crm/scoring/rules/{id}
- delete/api/crm/scoring/rules/{id}
- get/api/crm/quotes
- post/api/crm/quotes
- get/api/crm/quotes/{id}
- patch/api/crm/quotes/{id}
- delete/api/crm/quotes/{id}
- post/api/crm/quotes/{id}/send
- get/api/crm/quotes/{id}/pdf
- get/api/crm/marketing-lists
- post/api/crm/marketing-lists
- get/api/crm/marketing-lists/{id}/members
- post/api/crm/marketing-lists/{id}/members
- delete/api/crm/marketing-lists/{id}/members/{memberId}
- get/api/crm/products
- post/api/crm/products
- get/api/crm/products/{id}
- patch/api/crm/products/{id}
- delete/api/crm/products/{id}
- get/api/crm/views
- post/api/crm/views
- patch/api/crm/views/{id}
- delete/api/crm/views/{id}
- get/api/crm/scheduler-links
- post/api/crm/scheduler-links
- get/api/crm/scheduler-links/{id}
- patch/api/crm/scheduler-links/{id}
- delete/api/crm/scheduler-links/{id}
- get/api/crm/scheduler-links/{id}/bookings
- get/api/crm/scheduler-bookings
- post/api/crm/scheduler-bookings/{id}/cancel
- get/api/crm/pipelines/{id}/access-requests/current
- post/api/crm/pipelines/{id}/access-requests
- post/api/crm/pipelines/{id}/access-requests/{requestId}/decision
- post/api/resources/{id}/access-requests
- get/api/resources/{id}/access-requests/current
- post/api/access-requests/{id}/decision
Show More
Forms (Collapsed)
Copy link
Forms and surveys: fields, publishing, responses, variants and analytics.
Forms Operations
- get/api/forms/w/{workspaceSlug}/{formSlug}
- post/api/forms/w/{workspaceSlug}/{formSlug}/submit
- get/api/forms/s/{slug}
- post/api/forms/s/{slug}/submit
- post/api/forms/{id}/views
- post/api/forms/{id}/payment-intent
- post/api/forms/stripe/webhook
- post/api/forms/w/{workspaceSlug}/{formSlug}/upload
- post/api/forms/{slug}/upload
- post/api/forms/{slug}/submit
- get/api/forms
- post/api/forms
- get/api/forms/{id}/responses
- get/api/forms/{id}/responses/export
- get/api/forms/{id}/responses/{rid}
- delete/api/forms/{id}/responses/{rid}
- get/api/forms/{id}/variants
- post/api/forms/{id}/variants
- patch/api/forms/{id}/variants/{vid}
- delete/api/forms/{id}/variants/{vid}
- get/api/forms/{id}/analytics
- get/api/forms/{id}/ab-analytics
- post/api/forms/{id}/publish
- post/api/forms/{id}/unpublish
- get/api/forms/{id}/permissions
- post/api/forms/{id}/permissions
- patch/api/forms/{id}/permissions/{principalId}
- delete/api/forms/{id}/permissions/{principalId}
- post/api/forms/{id}/share-invite
- delete/api/forms/{id}/pending-shares/{pendingId}
- patch/api/forms/{id}/visibility
- post/api/forms/{id}/revoke-link
- post/api/forms/{id}/transfer-ownership
- post/api/forms/{id}/star
- get/api/forms/{id}
- patch/api/forms/{id}
- delete/api/forms/{id}
- post/api/forms/{id}/leave
- get/api/forms/{id}/access-requests/current
- post/api/forms/{id}/access-requests
- post/api/forms/{id}/access-requests/{requestId}/decision
- patch/api/resources/{id}/star
- get/api/resources/{id}/access
- post/api/resources/{id}/access
- patch/api/resources/{id}/access
- delete/api/resources/{id}/access
- patch/api/resources/{id}/visibility
- post/api/resources/{id}/transfer-ownership
- post/api/resources/{id}/leave
- post/api/resources/{id}/access-requests
- get/api/resources/{id}/access-requests/current
- post/api/access-requests/{id}/decision
Show More
Calendar (Collapsed)
Copy link
Calendars and events: recurrence, attendees, RSVPs, free/busy, reminders, resources, sharing and external sync.
Calendar Operations
- post/api/calendars/{id}/leave
- get/api/calendars/{id}/access-requests/current
- post/api/calendars/{id}/access-requests
- post/api/calendars/{id}/access-requests/{requestId}/decision
- get/api/calendars/colors
- get/api/calendars/availability
- get/api/calendars/conflicts
- get/api/calendars/ooo-status
- get/api/calendars/attendee-identity
- get/api/calendars/ooo-conflicts
- get/api/calendars/upcoming-reminders
- get/api/calendars
- post/api/calendars
- get/api/calendars/public/{token}/feed.ics
- get/api/calendars/external/status
- get/api/calendars/external/auth-url
- get/api/calendars/external/callback
- get/api/calendars/external/connections
- delete/api/calendars/external/connections/{id}
- get/api/calendars/external/connections/{id}/calendars
- post/api/calendars/external/connections/{id}/calendars
- post/api/calendars/external/connections/{id}/sync
- delete/api/calendars/external/synced/{calendar_id}
- get/api/calendars/events
- get/api/calendars/{calendar_id}/events
- post/api/calendars/{calendar_id}/events
- get/api/calendars/events/search
- get/api/calendars/events/{id}
- patch/api/calendars/events/{id}
- delete/api/calendars/events/{id}
- get/api/calendars/events/{id}/instances
- post/api/calendars/events/{id}/rsvp
- get/api/calendars/events/{id}/rsvp-email
- post/api/calendars/events/{id}/export
- post/api/calendars/events/{id}/edit-single
- post/api/calendars/events/{id}/edit-future
- post/api/calendars/events/{id}/edit-all
- post/api/calendars/events/{id}/delete-single
- post/api/calendars/events/{id}/delete-future
- post/api/calendars/events/{event_id}/resources
- get/api/calendars/events/{event_id}/resources
- delete/api/calendars/events/{id}/resources
- get/api/calendars/events/{id}/reminders
- post/api/calendars/events/{id}/reminders
- put/api/calendars/events/{id}/reminders
- post/api/calendars/events/{id}/meeting-notes
- delete/api/calendars/events/{id}/meeting-notes
- get/api/calendars/resources
- post/api/calendars/resources
- get/api/calendars/resources/{id}
- patch/api/calendars/resources/{id}
- delete/api/calendars/resources/{id}
- get/api/calendars/resources/{resource_id}/availability
- delete/api/calendars/reminders/{reminderId}
- get/api/calendars/{calendar_id}/permissions
- post/api/calendars/{calendar_id}/permissions
- get/api/calendars/{calendar_id}/permissions/{user_id}
- patch/api/calendars/{id}/permissions/{principalId}
- delete/api/calendars/{id}/permissions/{principalId}
- delete/api/calendars/{id}/pending-shares/{pendingId}
- patch/api/calendars/{id}/visibility
- post/api/calendars/{id}/share-invite
- post/api/calendars/{calendar_id}/publish
- delete/api/calendars/{calendar_id}/publish
- post/api/calendars/{calendar_id}/publish/rotate
- post/api/calendars/{id}/import
- post/api/calendars/{id}/import-url
- post/api/calendars/{id}/export
- delete/api/calendars/{id}/clear
- get/api/calendars/{id}
- patch/api/calendars/{id}
- delete/api/calendars/{id}
- get/api/resources/{id}/access
- post/api/resources/{id}/access
- patch/api/resources/{id}/access
- delete/api/resources/{id}/access
- patch/api/resources/{id}/visibility
- post/api/resources/{id}/leave
- post/api/resources/{id}/access-requests
- get/api/resources/{id}/access-requests/current
- post/api/access-requests/{id}/decision
Show More
Wiki (Collapsed)
Copy link
Knowledge base: spaces, pages, inline databases, backlinks, synced blocks and page versions.
Wiki Operations
- post/api/wiki/pages/{id}/leave
- get/api/wiki/pages/{id}/access-requests/current
- post/api/wiki/pages/{id}/access-requests
- post/api/wiki/pages/{id}/access-requests/{requestId}/decision
- get/api/wiki/recents
- post/api/wiki/recents
- get/api/wiki/favorites
- put/api/wiki/favorites/{id}
- delete/api/wiki/favorites/{id}
- get/api/wiki/native-backup
- post/api/wiki/native-restore
- get/api/wiki/spaces
- post/api/wiki/spaces
- get/api/wiki/spaces/{id}/members
- post/api/wiki/spaces/{id}/members
- delete/api/wiki/spaces/{id}/members/{userId}
- get/api/wiki/spaces/{id}/graph
- get/api/wiki/spaces/{id}/pages
- post/api/wiki/spaces/{id}/pages
- post/api/wiki/spaces/{id}/pages/import
- get/api/wiki/spaces/{slug}
- patch/api/wiki/spaces/{id}
- delete/api/wiki/spaces/{id}
- get/api/wiki/trash
- post/api/wiki/pages/{id}/restore
- delete/api/wiki/pages/{id}/permanent
- get/api/wiki/pages/{id}/children
- get/api/wiki/pages/{id}/backlinks
- get/api/wiki/pages/{id}/versions
- post/api/wiki/pages/{id}/versions
- get/api/wiki/pages/{id}/versions/{versionId}
- post/api/wiki/pages/{id}/versions/{versionId}/revert
- post/api/wiki/pages/{id}/duplicate
- post/api/wiki/pages/{id}/export
- get/api/wiki/pages/{id}/databases
- post/api/wiki/pages/{id}/databases
- get/api/wiki/pages/{id}/permissions
- post/api/wiki/pages/{id}/permissions
- patch/api/wiki/pages/{id}/permissions/{principalId}
- delete/api/wiki/pages/{id}/permissions/{userId}
- post/api/wiki/pages/{id}/share-invite
- delete/api/wiki/pages/{id}/pending-shares/{pendingId}
- patch/api/wiki/pages/{id}/visibility
- post/api/wiki/pages/{id}/revoke-link
- post/api/wiki/pages/{id}/tasks/adopt
- get/api/wiki/pages/{id}/comments
- post/api/wiki/pages/{id}/comments
- patch/api/wiki/pages/{id}/comments/{commentId}
- delete/api/wiki/pages/{id}/comments/{commentId}
- patch/api/wiki/pages/{id}/comments/{commentId}/read
- post/api/wiki/pages/{id}/comments/mark-read
- post/api/wiki/pages/{id}/comments/{commentId}/reactions
- delete/api/wiki/pages/{id}/comments/{commentId}/reactions/{emoji}
- get/api/wiki/pages/{id}
- patch/api/wiki/pages/{id}
- delete/api/wiki/pages/{id}
- get/api/wiki/search
- post/api/wiki/databases
- post/api/wiki/databases/{id}/rows
- patch/api/wiki/databases/{id}/rows/{rowId}
- delete/api/wiki/databases/{id}/rows/{rowId}
- get/api/wiki/databases/{id}/rows/{rowId}
- get/api/wiki/databases/{id}/query
- post/api/wiki/databases/{id}/relations/ensure-reverse
- get/api/wiki/databases/{id}/rollups
- get/api/wiki/databases/{id}
- patch/api/wiki/databases/{id}
- get/api/wiki/synced-blocks/by-page/{pageId}
- post/api/wiki/synced-blocks
- get/api/wiki/synced-blocks/{id}
- patch/api/wiki/synced-blocks/{id}
- delete/api/wiki/synced-blocks/{id}
- post/api/wiki/synced-blocks/{id}/restore
- patch/api/resources/{id}/star
- get/api/resources/{id}/comments
- post/api/resources/{id}/comments
- patch/api/comments/{id}
- delete/api/comments/{id}
- patch/api/reactions/{id}
- patch/api/comments/{id}/read
- post/api/resources/{id}/comments/read
- get/api/resources/{id}/access
- post/api/resources/{id}/access
- patch/api/resources/{id}/access
- delete/api/resources/{id}/access
- patch/api/resources/{id}/visibility
- post/api/resources/{id}/leave
- post/api/resources/{id}/access-requests
- get/api/resources/{id}/access-requests/current
- post/api/access-requests/{id}/decision
Show More
Sign (Collapsed)
Copy link
E-signature: documents, signers, fields, sending, sealed copies, certificates and templates.
Sign Operations
- get/api/sign/retention
- patch/api/sign/retention
- get/api/sign/purge-queue
- get/api/sign/templates
- post/api/sign/templates
- post/api/sign/templates/{id}/use
- post/api/sign
- get/api/sign
- get/api/sign/{id}
- patch/api/sign/{id}
- delete/api/sign/{id}
- get/api/sign/{id}/audit
- patch/api/sign/{id}/retention
- post/api/sign/{id}/restore-from-purge
- post/api/sign/{id}/signers
- put/api/sign/{id}/signers/order
- post/api/sign/{id}/fields
- patch/api/sign/{id}/fields/{field_id}
- delete/api/sign/{id}/fields/{field_id}
- delete/api/sign/{id}/signers/{signer_id}
- post/api/sign/{id}/signers/{signer_id}/remind
- post/api/sign/{id}/prepare-send
- post/api/sign/{id}/confirm-send
- post/api/sign/{id}/consent
- post/api/sign/{id}/sign
- post/api/sign/{id}/void
- post/api/sign/{id}/revert-to-draft
- get/api/sign/{id}/certificate
- get/api/sign/{id}/verify
- get/api/documents/{id}/sign-references
Show More
Automations (Collapsed)
Copy link
Workflow automations: workflows, versions, runs, webhook triggers and n8n import and export.
Automations Operations
- get/api/admin/automations/stats
- post/api/automations/{id}/run
- post/api/automations/{id}/runs
- get/api/automations/{id}/runs
- post/api/automations/{id}/test
- post/api/automations
- get/api/automations
- get/api/automations/node-types
- get/api/automations/node-types/{type}
- post/api/automations/import
- post/api/automations/formatters/set
- post/api/automations/http/request
- get/api/automations/runs/{runId}
- post/api/automations/runs/{runId}/cancel
- post/api/automations/runs/{runId}/retry
- post/api/automations/{id}/enable
- post/api/automations/{id}/disable
- post/api/automations/{id}/approve
- post/api/automations/{id}/duplicate
- post/api/automations/{id}/rotate-key
- get/api/automations/{id}/runs/heatmap
- get/api/automations/{id}/versions
- get/api/automations/{id}/versions/{version}
- post/api/automations/{id}/versions/{version}/restore
- post/api/automations/{id}/invoke
- get/api/automations/{id}/export
- get/api/automations/{id}/permissions
- post/api/automations/{id}/permissions
- delete/api/automations/{id}/permissions/{userId}
- patch/api/automations/{id}/visibility
- get/api/automations/{id}
- patch/api/automations/{id}
- delete/api/automations/{id}
- get/.well-known/automations-ips
Show More
Analytics (Collapsed)
Copy link
Product analytics: projects, events, people, insights, funnels, retention, cohorts, dashboards, metrics and write keys.
Analytics Operations
- post/api/analytics/insights
- get/api/analytics/insights
- patch/api/analytics/insights/{id}
- delete/api/analytics/insights/{id}
- get/api/analytics/insights/{id}
- post/api/analytics/funnels
- get/api/analytics/funnels
- patch/api/analytics/funnels/{id}
- delete/api/analytics/funnels/{id}
- get/api/analytics/funnels/{id}
- post/api/analytics/retentions
- get/api/analytics/retentions
- patch/api/analytics/retentions/{id}
- delete/api/analytics/retentions/{id}
- get/api/analytics/retentions/{id}
- post/api/analytics/cohorts
- get/api/analytics/cohorts
- patch/api/analytics/cohorts/{id}
- delete/api/analytics/cohorts/{id}
- get/api/analytics/cohorts/{id}
- post/api/analytics/dashboards
- get/api/analytics/dashboards
- patch/api/analytics/dashboards/{id}
- delete/api/analytics/dashboards/{id}
- get/api/analytics/dashboards/{id}
- get/api/analytics/debugger
- post/api/analytics/write-keys/{id}/rotate
- delete/api/analytics/write-keys/{id}
- get/api/analytics/catalog-overrides
- put/api/analytics/catalog-overrides/{event}
- post/api/analytics/write-keys
- get/api/analytics/write-keys
- post/api/analytics/query
- get/api/analytics/events
- get/api/analytics/events/{id}
- get/api/analytics/subjects/{id}/export
- get/api/analytics/{type}/{id}/export
- get/api/analytics/users
- get/api/analytics/users/aggregates
- get/api/analytics/users/{userId}
- get/api/analytics/deletion-history
- get/api/analytics/dashboards/{id}/permissions
- post/api/analytics/dashboards/{id}/permissions
- delete/api/analytics/dashboards/{id}/permissions/{userId}
- get/api/analytics/settings
- put/api/analytics/settings
- get/api/analytics/metric
- get/api/analytics/catalog-stats
- post/api/analytics/metrics
- get/api/analytics/metric-definitions
- put/api/analytics/metric-definitions/{metric}
- get/api/analytics/projects
- post/api/analytics/projects
- get/api/analytics/projects/{id}
- patch/api/analytics/projects/{id}
- delete/api/analytics/projects/{id}
- get/api/analytics/projects/{id}/permissions
- post/api/analytics/projects/{id}/permissions
- patch/api/analytics/projects/{id}/permissions/{principalId}
- delete/api/analytics/projects/{id}/permissions/{principalId}
- patch/api/analytics/projects/{id}/visibility
- post/api/analytics/projects/{id}/leave
- post/api/analytics/projects/{id}/access-requests
- get/api/analytics/projects/{id}/access-requests/current
- post/api/analytics/projects/{id}/access-requests/{requestId}/decision
- get/api/analytics/restricted
- put/api/analytics/restricted/{kind}/{key}
- delete/api/analytics/restricted/{kind}/{key}
- get/api/analytics/projects/{id}/annotations
- post/api/analytics/projects/{id}/annotations
- patch/api/analytics/projects/{id}/annotations/{annotationId}
- delete/api/analytics/projects/{id}/annotations/{annotationId}
Show More
Assistant (Collapsed)
Copy link
The built-in AI assistant: conversations, streamed turns and recent activity.
Assistant Operations
- get/api/assistant/capabilities
- get/api/assistant/recent-activity
- post/api/assistant/chat
- post/api/assistant/chat/stream
- get/api/assistant/turns/{id}/replay
- post/api/assistant/turns/{id}/stop
- post/api/assistant/conversations/migrate
- get/api/assistant/conversations
- post/api/assistant/conversations
- get/api/assistant/conversations/{id}
- patch/api/assistant/conversations/{id}
- delete/api/assistant/conversations/{id}
- post/api/assistant/conversations/{id}/share
Show More
Agents (Collapsed)
Copy link
Agents you manage: roster, connections, work, API keys, subscriptions and manager assignment.
Agents Operations
- get/api/agents/{id}/hosting/model-account
- put/api/agents/{id}/hosting/model-account
- get/api/agents/{id}/hosting/sign-in-code
- post/api/agents/{id}/hosting/model-account/connect
- get/api/agents/{id}/hosting/model-account/connect/{connect_id}
- post/api/agents/{id}/hosting/model-account/connect/{connect_id}/code
- get/api/agents
- get/api/agents/connections
- get/api/agents/{id}
- get/api/agents/{id}/work
- get/api/agents/{id}/work/content/{kind}/{resource_id}
- get/api/agents/{id}/subscriptions
- put/api/agents/{id}/subscriptions
- get/api/agents/{id}/transport
- post/api/agents/{id}/api-keys
- get/api/agents/{id}/api-keys
- post/api/agents/{id}/setup-handoff
- post/api/agents/{id}/api-keys/{keyId}/rotate
- delete/api/agents/{id}/api-keys/{keyId}
- patch/api/agents/{id}/manager
- patch/api/agents/{id}/name
- post/api/agents/{id}/avatar
- get/api/agents/{id}/email-access
- patch/api/agents/{id}/email-access
- get/api/agents/{id}/optimizer
- patch/api/agents/{id}/optimizer
- get/api/agents/{id}/optimizer/reviews
Show More
Teams (Collapsed)
Copy link
Teams: membership, roles, join requests, nesting and team email delivery.
Teams Operations
- get/api/teams/mine
- get/api/teams/searchable
- get/api/teams
- post/api/teams
- get/api/teams/{id}/members
- post/api/teams/{team_id}/members
- patch/api/teams/{id}/members/{userId}
- delete/api/teams/{id}/members/{userId}
- get/api/teams/{id}/subscription
- patch/api/teams/{id}/subscription
- post/api/teams/{id}/join
- post/api/teams/{id}/leave
- post/api/teams/{id}/star
- delete/api/teams/{id}/star
- delete/api/teams/{id}/join-request
- get/api/teams/{id}/requests
- post/api/teams/{id}/requests/{requestId}/approve
- post/api/teams/{id}/requests/{requestId}/deny
- get/api/teams/{team_id}
- patch/api/teams/{team_id}
- delete/api/teams/{team_id}
- patch/api/resources/{id}/star
Show More
Admin (Collapsed)
Copy link
Workspace administration: users, roles, API keys, domains, audit log, settings and integrations credentials.
Admin Operations
- post/api/admin/init
- get/api/admin/workspace
- patch/api/admin/workspace
- delete/api/admin/workspace
- post/api/admin/workspace/logo
- delete/api/admin/workspace/logo
- get/api/admin/settings
- patch/api/admin/settings
- get/api/admin/security
- patch/api/admin/security
- get/api/admin/notification-defaults
- patch/api/admin/notification-defaults
- get/api/admin/email-signature
- put/api/admin/email-signature
- get/api/admin/email-deliverability
- get/api/admin/users
- post/api/admin/users
- post/api/admin/users/provision-agent
- post/api/admin/users/invite
- post/api/admin/users/{user_id}/roles
- delete/api/admin/users/{user_id}/roles/{role}
- get/api/admin/users/{id}
- patch/api/admin/users/{id}
- delete/api/admin/users/{id}
- get/api/admin/users/{id}/erasure-outcome
- post/api/admin/users/{id}/reset-password
- post/api/admin/users/{id}/mfa-recovery
- post/api/admin/users/{id}/suspend
- post/api/admin/users/{id}/unsuspend
- get/api/admin/invites
- post/api/admin/invites/{id}/resend
- delete/api/admin/invites/{id}
- post/api/admin/invites/{id}/link
- get/api/admin/roles
- post/api/admin/roles
- patch/api/admin/roles/{id}
- delete/api/admin/roles/{id}
- get/api/admin/audit-log/actions
- get/api/admin/audit-log
- get/api/admin/audit-log/export
- get/api/admin/audit-log/{id}
- get/api/admin/external-collaborators
- delete/api/admin/external-collaborators/{user_id}
- get/api/admin/api-keys
- post/api/admin/api-keys
- post/api/admin/api-keys/{id}/rotate
- patch/api/admin/api-keys/{id}
- delete/api/admin/api-keys/{id}
- get/api/admin/billing
- post/api/admin/billing/upgrade-plan
- post/api/admin/billing/cancel
- get/api/admin/referrals
- get/api/admin/usage
- get/api/admin/usage/timeseries
- get/api/admin/usage/export
- get/api/admin/domains
- post/api/admin/domains/register
- post/api/admin/domains/custom
- post/api/admin/domains/{id}/verify
- post/api/admin/domains/{id}/verify-ownership
- post/api/admin/domains/{id}/register-ses
- post/api/admin/domains/{id}/refresh
- post/api/admin/domains/{id}/set-default
- patch/api/admin/workspace/domains/{id}
- get/api/admin/domains/{id}/deletion-impact
- get/api/admin/domains/{id}
- delete/api/admin/domains/{id}
- post/api/admin/test-notification-email
- get/api/admin/test-notification-email/preview
- get/api/admin/mail-marketing
- put/api/admin/mail-marketing
- get/api/admin/mail-suppressions
- post/api/admin/mail-suppressions
- delete/api/admin/mail-suppressions/{id}
- get/api/admin/integrations
- get/api/admin/integrations/slack/channels
- patch/api/admin/integrations/{id}
- delete/api/admin/integrations/{id}
- get/api/admin/workspace/integrations
- post/api/admin/workspace/integrations
- delete/api/admin/workspace/integrations/{provider}
- post/api/admin/workspace/domains/quick-connect/detect
- post/api/admin/workspace/domains/quick-connect/launch
- get/api/admin/workspace/registrar
- post/api/admin/workspace/registrar
- post/api/admin/workspace/registrar/auto-configure
- delete/api/admin/workspace/registrar/{provider}
- post/api/admin/workspace/invite
- get/api/module-availability
Show More
Billing (Collapsed)
Copy link
Plans, subscriptions, checkout, quotas, AI action usage and top-ups.
Billing Operations
- post/api/public/billing/webhook
- post/api/billing/trial
- post/api/billing/checkout
- post/api/billing/portal
- post/api/billing/cancel
- get/api/billing/subscription
- get/api/billing/plans
- get/api/billing/seats
- post/api/billing/seats/sync
- get/api/billing/usage
- get/api/billing/ai-usage
- get/api/billing/features
- get/api/billing/invoices
- get/api/billing/discount
- delete/api/billing/discount
- post/api/billing/promotion-code
- get/api/billing/quota
- get/api/billing/bonuses
- post/api/billing/topup
- get/api/billing/auto-recharge
- patch/api/billing/auto-recharge
- get/api/billing/per-seat-cap
- patch/api/billing/per-seat-cap
- delete/api/billing/per-seat-cap
- post/api/billing/notifications/dismiss
- get/api/billing/ledger
Show More
Identity (Collapsed)
Copy link
Your profile and the workspace member directory.
Identity Operations
- get/api/users
- get/api/users/me
- patch/api/users/me
- delete/api/users/me
- put/api/users/me/send-as
- post/api/users/me/avatar
- delete/api/users/me/avatar
- post/api/users/me/push-token
- post/api/users/me/mail-client-setup
- get/api/users/me/emails
- post/api/users/me/emails
- post/api/users/me/emails/{id}/resend
- delete/api/users/me/emails/{id}
- get/api/users/notification-preferences
- patch/api/users/notification-preferences
- get/api/users/{id}/avatar
- get/api/slack-memberships
- post/api/slack-memberships/{id}/accept
- get/api/shared-with-me
- delete/api/shared-with-me/{resource_type}/{id}
- post/api/shared-with-me/undo-leave
- post/api/identity/onboarding-agent
- post/api/identity/onboarding-agent/decline
- post/api/identity/onboarding-agent/acknowledge
- post/api/identity/onboarding-step
- get/api/identity/api-keys
- post/api/identity/api-keys
- post/api/identity/api-keys/{id}/rotate
- patch/api/identity/api-keys/{id}
- delete/api/identity/api-keys/{id}
- post/api/identity/api-keys/{id}/setup-message-copied
Show More
Users (Collapsed)
Copy link
Your own account security: two-step verification, passkeys, app passwords and sessions.
Users Operations
- get/api/users/me/mfa
- post/api/users/me/mfa/setup
- post/api/users/me/mfa/setup/confirm
- post/api/users/me/mfa/remove
- post/api/users/me/mfa/recovery-codes
- post/api/users/me/mfa/step-up
- post/api/users/me/mfa/sms/setup
- post/api/users/me/mfa/sms/send
- post/api/users/me/mfa/sms/confirm
- post/api/users/me/mfa/sms/remove
- post/api/users/me/mfa/passkey/options
- post/api/users/me/mfa/passkeys/setup
- post/api/users/me/mfa/passkeys/confirm
- post/api/users/me/mfa/passkeys/{id}/remove
- post/api/users/me/mfa/recovery/cancel
- get/api/users/me/sessions
- delete/api/users/me/sessions/{id}
- post/api/auth/logout-all
- get/api/users/me/app-passwords
- post/api/users/me/app-passwords
- delete/api/users/me/app-passwords/{id}
Show More
Account (Collapsed)
Copy link
Account-wide settings: email preferences, referrals, mail-client setup and data export.
Account Operations
- get/api/account/email-preferences
- patch/api/account/email-preferences
- get/api/account/referrals
- get/api/account/data-export
- get/api/account/mail-client-profile
- get/api/account/mail-client-settings
- post/api/account/rotate-referral-slug
- post/api/email-preferences/read
- patch/api/email-preferences
Show More
Workspaces (Collapsed)
Copy link
Workspaces you belong to: details, creation, slug checks and switching.
Workspaces Operations
- get/api/workspace
- patch/api/workspace
- get/api/workspaces/check-slug
- get/api/workspaces
- post/api/workspaces
- post/api/workspaces/{workspace_id}/restore
- post/api/workspaces/{workspace_id}/switch
Show More
Invite (Collapsed)
Copy link
Workspace and resource invitations: pending invites, acceptance and decline.
Invite Operations
- get/api/invite/pending
- post/api/invite/pending/{id}/accept
- post/api/invite/pending/{id}/decline
- post/api/invite/context
- get/api/invite/context
- post/api/invite/context/accept
- post/api/invite/context/decline
- get/api/invite/{token}
- post/api/invite/{token}/accept
- post/api/invite/{token}/decline
Show More
Auth (Collapsed)
Copy link
Sign-in and sign-up: passwords, Google and Apple, verification, password reset, CLI login and agent signup and pairing.
Auth Operations
- post/api/auth/signup-agent
- post/api/public/agent-pairings
- get/api/public/agent-pairings/status
- post/api/public/agent-pairings/handoff
- get/api/public/agent-claim/handoff/{handoff}
- get/api/public/agent-claim/context
- post/api/public/agent-claim/resend
- post/api/auth/agent-claim/current
- post/api/auth/agent-claim/google
- post/api/auth/agent-claim/complete
- get/api/public/claim/{token}
- post/api/auth/claim-workspace
- post/api/auth/apple
- post/api/auth/register
- get/api/public/auth/registration-config
- post/api/auth/merge-workspace
- get/api/auth/internal-factor
- post/api/auth/mfa/verify
- post/api/auth/mfa/sms/send
- post/api/auth/mfa/enroll/start
- post/api/auth/mfa/enroll/confirm
- post/api/auth/mfa/passkey/options
- post/api/auth/mfa/enroll/passkey/options
- post/api/auth/mfa/enroll/passkey/confirm
- post/api/auth/mfa/recovery/request
- post/api/auth/mfa/recovery/proof
- post/api/auth/mfa/recovery/cancel
- post/api/auth/mfa/recovery/complete
- post/api/auth/passkey/options
- post/api/auth/passkey/verify
- post/api/auth/google
- post/api/auth/google/start
- post/api/auth/login
- post/api/auth/session/renew
- post/api/auth/session/bootstrap
- post/api/auth/select-workspace
- post/api/public/claim/context
- post/api/auth/claim-matches
- post/api/auth/verify-email
- post/api/auth/resend-verification
- post/api/auth/resend-workspace-claim
- post/api/auth/send-phone-verification
- post/api/auth/verify-phone
- post/api/auth/forgot-password
- post/api/auth/find-workspaces
- post/api/auth/reset-password
- post/api/auth/change-password
- post/api/auth/reconsent
- post/api/auth/verify-external-email
- post/api/auth/native/code
- post/api/auth/native/exchange
- post/api/auth/key-handoff
- post/api/auth/key-handoff/exchange
- post/api/auth/key-handoff/failure
- get/api/auth/cli
- post/api/auth/cli
- post/api/auth/cli/exchange
- post/api/auth/picker-workspaces
- post/api/auth/google/callback
- get/api/auth/google/callback
- post/api/auth/logout
Show More
OAuth (Collapsed)
Copy link
The OAuth 2.1 authorization server, OpenID Connect sign-in and MCP discovery metadata.
OAuth Operations
- get/.well-known/oauth-protected-resource
- get/.well-known/oauth-protected-resource/mcp
- get/.well-known/oauth-protected-resource/mcp/agents/{agentId}
- get/.well-known/oauth-protected-resource/mcp/anthropic
- get/.well-known/oauth-authorization-server
- get/.well-known/openid-configuration
- get/oauth/jwks
- post/oauth/register
- get/oauth/authorize
- get/api/oauth/client/{client_id}
- get/api/oauth/sign-in-preview
- get/api/oauth/agents
- put/api/oauth/pending-agent
- get/api/oauth/agents/{id}
- post/api/oauth/grant
- post/oauth/token
- post/oauth/revoke
- get/oauth/userinfo
- post/oauth/userinfo
- post/oauth/agent/registrations
- post/oauth/agent/claims
- post/oauth/agent/identity
- post/oauth/agent/claim
- post/api/oauth/agent/claim/context
- post/api/oauth/agent/claim/confirm
- get/api/oauth/agent/connections
- post/api/oauth/agent/connections/{id}/revoke
Show More
Resource Actions (Collapsed)
Copy link
Canonical state setters shared across modules: archive, mute, star, assignee and similar flags on any resource.
Resource Actions Operations
- patch/api/resource-actions/mail/emails/{id}/archived
- patch/api/resource-actions/mail/threads/{id}/muted
- patch/api/resource-actions/mail/threads/{id}/assignee
- patch/api/resource-actions/chat/channels/{id}/archived
- patch/api/resource-actions/chat/channels/{id}/muted
- patch/api/resource-actions/tasks/{id}/archived
- patch/api/resource-actions/tasks/{id}/subscription
- patch/api/resources/{id}/star
- get/api/resources/{id}/comments
- post/api/resources/{id}/comments
- patch/api/comments/{id}
- delete/api/comments/{id}
- patch/api/reactions/{id}
- patch/api/comments/{id}/read
- post/api/resources/{id}/comments/read
- get/api/resources/{id}/access
- post/api/resources/{id}/access
- patch/api/resources/{id}/access
- delete/api/resources/{id}/access
- patch/api/resources/{id}/visibility
- post/api/resources/{id}/transfer-ownership
- post/api/resources/{id}/leave
- post/api/resources/{id}/access-requests
- get/api/resources/{id}/access-requests/current
- post/api/access-requests/{id}/decision
Show More
Assets (Collapsed)
Copy link
Files owned by a document, task, wiki page or other resource, and the content route that serves them.
Assets Operations
- post/api/documents/{id}/assets
- post/api/tasks/{id}/assets
- post/api/wiki/pages/{id}/assets
- get/api/files/{id}/content
- get/api/assets/{id}/content
- get/api/public/assets/{id}/embed
Show More
Search (Collapsed)
Copy link
Cross-module search and entity previews.
Search Operations
- get/api/search
- post/api/search
- get/api/search/preview/{module}/{id}
Show More
Notifications (Collapsed)
Copy link
Your notification feed: read state, snooze, dismiss and mutes.
Notifications Operations
- get/api/notifications
- get/api/notifications/mutes
- post/api/notifications/mute
- delete/api/notifications/mutes/{id}
- post/api/notifications/mark-all-read
- post/api/notifications/{id}/mark-read
- post/api/notifications/{id}/mark-unread
- post/api/notifications/{id}/dismiss
- post/api/notifications/{id}/undismiss
- post/api/notifications/{id}/snooze
- get/api/users/{id}/notifications
- put/api/users/{id}/notifications
Show More
Unread (Collapsed)
Copy link
Unread counts across modules.
Unread Operations
- get/api/unread-counts
Show More
Activity (Collapsed)
Copy link
The workspace activity feed.
Activity Operations
- get/api/activity
Show More
Home (Collapsed)
Copy link
The Home digest.
Home Operations
- get/api/home/digest
Show More
Widget (Collapsed)
Copy link
The summary shown in home-screen widgets.
Widget Operations
- get/api/widget/summary
Show More
Presence (Collapsed)
Copy link
Presence: activity beacons and resolved presence for people and agents.
Presence Operations
- post/api/presence/heartbeat
- post/api/presence/activity
- get/api/presence
- get/api/presence/detailed
- get/api/presence/resolved
Show More
Realtime (Collapsed)
Copy link
Capabilities and bootstrap for realtime connections.
Realtime Operations
- post/api/realtime/capabilities/connection
- post/api/realtime/capabilities/resource
- post/api/public/realtime/bootstrap
- post/api/edge/realtime/static-resource
- get/api/edge/realtime/jwks
- post/api/edge/realtime/hydrate
- post/api/edge/realtime/mirror
- post/api/edge/realtime/command
- post/api/edge/realtime/checkpoint
- post/api/edge/realtime/catchup
Show More
Push (Collapsed)
Copy link
Browser and device push subscriptions.
Push Operations
- post/api/push/subscribe
- delete/api/push/subscribe
- get/api/push/vapid-key
Show More
Webhooks (Collapsed)
Copy link
Outbound webhooks: registrations, event types, deliveries and test pings.
Webhooks Operations
- get/api/webhooks/event-types
- get/api/webhooks
- post/api/webhooks
- get/api/webhooks/{id}
- patch/api/webhooks/{id}
- delete/api/webhooks/{id}
- post/api/webhooks/{id}/rotate-secret
- post/api/webhooks/{id}/revoke-previous-secret
- get/api/webhooks/{id}/deliveries
- post/api/webhooks/{id}/test
Show More
Integrations (Collapsed)
Copy link
Third-party integrations such as GitHub and Slack: installation and callbacks.
Integrations Operations
- get/api/integrations/github/install
- post/api/integrations/github/install
- post/api/integrations/github/install-handoff
- get/api/integrations/github/callback
- get/api/integrations/slack/install
- post/api/integrations/slack/install
- post/api/integrations/slack/install-handoff
- get/api/integrations/slack/callback
- get/api/zoom/status
- get/api/zoom/auth-url
- delete/api/zoom/connection
- post/api/zoom/meetings
- get/api/zoom/callback
Show More
Monid (Collapsed)
Copy link
Workspace connections held by the Monid tool-routing platform.
Monid Operations
- post/api/monid/connections/create
- post/api/monid/connections/connect
- get/api/monid/connections/{connectionId}
- delete/api/monid/connections/{connectionId}
- post/api/monid/connections/{connectionId}/operations/{operationId}
Show More
Images (Collapsed)
Copy link
Image generation and business-card scanning.
Images Operations
- post/api/images/generate
- post/api/images/scan-business-card
Show More
Audio (Collapsed)
Copy link
Transcription and Ambiguous Live voice access.
Audio Operations
- post/api/audio/transcribe
- get/api/live/access
- post/api/live/interpret
- post/api/live/text-tokens
Show More
Llm (Collapsed)
Copy link
One-shot model calls.
Llm Operations
- post/api/llm
Show More
Feedback (Collapsed)
Copy link
Product feedback to Ambiguous: submit and read back your own submissions.
Feedback Operations
- post/api/feedback
- get/api/feedback
- post/api/feedback/agent-capability-gap
- post/api/feedback/agent-outcome
- get/api/feedback/{id}
Show More
Changelog (Collapsed)
Copy link
API changelog entries.
Changelog Operations
- get/api/changelog
Show More
Groups (Collapsed)
Copy link
Team email unsubscribe links.
Groups Operations
- get/api/teams/unsubscribe
- post/api/teams/unsubscribe
Show More
GDPR (Collapsed)
Copy link
Data-subject export downloads.
GDPR Operations
- get/api/gdpr/export/{id}
Show More
Health (Collapsed)
Copy link
Service health.
Health Operations
- get/api/health
Show More
Public (Collapsed)
Copy link
Routes that need no credential: link-shared documents, public forms, booking pages and similar.
Public Operations
- get/api/drip/pictures/{picture}.png
- get/api/public/mail/unsubscribe/{token}
- post/api/public/mail/unsubscribe/{token}
- post/api/public/documents/{id}/verify-password
- get/api/public/documents/{id}
- get/api/public/documents/{id}/comments
- get/api/public/documents/{id}/assets/{assetId}
- post/api/public/wiki/pages/{id}/verify-password
- get/api/public/wiki/pages/{id}
- get/api/public/wiki/pages/{id}/comments
- get/api/public/wiki/pages/{id}/assets/{assetId}
- post/api/public/wiki/{id}/verify-password
- get/api/public/wiki/{id}
- post/api/public/drive/{id}/verify-password
- get/api/public/drive/{id}/content
- get/api/public/drive/{id}/children
- get/api/public/drive/{id}
- post/api/public/canvas/{id}/elements/{elId}/embed-url
- get/api/public/slides/{id}
- get/api/public/sheets/{id}/range
- get/api/public/assistant/conversations/{id}
- post/api/public/assistant/conversations/{id}
- get/api/public/crm/quote
- post/api/public/crm/quote
- post/api/public/crm/quote/accept
- get/api/public/calendar/guest
- post/api/public/calendar/guest
- post/api/public/calendar/guest/respond
- get/api/public/calendar/guest/slots
- post/api/public/calendar/guest/slots
- post/api/public/calendar/guest/reschedule
- post/api/public/calendar/guest/cancel
- get/api/public/scheduler/bookings/{cancelToken}
- post/api/public/scheduler/bookings/{cancelToken}/cancel
- get/api/public/scheduler/{workspaceSlug}/{userSlug}/{linkSlug}
- get/api/public/scheduler/{workspaceSlug}/{userSlug}/{linkSlug}/slots
- post/api/public/scheduler/{workspaceSlug}/{userSlug}/{linkSlug}/book
- get/api/public/sequences/track/{tokenWithExt}
- get/api/public/workspace/{workspaceId}/logo
- delete/api/public/synthetic/runs/{runId}
- get/api/public/synthetic/runs/{runId}/events
Show More
Internal (Collapsed)
Copy link
Ambiguous staff operations. Not available to customers.
Internal Operations
- get/api/internal/ad-clicks/counts
- get/api/internal/virality/cohort/{month}
- put/api/internal/agents/{agent_id}/hosted
- get/api/internal/bi/workspace-labels
- patch/api/internal/bi/workspaces/{workspaceId}/classification
- get/api/internal/bi/account-labels
- patch/api/internal/bi/accounts/{accountId}/classification
- get/api/internal/domains
- post/api/internal/domains/{id}/retry
- delete/api/internal/domains/{id}
- put/api/internal/workspaces/{id}/mail-bulk-review
- get/api/internal/assessments/grid
- get/api/internal/assessments/results/{id}
- get/api/internal/assessments/results/{id}/siblings
- patch/api/internal/assessments/cases/{id}
- get/api/internal/assessments/tool-runs
- get/api/internal/assessments/tool-runs/{id}
- get/api/internal/assessments/tool-cases
Show More
Dev (Collapsed)
Copy link
Test provisioning routes available only outside production.
Dev Operations
- post/api/dev/test-provision/integration
- post/api/dev/test-provision/verify-domain
- post/api/dev/test-provision/emit-plan-changed
Show More
/api/documents/{id}/paragraph-mark
Copy link
Auth Required
Path Parameters
- idCopy link to id
Type: string · DocumentIdFormat: uuid
required
Headers
- X-Ambiguous-Request-ContextCopy link to X-Ambiguous-Request-Context
Type: string
Optional. Explain how this request supports the user's goal: 20–30 words, third person, without we/I/you. Exclude credentials, secrets and personal information.
- X-Ambiguous-Reference-Resource-IdCopy link to X-Ambiguous-Reference-Resource-Id
Type: string
Optional ID of an accessible Ambiguous resource where this work was requested (email, chat, comment, task, document or file).
- API-VersionCopy link to API-Version
enum
const: 1
Default
1
REST API major version 1 is selected with the optional API-Version: 1 request header (the default). Responses echo API-Version. Unsupported versions return 400. Additive fields and endpoints may be introduced within a major version; incompatible changes require a new major version. Deprecated operations are marked deprecated in OpenAPI; a scheduled removal must advertise Deprecation and Sunset headers before removal.
values
- 1
Body
required
application/json
- command_idCopy link to command_id
Type: string Format: uuid
required
- expected_content_hashCopy link to expected_content_hash
Type: string
required
Pattern
^[a-f0-9]{64}$
- patchCopy link to patch
Type: object
required
Show Child Attributesfor patch
- suggestingCopy link to suggesting
Type: boolean
required
- targetsCopy link to targets
Type: array object[] 1…512
required
Show Child Attributesfor targets
Responses
- 200
OK
application/json
- 400
Invalid input
application/json
- 403
Forbidden
application/json
- 404
Not found
application/json
- 409
Conflict
application/json
- 429
Too many requests. Retry after the number of seconds in Retry-After; RateLimit and RateLimit-Policy describe the budget. Reachable on any operation: an API key carrying a rate limit is metered per key on every authenticated call, and the public operations carry their own per-IP limiter.
application/json
Request Example for post/api/documents/ {id}/paragraph-mark
Shell Curl
curl https://app.ambiguous.ai/api/documents/123e4567-e89b-12d3-a456-426614174000/paragraph-mark \
--request POST \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
--data '{
"command_id": "",
"expected_content_hash": "",
"targets": [\
{\
"block_id": "",\
"before": null,\
"before_present": true\
}\
],
"patch": {
"set": {},
"remove": [\
""\
],
"fontFamilies": {
"ascii": null,
"hAnsi": null,
"eastAsia": null,
"cs": null
},
"fontThemes": {
"ascii": null,
"hAnsi": null,
"eastAsia": null,
"cs": null
},
"clear": true,
"replace": true
},
"suggesting": true
}'
cURLCopy
cURLCopy
Test Request(post /api/documents/{id}/paragraph-mark)
Status: 200Status: 400Status: 403Status: 404Status: 409Status: 429
Show Schema
{
"changed": true,
"replayed": true,
"command_id": "string",
"entities": {
"additionalProperty": {
"resolution": "ok",
"entity": null
}
},
"entities_truncated": true
}
JSONCopy
JSONCopy
OK
Purge soft-deleted chat messages older than TTL
Copy link
Auth Required
Headers
- API-VersionCopy link to API-Version
enum
const: 1
Default
1
values
- 1
Body
required
application/json
- ttl_daysCopy link to ttl_days
Type: integer min: 1 max: 365
Default
30
Integer numbers.
Responses
- 200
Purge completed
application/json
- 429
application/json
Request Example for post/api/admin/chat/purge-deleted-messages
Shell Curl
curl https://app.ambiguous.ai/api/admin/chat/purge-deleted-messages \
--request POST \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
--data '{
"ttl_days": 30
}'
cURLCopy
cURLCopy
Test Request(post /api/admin/chat/purge-deleted-messages)
Status: 200Status: 429
Show Schema
{
"purged_count": 1,
"ttl_days": 1
}
JSONCopy
JSONCopy
Purge completed
Models
Show More
Show sidebar
GET
Server: https://app.ambiguous.ai
/api/health
Copy URL
Send Send get request to https://app.ambiguous.ai/api/health
GET
Copy URLSend Send get request to https://app.ambiguous.ai/api/health
Open API Client Close Client
Read deployment health and resolved application URL
AllAuthCookiesHeadersQuery
All
Authentication (Collapsed)
Select Auth Type
Variables
| Enabled | Key | Value |
|---|
Cookies
| Enabled | Key | Value |
|---|---|---|
Headers
Clear All Headers
| Enabled | Key | Value |
|---|---|---|
| accept | application/json | |
| API-Version | 1 | |
Query Parameters
| Enabled | Key | Value |
|---|---|---|
Request Body
No Body
| None |
|---|
Code Snippet (Collapsed)
Shell Curl
Response
AllCookiesHeadersBody
All
.,,uod8B8bou,,. ..,uod8BBBBBBBBBBBBBBBBRPFT?l!i:. ||||||||||||||!?TFPRBBBBBBBBBBBBBBB8m=, |||| '""^^!!||||||||||TFPRBBBVT!:...! |||| '""^^!!|||||?!:.......! |||| ||||.........! |||| ||||.........! |||| ||||.........! |||| ||||.........! |||| ||||.........! |||| ||||.........! ||||, ||||.........` |||||!!-._ ||||.......;. ':!|||||||||!!-._ ||||.....bBBBBWdou,. bBBBBB86foi!|||||||!!-..:|||!..bBBBBBBBBBBBBBBY! ::!?TFPRBBBBBB86foi!||||||||!!bBBBBBBBBBBBBBBY..! :::::::::!?TFPRBBBBBB86ftiaabBBBBBBBBBBBBBBY....! :::;`"^!:;::::::!?TFPRBBBBBBBBBBBBBBBBBBBY......! ;::::::...''^::::::::::!?TFPRBBBBBBBBBBY........! .ob86foi;::::::::::::::::::::::::!?TFPRBY..........` .b888888888886foi;:::::::::::::::::::::::..........` .b888888888888888888886foi;::::::::::::::::...........b888888888888888888888888888886foi;:::::::::......`!Tf998888888888888888888888888888888886foi;:::....` '"^!|Tf9988888888888888888888888888888888!::..` '"^!|Tf998888888888888888888888889!! '` '"^!|Tf9988888888888888888!!` iBBbo. '"^!|Tf998888888889!` WBBBBbo. '"^!|Tf9989!` YBBBP^' '"^!` `
Send Request
ctrlControl
↵Enter