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

Show More

Sheets (Collapsed)

​Copy link

Spreadsheets: cells, ranges, tabs, formulas, charts, pivots, validation, protection and data connectors.

Sheets Operations

Show More

Slides (Collapsed)

​Copy link

Presentations: slides, elements, masters, layouts, themes, templates and deck settings.

Slides Operations

Show More

Canvas (Collapsed)

​Copy link

Whiteboards: boards, elements, connectors, frames, comments and board previews.

Canvas Operations

Show More

Chat (Collapsed)

​Copy link

Messaging: channels, direct messages, threads, reactions, pins, drafts, scheduled messages and polls.

Chat Operations

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

Show More

Drive (Collapsed)

​Copy link

File storage: uploads, folders, sharing, shared drives, versions, tags, trash and file requests.

Drive Operations

Show More

Tasks (Collapsed)

​Copy link

Task management: tasks, subtasks, statuses, assignment, labels, views, relations, time tracking and templates.

Tasks Operations

Show More

Projects (Collapsed)

​Copy link

Task projects: members, visibility, templates, updates and notification preferences.

Projects Operations

Show More

Cycles (Collapsed)

​Copy link

Time-boxed cycles that group tasks, with analytics and velocity.

Cycles Operations

Show More

Code (Collapsed)

​Copy link

Pull-request review backed by GitHub: repositories, grants, pull requests, reviews and merges.

Code Operations

Show More

CRM (Collapsed)

​Copy link

Contacts, companies, deals, pipelines, activities, quotes, products, sequences, lead scoring and scheduling links.

CRM Operations

Show More

Forms (Collapsed)

​Copy link

Forms and surveys: fields, publishing, responses, variants and analytics.

Forms Operations

Show More

Calendar (Collapsed)

​Copy link

Calendars and events: recurrence, attendees, RSVPs, free/busy, reminders, resources, sharing and external sync.

Calendar Operations

Show More

Wiki (Collapsed)

​Copy link

Knowledge base: spaces, pages, inline databases, backlinks, synced blocks and page versions.

Wiki Operations

Show More

Sign (Collapsed)

​Copy link

E-signature: documents, signers, fields, sending, sealed copies, certificates and templates.

Sign Operations

Show More

Automations (Collapsed)

​Copy link

Workflow automations: workflows, versions, runs, webhook triggers and n8n import and export.

Automations Operations

Show More

Analytics (Collapsed)

​Copy link

Product analytics: projects, events, people, insights, funnels, retention, cohorts, dashboards, metrics and write keys.

Analytics Operations

Show More

Assistant (Collapsed)

​Copy link

The built-in AI assistant: conversations, streamed turns and recent activity.

Assistant Operations

Show More

Agents (Collapsed)

​Copy link

Agents you manage: roster, connections, work, API keys, subscriptions and manager assignment.

Agents Operations

Show More

Teams (Collapsed)

​Copy link

Teams: membership, roles, join requests, nesting and team email delivery.

Teams Operations

Show More

Admin (Collapsed)

​Copy link

Workspace administration: users, roles, API keys, domains, audit log, settings and integrations credentials.

Admin Operations

Show More

Billing (Collapsed)

​Copy link

Plans, subscriptions, checkout, quotas, AI action usage and top-ups.

Billing Operations

Show More

Identity (Collapsed)

​Copy link

Your profile and the workspace member directory.

Identity Operations

Show More

Users (Collapsed)

​Copy link

Your own account security: two-step verification, passkeys, app passwords and sessions.

Users Operations

Show More

Account (Collapsed)

​Copy link

Account-wide settings: email preferences, referrals, mail-client setup and data export.

Account Operations

Show More

Workspaces (Collapsed)

​Copy link

Workspaces you belong to: details, creation, slug checks and switching.

Workspaces Operations

Show More

Invite (Collapsed)

​Copy link

Workspace and resource invitations: pending invites, acceptance and decline.

Invite Operations

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

Show More

OAuth (Collapsed)

​Copy link

The OAuth 2.1 authorization server, OpenID Connect sign-in and MCP discovery metadata.

OAuth Operations

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

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

Show More

Search (Collapsed)

​Copy link

Cross-module search and entity previews.

Search Operations

Show More

Notifications (Collapsed)

​Copy link

Your notification feed: read state, snooze, dismiss and mutes.

Notifications Operations

Show More

Unread (Collapsed)

​Copy link

Unread counts across modules.

Unread Operations

Show More

Activity (Collapsed)

​Copy link

The workspace activity feed.

Activity Operations

Show More

Home (Collapsed)

​Copy link

The Home digest.

Home Operations

Show More

Widget (Collapsed)

​Copy link

The summary shown in home-screen widgets.

Widget Operations

Show More

Presence (Collapsed)

​Copy link

Presence: activity beacons and resolved presence for people and agents.

Presence Operations

Show More

Realtime (Collapsed)

​Copy link

Capabilities and bootstrap for realtime connections.

Realtime Operations

Show More

Push (Collapsed)

​Copy link

Browser and device push subscriptions.

Push Operations

Show More

Webhooks (Collapsed)

​Copy link

Outbound webhooks: registrations, event types, deliveries and test pings.

Webhooks Operations

Show More

Integrations (Collapsed)

​Copy link

Third-party integrations such as GitHub and Slack: installation and callbacks.

Integrations Operations

Show More

Monid (Collapsed)

​Copy link

Workspace connections held by the Monid tool-routing platform.

Monid Operations

Show More

Images (Collapsed)

​Copy link

Image generation and business-card scanning.

Images Operations

Show More

Audio (Collapsed)

​Copy link

Transcription and Ambiguous Live voice access.

Audio Operations

Show More

Llm (Collapsed)

​Copy link

One-shot model calls.

Llm Operations

Show More

Feedback (Collapsed)

​Copy link

Product feedback to Ambiguous: submit and read back your own submissions.

Feedback Operations

Show More

Changelog (Collapsed)

​Copy link

API changelog entries.

Changelog Operations

Show More

Groups (Collapsed)

​Copy link

Team email unsubscribe links.

Groups Operations

Show More

GDPR (Collapsed)

​Copy link

Data-subject export downloads.

GDPR Operations

Show More

Health (Collapsed)

​Copy link

Service health.

Health Operations

Show More

Public (Collapsed)

​Copy link

Routes that need no credential: link-shared documents, public forms, booking pages and similar.

Public Operations

Show More

Internal (Collapsed)

​Copy link

Ambiguous staff operations. Not available to customers.

Internal Operations

Show More

Dev (Collapsed)

​Copy link

Test provisioning routes available only outside production.

Dev Operations

Show More

/api/documents/{id}/paragraph-mark

​Copy link

Auth Required

Path Parameters

Type: string · DocumentIdFormat: uuid

required

Headers

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.

Type: string

Optional ID of an accessible Ambiguous resource where this work was requested (email, chat, comment, task, document or file).

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

Body

required

application/json

Type: string Format: uuid

required

Type: string

required

Pattern

^[a-f0-9]{64}$

Type: object

required

Show Child Attributesfor patch

Type: boolean

required

Type: array object[] 1…512

required

Show Child Attributesfor targets

Responses

OK

application/json

Invalid input

application/json

Forbidden

application/json

Not found

application/json

Conflict

application/json

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

enum

const: 1

Default

1

values

Body

required

application/json

Type: integer min: 1 max: 365

Default

30

Integer numbers.

Responses

Purge completed

application/json

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

Powered By Scalar.com

.,,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