Read and update documents, connect discussions, and keep your integration in step with the people doing the work.
Install Dee from the installation guide, then approve access in your browser. The default installation places the CLI at ~/.dee/bin/dee; these examples use that path directly. The CLI detects supported local agents, links the Dee skill, configures optional MCP tools, and keeps its own credential private in ~/.dee. Skill + CLI works without MCP. The connection works under your Dee account’s current permissions.
The examples below use https://dee.cool. The CLI remembers the selected service address. Check your connection before continuing; revoke it when it is no longer needed.
~/.dee/bin/dee agent connect
~/.dee/bin/dee agent status~/.dee/bin/dee agent logoutThe CLI can call declared HTTP operations by operation ID. This example sends a complete personal document through stdin and returns its actual document and revision IDs. The CLI creates and records the operation ID before sending the request.
Use the returned document_id in the read command. Your title and Markdown are separate fields; an H1 in the content does not replace the title. A document keeps the same URL when its content changes.
Discover operation names and inspect the shipped field definitions without making a network request. JSON output preserves the API response shape. The CLI’s generic write command handles supported business operations; browser sign-in exchange and browser logout use their dedicated protocols.
~/.dee/bin/dee api call create_document --input - --json <<'JSON'
{
"origin": { "kind": "personal" },
"title": "Integration notes",
"markdown": "# Integration notes\n\nA shared starting point."
}
JSON~/.dee/bin/dee api read get_document --path id=DOCUMENT_ID --json~/.dee/bin/dee api list --json
~/.dee/bin/dee api schemas --json
~/.dee/bin/dee api schema SaveDocumentRequest --references --jsonExternal HTTP clients use Authorization: Bearer with an opaque Dee credential obtained through browser approval. This is distinct from the identity provider’s token. The same Dee Bearer can access ordinary restricted business endpoints and the document MCP, subject to current account, role, and lifecycle checks.
A custom client generates two independent secrets: a device secret and the future Dee credential, each 32 random bytes encoded as unpadded base64url. It sends the device secret and SHA-256 credential digest to /agent/login/start, opens the returned verification URL for the person, and polls using the original device secret. Approval activates the credential that the client already retained; polling never returns its plaintext. These fields are documented in the runtime protocol reference below.
The approval request lasts ten minutes. An ordinary human-account connection lasts no longer than the approving browser session or thirty days. An independent Agent Service connection uses its own Agent identity and persists until revoked; see the Agent Service guide. Automatic renewal and generic remote-MCP OAuth discovery are not currently provided. A denied, expired, or invalid request needs a new approval request.
Send only the Dee Bearer, without a Cookie header. Origin may be omitted; if supplied, it must equal the application origin. An optional X-Dee-Expected-Account-Id pins the original account and returns 409 AccountChanged if it differs.
The application uses its HttpOnly Dee Cookie. Cookie mutations require the exact application Origin. Agent connection listing and revocation require the browser Cookie and reject Authorization headers. Google sign-in uses a one-time, browser-bound authorization-code callback; account resolution and browser logout keep their dedicated Cookie and Origin protocols.
The example below is for a custom client that has completed the browser-approved flow and retained its own credential in DEE_TOKEN. CLI users can use dee api read and dee api call without extracting any private CLI state.
DEE_ORIGIN='https://api.dee.cool'
# DEE_TOKEN is retained privately by your approved custom client.
curl --fail-with-body "$DEE_ORIGIN/api/session" \
-H "Authorization: Bearer $DEE_TOKEN"JSON business requests use snake_case fields and Content-Type: application/json. Success returns the declared object directly, without a universal success or data wrapper. IDs encode an unsigned 128-bit value using the exact Base62 alphabet ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789, left-padded with A to 22 characters. Arbitrary 22-character strings can overflow. Reuse returned IDs; for a new operation encode 16 random bytes with that alphabet.
A direct HTTP document save submits the complete title and Markdown with expected_revision_id from the version you read. Space, access, and attention writes use their own expected_revision; message maintenance uses expected_version; Trash and restoration use the complete reviewed management token. These conditions are distinct and are checked before a new change is committed.
When the response is lost, retain the original operation_id, target, conditions, complete input, and original upload bytes. Query the matching operation receipt or resend the identical request. A different valid intent under the same ID returns OperationConflict. A missing receipt does not prove an in-flight request never committed; an old receipt does not prove current content or access.
A 409 conflict requires reading the relevant current facts and deciding how to continue. A changed or merged intent uses a new operation ID. The CLI records direct document operation metadata and receipts without a local body copy; retrying a direct write requires the original input. Full local recovery is an explicit CLI option.
GET /api/documents/operations/{operation_id} checks original creation and save results. Lifecycle results use /api/documents/lifecycle/operations/{operation_id}.
Spaces, access, communication, attention, and resource uploads each expose their own operation lookup. Their exact paths and response fields appear in the generated reference.
Read requires current document access; new content writes require editor or administrator permission. Some management operations require an administrator. Reading an original minimal receipt does not grant access to current or historical content.
~/.dee/bin/dee operation list --json
~/.dee/bin/dee operation inspect OPERATION_ID --owner documents --jsonCollections use page_index, page_size, and order_by. The index starts at zero and defaults to 0; size defaults to 50 and accepts 0 through 100. A zero size returns empty items and total_pages=0 while retaining the true total_items. Responses contain items, page_index, page_size, total_pages, and total_items, with authorization applied before counting.
Encode ordering as one comma-separated query value, such as title.asc,id.asc. Each endpoint declares its supported columns and default order. Invalid columns, duplicate fields, or invalid directions are rejected; the service adds an ID tie-breaker when needed. The current page_index upper bound is 9007199254740991 and the computed offset must also fit the server’s range.
Message pagination can return read_boundary_message_id. Reuse that boundary with the same document, main-discussion or thread scope, ordering, and page size to keep later pages within the original message collection. The boundary is not the last item on the page and does not mark messages as read.
Change feeds use a separate opaque cursor. A request without a cursor returns a bootstrap fence; read current facts and then poll from that fence. Preserve complete batch cursors after consuming the batch. Change positions, revisions, and versions are decimal strings and must remain lossless. ChangeCursorInvalid returns resync_required, reset_cursor, and current_urls for rebuilding the current view.
Change polling accepts max_events from 1 to 200, default 100, and wait_ms from 0 to 25000, default 0. Bootstrap is immediate. Current identity, scope access, and document lifecycle are rechecked; a cursor does not preserve revoked access.
~/.dee/bin/dee api read list_documents --query scope=mine --query page_index=0 --query page_size=20 --query order_by=title.asc,id.asc --jsonDocuments, discussions, resources, and personal follow-up share the same current access rules while keeping their own identities and write conditions. A direct grant to one Space document does not grant Space membership or access to the Space’s collection.
Personal documents begin with their owner; Space documents use current membership and direct access sources. Effective roles combine applicable grants. Closing link joining blocks new joins but retains access that was already granted.
Title and Markdown save together. Titles allow up to 1000 Unicode characters; Markdown allows up to 1,000,000 UTF-8 bytes. Both reject NUL. Exact saved versions remain subject to current document access.
Send ordered content parts and complete mentions. A thread uses its root message ID. Quoted ranges are UTF-8 byte half-open intervals, not JavaScript string indexes; message quotes include the version read. Ordinary reads and messages do not confirm a person’s read progress.
Upload raw bytes with the declared MIME and filename query, not multipart or base64 JSON. Originals are limited to 20 MiB. Upload reservation, confirmed upload, and publication are distinct states. Reading metadata or original bytes always checks current resource and document access.
Message read progress, follow/mute preferences, and notification confirmation are separate personal states. Administrators review a current management token before Trash or restoration. Restoration preserves the document identity and saved content, applies current grants, and closes link joining.
HTTP errors use name, message, and data. Branch on HTTP status and the stable name; message is explanatory text. Validation may include data.fields with JSON Pointer locations. The x-request-id header identifies the request for diagnosis. Restricted /api/ responses, including errors and resource content, use Cache-Control: no-store.
401 means the current identity cannot be used. 403 can mean an invalid Origin or insufficient permission; unavailable and inaccessible targets generally share 404. A currently accessible document in Trash returns 410 for ordinary content. 409 identifies a particular version, management, cursor, or original-operation conflict. 503 means availability or confirmation failed; retain the original request before deciding to retry. The reference lists declared responses; shared authentication, recovery readiness, and request extraction can produce additional runtime failures.
MCP uses the same saved documents and current permissions. The local connector serves JSON-RPC over stdio; the HTTP document endpoint is /mcp. Initialize with protocolVersion 2025-11-25, capabilities, and clientInfo, then discover actual tools through tools/list. HTTP MCP requires an opaque Dee Bearer; a browser Cookie cannot substitute.
Tool success returns structuredContent and may include a resource_link with the real document URL. Domain failures return result.isError=true; malformed JSON, invalid requests, and invalid parameters use JSON-RPC errors. Valid notifications have no JSON-RPC reply; HTTP returns 202 with an empty body. The stdio adapter also exposes list_operations for interrupted local writes. Reading through a tool does not mark a person’s discussions as read.
The HTTP operation and model reference below is generated from the current OpenAPI declaration. Browser approval and MCP runtime protocols are listed separately because they are not yet part of that declaration. Missing OpenAPI security schemes do not make restricted endpoints public.
{
"name": "RevisionConflict",
"message": "The document changed since the version you read.",
"data": { "current_revision_id": "RETURNED_REVISION_ID" }
}142 HTTP operations from the current OpenAPI contract, plus 2 supplemental runtime protocols. Expand an endpoint for its parameters, request body, responses, and model links.
No endpoints match. Try a method, path, or operation ID.
Inspect the current account, handle browser sign-in, and resolve registered collaborators.
/agent/logoutLogout agent connectionOperation: logout_agent_connectionPermalink
The connection’s own opaque Dee Bearer; no Cookie. Any supplied Origin must match. Revocation leaves browser sign-in intact.
204 The connection credential was revoked./api/account/login-identitiesLogin identitiesOperation: login_identitiesPermalink
Current human-account connector Bearer, or the browser Dee session. Independent Agent Service access is limited to its documented Phase 1 subset. Cookie mutations require the exact application Origin. Bearer requests must omit Cookie; any supplied Origin must match the application. Current resource permissions apply.
| Name | Location | Requirement and schema |
|---|---|---|
X-Dee-Expected-Account-Id | header | Optional Original Dee account ID. Current Dee Cookie or human-authorized native-client Bearer remains the credential; another account returns 409 AccountChanged before reading or writing actor-scoped facts. Same-account new sessions remain compatible. View schema |
200 All sign-in methods belonging to this browser account; provider subjects are never exposedapplication/jsonModels: LoginIdentitiesResponse
{
"$ref": "#/components/schemas/LoginIdentitiesResponse"
}400 Invalid request or expected account header.401 A browser session is required; Agent credentials are not accepted409 AccountChanged: the current Cookie belongs to another account; no actor-scoped action was performed.503 Identity storage unavailable/api/account/login-identities/googleLink googleOperation: link_googlePermalink
Current human-account connector Bearer, or the browser Dee session. Independent Agent Service access is limited to its documented Phase 1 subset. Cookie mutations require the exact application Origin. Bearer requests must omit Cookie; any supplied Origin must match the application. Current resource permissions apply.
| Name | Location | Requirement and schema |
|---|---|---|
X-Dee-Expected-Account-Id | header | Optional Original Dee account ID. Current Dee Cookie or human-authorized native-client Bearer remains the credential; another account returns 409 AccountChanged before reading or writing actor-scoped facts. Same-account new sessions remain compatible. View schema |
application/jsonModels: GoogleLoginRequest
{
"$ref": "#/components/schemas/GoogleLoginRequest"
}200 Start explicit Google linking, bound to this browser session and account. Callback preserves the session and returns to the validated target.application/jsonModels: GoogleLoginResponse
{
"$ref": "#/components/schemas/GoogleLoginResponse"
}400 Invalid request or return target401 A browser session is required; Agent credentials are not accepted403 Invalid application origin409 The initiating session changed AccountChanged: current Cookie belongs to another account; no actor-scoped action was performed.503 Identity storage or provider unavailable/api/account/login-identities/{id}Unlink login identityOperation: unlink_login_identityPermalink
Current human-account connector Bearer, or the browser Dee session. Independent Agent Service access is limited to its documented Phase 1 subset. Cookie mutations require the exact application Origin. Bearer requests must omit Cookie; any supplied Origin must match the application. Current resource permissions apply.
| Name | Location | Requirement and schema |
|---|---|---|
id | path | Required Sign-in method owned by the current account Models: Id View schema |
X-Dee-Expected-Account-Id | header | Optional Original Dee account ID. Current Dee Cookie or human-authorized native-client Bearer remains the credential; another account returns 409 AccountChanged before reading or writing actor-scoped facts. Same-account new sessions remain compatible. View schema |
204 Sign-in method removed. Existing browser and Agent sessions remain active.400 Invalid request or expected account header.401 A browser session is required; Agent credentials are not accepted403 Invalid application origin404 Sign-in method is unavailable to this account409 The last sign-in method cannot be removed, or the session changed AccountChanged: current Cookie belongs to another account; no actor-scoped action was performed.503 Identity storage unavailable/api/accounts/resolveResolve accountOperation: resolve_accountPermalink
Registered-account lookup uses the browser Cookie and exact application Origin. A Dee Bearer alone does not replace this protocol.
| Name | Location | Requirement and schema |
|---|---|---|
Origin | header | Optional Required and equal to APP_ORIGIN when using a Cookie session View schema |
Cookie | header | Optional Current Dee browser session, or use an approved Agent Bearer credential View schema |
X-Dee-Expected-Account-Id | header | Optional Original Dee account ID. Current Dee Cookie or human-authorized native-client Bearer remains the credential; another account returns 409 AccountChanged before reading or writing actor-scoped facts. Same-account new sessions remain compatible. View schema |
Authorization | header | Optional Bearer opaque Dee credential from agent browser authorization. Browser requests continue to use the current Cookie and Origin. View schema |
application/jsonModels: ResolveAccountRequest
{
"$ref": "#/components/schemas/ResolveAccountRequest"
}200 One active, verified account already registered in Dee v0.1application/jsonModels: ResolvedAccountResponse
{
"$ref": "#/components/schemas/ResolvedAccountResponse"
}400 A complete email address is required401 Current identity is required403 Invalid origin404 No available registered v0.1 account matches409 No unique account can be confirmed AccountChanged: current Cookie belongs to another account; no actor-scoped action was performed.503 Identity lookup unavailable/api/auth/configLogin configOperation: login_configPermalink
Public endpoint; readiness or recovery conditions can still affect availability.
| Name | Location | Requirement and schema |
|---|---|---|
return_to | query | Optional Same-origin relative return target View schema |
200 Configured sign-in providers, default provider and validated navigation target; enabled is true when any provider is available. Grants no document access.application/jsonModels: LoginConfigResponse
{
"$ref": "#/components/schemas/LoginConfigResponse"
}400 Invalid return target/api/auth/googleGoogle loginOperation: google_loginPermalink
Begin Google sign-in with the exact application Origin. The backend binds its one-time callback to this browser and creates a Dee session after Google verification.
| Name | Location | Requirement and schema |
|---|---|---|
Origin | header | Required Must equal APP_ORIGIN View schema |
application/jsonModels: GoogleLoginRequest
{
"$ref": "#/components/schemas/GoogleLoginRequest"
}200 Start one browser-bound Google login. Navigate the browser to authorization_url.Set-Cookie{
"type": "string"
}application/jsonModels: GoogleLoginResponse
{
"$ref": "#/components/schemas/GoogleLoginResponse"
}400 Invalid JSON or navigation target403 Origin is not the configured application422 JSON fields do not match the login request503 Identity storage or Google configuration is unavailable/api/auth/google/callbackGoogle callbackOperation: google_callbackPermalink
Google redirect callback: no existing Dee session, Dee Bearer, or Origin header is required. The backend verifies the one-time state and the browser’s dee_google_login Cookie, then returns a 303 redirect. Successful callbacks establish the Dee session; failures return a fixed safe error to sign-in.
| Name | Location | Requirement and schema |
|---|---|---|
code | query | Optional Single-use Google authorization code View schema |
state | query | Optional State from the browser-bound login View schema |
error | query | Optional Google authorization failure View schema |
303 Sign-in establishes a Dee HttpOnly session and returns to the validated application path. Explicit linking requires the initiating browser session, preserves its cookie, and returns with login_identity=linked or login_identity_error=conflict|session_changed|google_link_failed. Failed sign-in returns to /sign-in with a fixed error code. Only matched browser binding retains the original target; unmatched callbacks use /app.Location{
"type": "string"
}Set-Cookie{
"type": "string"
}/api/sessionCurrentOperation: currentPermalink
Current human-account connector Bearer, or the browser Dee session. Independent Agent Service access is limited to its documented Phase 1 subset. Cookie mutations require the exact application Origin. Bearer requests must omit Cookie; any supplied Origin must match the application. Current resource permissions apply.
| Name | Location | Requirement and schema |
|---|---|---|
Cookie | header | Required Current Dee v0.1 session cookie View schema |
X-Dee-Expected-Account-Id | header | Optional Original Dee account ID. Current Dee Cookie or human-authorized native-client Bearer remains the credential; another account returns 409 AccountChanged before reading or writing actor-scoped facts. Same-account new sessions remain compatible. View schema |
Authorization | header | Optional Bearer opaque Dee credential from agent browser authorization. Browser requests continue to use the current Cookie and Origin. View schema |
200 Login-synchronized account and currently valid Dee session; no document grantapplication/jsonModels: CurrentSessionResponse
{
"$ref": "#/components/schemas/CurrentSessionResponse"
}400 Invalid request or expected account header.401 No valid current session409 AccountChanged: the current Cookie belongs to another account; no actor-scoped action was performed.503 Current identity cannot be verified/api/sessionLogoutOperation: logoutPermalink
Browser session logout: Cookie and exact application Origin, with the optional original-session condition. Use POST /agent/logout for an external connection.
| Name | Location | Requirement and schema |
|---|---|---|
Origin | header | Required Must equal APP_ORIGIN View schema |
Cookie | header | Optional Local session to revoke, if present View schema |
application/jsonModels: LogoutRequest
{
"oneOf": [
{
"type": "null"
},
{
"$ref": "#/components/schemas/LogoutRequest"
}
]
}204 Cookie-derived Dee session is durably revoked. Conditional requests confirm only a matching original SID, including an already-revoked row, and leave browser cookies unchanged to preserve newer logins. Unconditional requests also succeed for absent credentials.Set-Cookie{
"type": "string"
}400 Invalid logout condition403 Invalid request origin409 Conditional Cookie is absent, unknown, or identifies a different SID. Original logout is unconfirmed; no session is revoked or cookie cleared.503 Local revocation could not be confirmedCreate and read documents, save complete snapshots, and inspect original operation receipts.
/api/documentsList documentsOperation: list_documentsPermalink
Current human-account connector Bearer, or the browser Dee session. Independent Agent Service access is limited to its documented Phase 1 subset. Cookie mutations require the exact application Origin. Bearer requests must omit Cookie; any supplied Origin must match the application. Current resource permissions apply.
| Name | Location | Requirement and schema |
|---|---|---|
scope | query | Optional mine (default), collaborating, space, accessible View schema |
space_id | query | Optional Required only with space scope Models: Id View schema |
title | query | Optional Literal case-insensitive title substring View schema |
view | query | Optional updated (default), viewed or favorites; intersects scope View schema |
extension | query | Optional Exact explicit stored type, including unknown types. Nonempty lowercase identifier; omitted preserves all types, md differs from null. View schema |
page_index | query | OptionalView schema |
page_size | query | Optional 0 to 100; default 50 View schema |
order_by | query | Optional Comma-separated updated_at,created_at,title,readers_30d,last_viewed_at,favorited_at,pinned_at,id with asc/desc; mine/space updated views default to pinned_at.desc,updated_at.desc,id.asc; other defaults use the view timestamp descending,id.asc View schema |
X-Dee-Expected-Account-Id | header | Optional Original Dee account ID. Current Dee Cookie or human-authorized native-client Bearer remains the credential; another account returns 409 AccountChanged before reading or writing actor-scoped facts. Same-account new sessions remain compatible. View schema |
Authorization | header | Optional Bearer opaque Dee credential from agent browser authorization. Browser requests continue to use the current Cookie and Origin. View schema |
200 Current authorized summaries and counts from one snapshotapplication/jsonModels: Paged_DocumentSummary
{
"$ref": "#/components/schemas/Paged_DocumentSummary"
}400 Invalid filter or pagination401 Current session required404 Space unavailable409 AccountChanged: the current Cookie belongs to another account; no actor-scoped action was performed.503 Read unavailable/api/documentsCreate documentOperation: create_documentPermalink
Current browser user, ordinary human-account connector, or independent Agent Bearer. An Agent uses X-Dee-Expected-Agent-Id and current scope permissions; actual document writes additionally require the approved plan or bound-memory authorization. Browser mutations require the exact application Origin.
| Name | Location | Requirement and schema |
|---|---|---|
X-Dee-Expected-Account-Id | header | Optional Original Dee account ID. Current Dee Cookie or human-authorized native-client Bearer remains the credential; another account returns 409 AccountChanged before reading or writing actor-scoped facts. Same-account new sessions remain compatible. View schema |
X-Dee-Expected-Agent-Id | header | Optional Required for independent Agent requests; omitted for human requests. Send the original Agent ID with the Agent connection Bearer; a different Agent returns 409 AgentChanged. Do not combine with X-Dee-Expected-Account-Id. View schema |
Authorization | header | Optional Bearer opaque Dee credential from agent browser authorization. Browser requests continue to use the current Cookie and Origin. View schema |
application/jsonModels: CreateDocumentRequest
{
"$ref": "#/components/schemas/CreateDocumentRequest"
}201 Committed creation and first immutable snapshotapplication/jsonModels: DocumentReceipt
{
"$ref": "#/components/schemas/DocumentReceipt"
}400 Invalid input401 Current session required403 Invalid Origin404 Origin unavailable409 Operation conflict AccountChanged: current Cookie belongs to another account; no actor-scoped action was performed.503 Result unconfirmed/api/documents/operations/{operation_id}Get document operationOperation: get_document_operationPermalink
Current browser user, ordinary human-account connector, or independent Agent Bearer. An Agent uses X-Dee-Expected-Agent-Id and current scope permissions; actual document writes additionally require the approved plan or bound-memory authorization. Browser mutations require the exact application Origin.
| Name | Location | Requirement and schema |
|---|---|---|
operation_id | path | Required Models: Id View schema |
X-Dee-Expected-Account-Id | header | Optional Original Dee account ID. Current Dee Cookie or human-authorized native-client Bearer remains the credential; another account returns 409 AccountChanged before reading or writing actor-scoped facts. Same-account new sessions remain compatible. View schema |
X-Dee-Expected-Agent-Id | header | Optional Required for independent Agent requests; omitted for human requests. Send the original Agent ID with the Agent connection Bearer; a different Agent returns 409 AgentChanged. Do not combine with X-Dee-Expected-Account-Id. View schema |
Authorization | header | Optional Bearer opaque Dee credential from agent browser authorization. Browser requests continue to use the current Cookie and Origin. View schema |
200 Only the actor's original result, without private content or current accessapplication/jsonModels: DocumentReceipt
{
"$ref": "#/components/schemas/DocumentReceipt"
}400 Invalid 22-character Base62 ID401 Current session required404 No result for this actor409 AccountChanged: the current Cookie belongs to another account; no actor-scoped action was performed.503 Read unavailable/api/documents/{id}Get documentOperation: get_documentPermalink
Current browser user, ordinary human-account connector, or independent Agent Bearer. An Agent uses X-Dee-Expected-Agent-Id and current scope permissions; actual document writes additionally require the approved plan or bound-memory authorization. Browser mutations require the exact application Origin.
| Name | Location | Requirement and schema |
|---|---|---|
id | path | Required Models: Id View schema |
X-Dee-Expected-Account-Id | header | Optional Original Dee account ID. Current Dee Cookie or human-authorized native-client Bearer remains the credential; another account returns 409 AccountChanged before reading or writing actor-scoped facts. Same-account new sessions remain compatible. View schema |
X-Dee-Expected-Agent-Id | header | Optional Required for independent Agent requests; omitted for human requests. Send the original Agent ID with the Agent connection Bearer; a different Agent returns 409 AgentChanged. Do not combine with X-Dee-Expected-Account-Id. View schema |
Authorization | header | Optional Bearer opaque Dee credential from agent browser authorization. Browser requests continue to use the current Cookie and Origin. View schema |
200 Current authorized Markdown, metadata, safe HTML and TOCapplication/jsonModels: DocumentResponse
{
"$ref": "#/components/schemas/DocumentResponse"
}400 Invalid 22-character Base62 ID401 Current session required404 Document unavailable409 AccountChanged: the current Cookie belongs to another account; no actor-scoped action was performed.410 Document is in the trash under current access503 Read unavailable/api/documents/{id}Save documentOperation: save_documentPermalink
Current browser user, ordinary human-account connector, or independent Agent Bearer. An Agent uses X-Dee-Expected-Agent-Id and current scope permissions; actual document writes additionally require the approved plan or bound-memory authorization. Browser mutations require the exact application Origin.
| Name | Location | Requirement and schema |
|---|---|---|
id | path | Required Models: Id View schema |
X-Dee-Expected-Account-Id | header | Optional Original Dee account ID. Current Dee Cookie or human-authorized native-client Bearer remains the credential; another account returns 409 AccountChanged before reading or writing actor-scoped facts. Same-account new sessions remain compatible. View schema |
X-Dee-Expected-Agent-Id | header | Optional Required for independent Agent requests; omitted for human requests. Send the original Agent ID with the Agent connection Bearer; a different Agent returns 409 AgentChanged. Do not combine with X-Dee-Expected-Account-Id. View schema |
Authorization | header | Optional Bearer opaque Dee credential from agent browser authorization. Browser requests continue to use the current Cookie and Origin. View schema |
application/jsonModels: SaveDocumentRequest
{
"$ref": "#/components/schemas/SaveDocumentRequest"
}200 Committed title and body snapshot, or unchanged original versionapplication/jsonModels: DocumentReceipt
{
"$ref": "#/components/schemas/DocumentReceipt"
}400 Invalid input401 Current session required403 Insufficient role or Origin404 Document unavailable409 Revision or operation conflict AccountChanged: current Cookie belongs to another account; no actor-scoped action was performed.410 Document is in the trash under current access503 Result unconfirmed/api/documents/{id}/metadataGet document metadataOperation: get_document_metadataPermalink
Current human-account connector Bearer, or the browser Dee session. Independent Agent Service access is limited to its documented Phase 1 subset. Cookie mutations require the exact application Origin. Bearer requests must omit Cookie; any supplied Origin must match the application. Current resource permissions apply.
| Name | Location | Requirement and schema |
|---|---|---|
id | path | Required Models: Id View schema |
X-Dee-Expected-Account-Id | header | Optional Original Dee account ID. Current Dee Cookie or human-authorized native-client Bearer remains the credential; another account returns 409 AccountChanged before reading or writing actor-scoped facts. Same-account new sessions remain compatible. View schema |
Authorization | header | Optional Bearer opaque Dee credential from agent browser authorization. Browser requests continue to use the current Cookie and Origin. View schema |
200 Authorized metadata without body or rendered contentapplication/jsonModels: DocumentSummary
{
"$ref": "#/components/schemas/DocumentSummary"
}400 Invalid request or expected account header.401 404 409 AccountChanged: the current Cookie belongs to another account; no actor-scoped action was performed.410 503 /api/documents/{id}/revisions/{revision_id}Get document revisionOperation: get_document_revisionPermalink
Current browser user, ordinary human-account connector, or independent Agent Bearer. An Agent uses X-Dee-Expected-Agent-Id and current scope permissions; actual document writes additionally require the approved plan or bound-memory authorization. Browser mutations require the exact application Origin.
| Name | Location | Requirement and schema |
|---|---|---|
id | path | Required Models: Id View schema |
revision_id | path | Required Models: Id View schema |
X-Dee-Expected-Account-Id | header | Optional Original Dee account ID. Current Dee Cookie or human-authorized native-client Bearer remains the credential; another account returns 409 AccountChanged before reading or writing actor-scoped facts. Same-account new sessions remain compatible. View schema |
X-Dee-Expected-Agent-Id | header | Optional Required for independent Agent requests; omitted for human requests. Send the original Agent ID with the Agent connection Bearer; a different Agent returns 409 AgentChanged. Do not combine with X-Dee-Expected-Account-Id. View schema |
Authorization | header | Optional Bearer opaque Dee credential from agent browser authorization. Browser requests continue to use the current Cookie and Origin. View schema |
200 Immutable snapshot under current document permissionapplication/jsonModels: RevisionResponse
{
"$ref": "#/components/schemas/RevisionResponse"
}400 Invalid 22-character Base62 ID401 Current session required404 Document or version unavailable409 AccountChanged: the current Cookie belongs to another account; no actor-scoped action was performed.410 Document is in the trash under current access503 Read unavailable/api/documents/{id}/viewRecord document viewOperation: record_document_viewPermalink
Current human-account connector Bearer, or the browser Dee session. Independent Agent Service access is limited to its documented Phase 1 subset. Cookie mutations require the exact application Origin. Bearer requests must omit Cookie; any supplied Origin must match the application. Current resource permissions apply.
| Name | Location | Requirement and schema |
|---|---|---|
id | path | Required Models: Id View schema |
X-Dee-Expected-Account-Id | header | Optional Original Dee account ID. Current Dee Cookie or human-authorized native-client Bearer remains the credential; another account returns 409 AccountChanged before reading or writing actor-scoped facts. Same-account new sessions remain compatible. View schema |
Authorization | header | Optional Bearer opaque Dee credential from agent browser authorization. Browser requests continue to use the current Cookie and Origin. View schema |
200 Explicit actual opening retained for the current account; does not mark discussion messages readapplication/jsonModels: DocumentViewResponse
{
"$ref": "#/components/schemas/DocumentViewResponse"
}400 Invalid document ID401 Current account required403 Invalid Origin404 Document unavailable409 AccountChanged: the current Cookie belongs to another account; no actor-scoped action was performed.410 Document is in the trash503 Opening could not be confirmedManage shared workspaces and membership using current roles and revision conditions.
/api/spacesListOperation: listPermalink
Current human-account connector Bearer, or the browser Dee session. Independent Agent Service access is limited to its documented Phase 1 subset. Cookie mutations require the exact application Origin. Bearer requests must omit Cookie; any supplied Origin must match the application. Current resource permissions apply.
| Name | Location | Requirement and schema |
|---|---|---|
page_index | query | Optional Zero-based safe integer, default 0 View schema |
page_size | query | Optional 0..100, default 50; 0 returns count only View schema |
order_by | query | Optional Comma separated name/updated_at/id.asc|desc; default updated_at.desc,id.asc View schema |
X-Dee-Expected-Account-Id | header | Optional Original Dee account ID. Current Dee Cookie or human-authorized native-client Bearer remains the credential; another account returns 409 AccountChanged before reading or writing actor-scoped facts. Same-account new sessions remain compatible. View schema |
Authorization | header | Optional Bearer opaque Dee credential from agent browser authorization. Browser requests continue to use the current Cookie and Origin. View schema |
200 Current membership-filtered Space page and countapplication/jsonModels: Paged_SpaceResponse
{
"$ref": "#/components/schemas/Paged_SpaceResponse"
}400 Invalid paging401 Current session required409 AccountChanged: the current Cookie belongs to another account; no actor-scoped action was performed.503 Read unavailable/api/spacesCreateOperation: createPermalink
Current human-account connector Bearer, or the browser Dee session. Independent Agent Service access is limited to its documented Phase 1 subset. Cookie mutations require the exact application Origin. Bearer requests must omit Cookie; any supplied Origin must match the application. Current resource permissions apply.
| Name | Location | Requirement and schema |
|---|---|---|
X-Dee-Expected-Account-Id | header | Optional Original Dee account ID. Current Dee Cookie or human-authorized native-client Bearer remains the credential; another account returns 409 AccountChanged before reading or writing actor-scoped facts. Same-account new sessions remain compatible. View schema |
Authorization | header | Optional Bearer opaque Dee credential from agent browser authorization. Browser requests continue to use the current Cookie and Origin. View schema |
201 Committed actor-scoped Space creation result; exact retries return itapplication/jsonModels: ReceiptResponse
{
"$ref": "#/components/schemas/ReceiptResponse"
}400 Invalid request401 Current session required403 Invalid origin409 Operation ID conflict AccountChanged: current Cookie belongs to another account; no actor-scoped action was performed.503 Operation not confirmed/api/spaces/operations/{operation_id}OperationOperation: operationPermalink
Current human-account connector Bearer, or the browser Dee session. Independent Agent Service access is limited to its documented Phase 1 subset. Cookie mutations require the exact application Origin. Bearer requests must omit Cookie; any supplied Origin must match the application. Current resource permissions apply.
| Name | Location | Requirement and schema |
|---|---|---|
operation_id | path | Required Models: Id View schema |
X-Dee-Expected-Account-Id | header | Optional Original Dee account ID. Current Dee Cookie or human-authorized native-client Bearer remains the credential; another account returns 409 AccountChanged before reading or writing actor-scoped facts. Same-account new sessions remain compatible. View schema |
Authorization | header | Optional Bearer opaque Dee credential from agent browser authorization. Browser requests continue to use the current Cookie and Origin. View schema |
200 Only the original actor's retained write fact; not current Space accessapplication/jsonModels: ReceiptResponse
{
"$ref": "#/components/schemas/ReceiptResponse"
}400 Invalid request or expected account header.401 Current session required404 No result for this actor409 AccountChanged: the current Cookie belongs to another account; no actor-scoped action was performed.503 Read unavailable/api/spaces/{id}GetOperation: getPermalink
Current human-account connector Bearer, or the browser Dee session. Independent Agent Service access is limited to its documented Phase 1 subset. Cookie mutations require the exact application Origin. Bearer requests must omit Cookie; any supplied Origin must match the application. Current resource permissions apply.
| Name | Location | Requirement and schema |
|---|---|---|
id | path | Required Models: Id View schema |
X-Dee-Expected-Account-Id | header | Optional Original Dee account ID. Current Dee Cookie or human-authorized native-client Bearer remains the credential; another account returns 409 AccountChanged before reading or writing actor-scoped facts. Same-account new sessions remain compatible. View schema |
Authorization | header | Optional Bearer opaque Dee credential from agent browser authorization. Browser requests continue to use the current Cookie and Origin. View schema |
200 Current Space facts and role, members only400 Invalid request or expected account header.401 Current session required404 No current membership or nonexistent Space409 AccountChanged: the current Cookie belongs to another account; no actor-scoped action was performed.503 Read unavailable/api/spaces/{id}UpdateOperation: updatePermalink
Current human-account connector Bearer, or the browser Dee session. Independent Agent Service access is limited to its documented Phase 1 subset. Cookie mutations require the exact application Origin. Bearer requests must omit Cookie; any supplied Origin must match the application. Current resource permissions apply.
| Name | Location | Requirement and schema |
|---|---|---|
id | path | Required Models: Id View schema |
X-Dee-Expected-Account-Id | header | Optional Original Dee account ID. Current Dee Cookie or human-authorized native-client Bearer remains the credential; another account returns 409 AccountChanged before reading or writing actor-scoped facts. Same-account new sessions remain compatible. View schema |
Authorization | header | Optional Bearer opaque Dee credential from agent browser authorization. Browser requests continue to use the current Cookie and Origin. View schema |
200 Committed metadata replacement result, administrator onlyapplication/jsonModels: ReceiptResponse
{
"$ref": "#/components/schemas/ReceiptResponse"
}400 Invalid request401 Current session required403 Insufficient role or invalid origin404 Space unavailable409 Revision or operation conflict AccountChanged: current Cookie belongs to another account; no actor-scoped action was performed.503 Result not confirmed/api/spaces/{id}/leaveLeaveOperation: leavePermalink
Current human-account connector Bearer, or the browser Dee session. Independent Agent Service access is limited to its documented Phase 1 subset. Cookie mutations require the exact application Origin. Bearer requests must omit Cookie; any supplied Origin must match the application. Current resource permissions apply.
| Name | Location | Requirement and schema |
|---|---|---|
id | path | Required Models: Id View schema |
X-Dee-Expected-Account-Id | header | Optional Original Dee account ID. Current Dee Cookie or human-authorized native-client Bearer remains the credential; another account returns 409 AccountChanged before reading or writing actor-scoped facts. Same-account new sessions remain compatible. View schema |
Authorization | header | Optional Bearer opaque Dee credential from agent browser authorization. Browser requests continue to use the current Cookie and Origin. View schema |
application/jsonModels: RevisionRequest
{
"$ref": "#/components/schemas/RevisionRequest"
}200 Committed removal of this account's membership only; exact retry retains resultapplication/jsonModels: ReceiptResponse
{
"$ref": "#/components/schemas/ReceiptResponse"
}400 Invalid request401 Current session required403 Invalid origin404 Space unavailable409 Last administrator or revision/operation conflict AccountChanged: current Cookie belongs to another account; no actor-scoped action was performed.503 Result not confirmed/api/spaces/{id}/membersMembersOperation: membersPermalink
Current human-account connector Bearer, or the browser Dee session. Independent Agent Service access is limited to its documented Phase 1 subset. Cookie mutations require the exact application Origin. Bearer requests must omit Cookie; any supplied Origin must match the application. Current resource permissions apply.
| Name | Location | Requirement and schema |
|---|---|---|
id | path | Required Models: Id View schema |
page_index | query | OptionalView schema |
page_size | query | Optional 0..100, default 50 View schema |
order_by | query | Optional Comma separated joined_at/role/account_id.asc|desc; default joined_at.asc,account_id.asc View schema |
X-Dee-Expected-Account-Id | header | Optional Original Dee account ID. Current Dee Cookie or human-authorized native-client Bearer remains the credential; another account returns 409 AccountChanged before reading or writing actor-scoped facts. Same-account new sessions remain compatible. View schema |
Authorization | header | Optional Bearer opaque Dee credential from agent browser authorization. Browser requests continue to use the current Cookie and Origin. View schema |
200 Member page, available only to Space members; minimum registered profilesapplication/jsonModels: Paged_MemberResponse
{
"$ref": "#/components/schemas/Paged_MemberResponse"
}400 Invalid paging401 Current session required404 Space unavailable409 AccountChanged: the current Cookie belongs to another account; no actor-scoped action was performed.503 Read unavailable/api/spaces/{id}/membersAdd memberOperation: add_memberPermalink
Current human-account connector Bearer, or the browser Dee session. Independent Agent Service access is limited to its documented Phase 1 subset. Cookie mutations require the exact application Origin. Bearer requests must omit Cookie; any supplied Origin must match the application. Current resource permissions apply.
| Name | Location | Requirement and schema |
|---|---|---|
id | path | Required Models: Id View schema |
X-Dee-Expected-Account-Id | header | Optional Original Dee account ID. Current Dee Cookie or human-authorized native-client Bearer remains the credential; another account returns 409 AccountChanged before reading or writing actor-scoped facts. Same-account new sessions remain compatible. View schema |
Authorization | header | Optional Bearer opaque Dee credential from agent browser authorization. Browser requests continue to use the current Cookie and Origin. View schema |
application/jsonModels: AddMemberRequest
{
"$ref": "#/components/schemas/AddMemberRequest"
}201 Committed member addition, default editor, administrator onlyapplication/jsonModels: ReceiptResponse
{
"$ref": "#/components/schemas/ReceiptResponse"
}400 Invalid request401 Current session required403 Insufficient role or invalid origin404 Space or registered account unavailable409 Already member or revision/operation conflict AccountChanged: current Cookie belongs to another account; no actor-scoped action was performed.503 Result not confirmed/api/spaces/{id}/members/{account_id}Set roleOperation: set_rolePermalink
Current human-account connector Bearer, or the browser Dee session. Independent Agent Service access is limited to its documented Phase 1 subset. Cookie mutations require the exact application Origin. Bearer requests must omit Cookie; any supplied Origin must match the application. Current resource permissions apply.
| Name | Location | Requirement and schema |
|---|---|---|
id | path | Required Models: Id View schema |
account_id | path | Required Models: Id View schema |
X-Dee-Expected-Account-Id | header | Optional Original Dee account ID. Current Dee Cookie or human-authorized native-client Bearer remains the credential; another account returns 409 AccountChanged before reading or writing actor-scoped facts. Same-account new sessions remain compatible. View schema |
Authorization | header | Optional Bearer opaque Dee credential from agent browser authorization. Browser requests continue to use the current Cookie and Origin. View schema |
200 Committed member role result, administrator onlyapplication/jsonModels: ReceiptResponse
{
"$ref": "#/components/schemas/ReceiptResponse"
}400 Invalid request401 Current session required403 Insufficient role or origin404 Space or member unavailable409 Last administrator or revision/operation conflict AccountChanged: current Cookie belongs to another account; no actor-scoped action was performed.503 Result not confirmed/api/spaces/{id}/members/{account_id}Remove memberOperation: remove_memberPermalink
Current human-account connector Bearer, or the browser Dee session. Independent Agent Service access is limited to its documented Phase 1 subset. Cookie mutations require the exact application Origin. Bearer requests must omit Cookie; any supplied Origin must match the application. Current resource permissions apply.
| Name | Location | Requirement and schema |
|---|---|---|
id | path | Required Models: Id View schema |
account_id | path | Required Models: Id View schema |
X-Dee-Expected-Account-Id | header | Optional Original Dee account ID. Current Dee Cookie or human-authorized native-client Bearer remains the credential; another account returns 409 AccountChanged before reading or writing actor-scoped facts. Same-account new sessions remain compatible. View schema |
Authorization | header | Optional Bearer opaque Dee credential from agent browser authorization. Browser requests continue to use the current Cookie and Origin. View schema |
application/jsonModels: RevisionRequest
{
"$ref": "#/components/schemas/RevisionRequest"
}200 Committed member removal, does not change document holding or direct grantsapplication/jsonModels: ReceiptResponse
{
"$ref": "#/components/schemas/ReceiptResponse"
}400 Invalid request401 Current session required403 Insufficient role or origin404 Space or member unavailable409 Last administrator or revision/operation conflict AccountChanged: current Cookie belongs to another account; no actor-scoped action was performed.503 Result not confirmedInspect effective access, maintain direct collaborators, and configure explicit link joining.
/api/access/operations/{operation_id}Get access operationOperation: get_access_operationPermalink
Current human-account connector Bearer, or the browser Dee session. Independent Agent Service access is limited to its documented Phase 1 subset. Cookie mutations require the exact application Origin. Bearer requests must omit Cookie; any supplied Origin must match the application. Current resource permissions apply.
| Name | Location | Requirement and schema |
|---|---|---|
operation_id | path | Required Models: Id View schema |
X-Dee-Expected-Account-Id | header | Optional Original Dee account ID. Current Dee Cookie or human-authorized native-client Bearer remains the credential; another account returns 409 AccountChanged before reading or writing actor-scoped facts. Same-account new sessions remain compatible. View schema |
Authorization | header | Optional Bearer opaque Dee credential from agent browser authorization. Browser requests continue to use the current Cookie and Origin. View schema |
200 Only this actor's original committed fact, independent of current document access400 Invalid 22-character Base62 ID401 Current session required404 No result for this actor409 AccountChanged: the current Cookie belongs to another account; no actor-scoped action was performed.503 Read unavailable/api/documents/{id}/accessGet document accessOperation: get_document_accessPermalink
Current human-account connector Bearer, or the browser Dee session. Independent Agent Service access is limited to its documented Phase 1 subset. Cookie mutations require the exact application Origin. Bearer requests must omit Cookie; any supplied Origin must match the application. Current resource permissions apply.
| Name | Location | Requirement and schema |
|---|---|---|
id | path | Required Models: Id View schema |
X-Dee-Expected-Account-Id | header | Optional Original Dee account ID. Current Dee Cookie or human-authorized native-client Bearer remains the credential; another account returns 409 AccountChanged before reading or writing actor-scoped facts. Same-account new sessions remain compatible. View schema |
Authorization | header | Optional Bearer opaque Dee credential from agent browser authorization. Browser requests continue to use the current Cookie and Origin. View schema |
200 Current actor's effective document role and independent sourcesapplication/jsonModels: DocumentAccessResponse
{
"$ref": "#/components/schemas/DocumentAccessResponse"
}400 Invalid 22-character Base62 ID401 Current session required404 Document unavailable409 AccountChanged: the current Cookie belongs to another account; no actor-scoped action was performed.410 Document is in the trash under current access503 Read unavailable/api/documents/{id}/collaboratorsList document collaboratorsOperation: list_document_collaboratorsPermalink
Current human-account connector Bearer, or the browser Dee session. Independent Agent Service access is limited to its documented Phase 1 subset. Cookie mutations require the exact application Origin. Bearer requests must omit Cookie; any supplied Origin must match the application. Current resource permissions apply.
| Name | Location | Requirement and schema |
|---|---|---|
id | path | Required Models: Id View schema |
page_index | query | OptionalView schema |
page_size | query | Optional 0..100, default 50; 0 returns count only View schema |
order_by | query | Optional Comma separated joined_at/role/account_id.asc|desc; default joined_at.asc,account_id.asc View schema |
X-Dee-Expected-Account-Id | header | Optional Original Dee account ID. Current Dee Cookie or human-authorized native-client Bearer remains the credential; another account returns 409 AccountChanged before reading or writing actor-scoped facts. Same-account new sessions remain compatible. View schema |
Authorization | header | Optional Bearer opaque Dee credential from agent browser authorization. Browser requests continue to use the current Cookie and Origin. View schema |
200 Direct collaborators and their effective sources, document administrator onlyapplication/jsonModels: Paged_CollaboratorResponse
{
"$ref": "#/components/schemas/Paged_CollaboratorResponse"
}400 Invalid 22-character Base62 ID or paging401 Current session required403 Administrator permission required404 Document unavailable409 AccountChanged: the current Cookie belongs to another account; no actor-scoped action was performed.410 Document is in the trash under current access503 Read unavailable/api/documents/{id}/collaborators/{account_id}Set document collaboratorOperation: set_document_collaboratorPermalink
Current human-account connector Bearer, or the browser Dee session. Independent Agent Service access is limited to its documented Phase 1 subset. Cookie mutations require the exact application Origin. Bearer requests must omit Cookie; any supplied Origin must match the application. Current resource permissions apply.
| Name | Location | Requirement and schema |
|---|---|---|
id | path | Required Models: Id View schema |
account_id | path | Required Models: Id View schema |
X-Dee-Expected-Account-Id | header | Optional Original Dee account ID. Current Dee Cookie or human-authorized native-client Bearer remains the credential; another account returns 409 AccountChanged before reading or writing actor-scoped facts. Same-account new sessions remain compatible. View schema |
Authorization | header | Optional Bearer opaque Dee credential from agent browser authorization. Browser requests continue to use the current Cookie and Origin. View schema |
application/jsonModels: SetCollaboratorRequest
{
"$ref": "#/components/schemas/SetCollaboratorRequest"
}200 Committed direct grant creation or replacement; inherited sources remain400 Invalid request401 Current session required403 Administrator permission or valid origin required404 Document or registered account unavailable409 Access revision, operation or last administrator conflict AccountChanged: current Cookie belongs to another account; no actor-scoped action was performed.503 Result not confirmed/api/documents/{id}/collaborators/{account_id}Remove document collaboratorOperation: remove_document_collaboratorPermalink
Current human-account connector Bearer, or the browser Dee session. Independent Agent Service access is limited to its documented Phase 1 subset. Cookie mutations require the exact application Origin. Bearer requests must omit Cookie; any supplied Origin must match the application. Current resource permissions apply.
| Name | Location | Requirement and schema |
|---|---|---|
id | path | Required Models: Id View schema |
account_id | path | Required Models: Id View schema |
X-Dee-Expected-Account-Id | header | Optional Original Dee account ID. Current Dee Cookie or human-authorized native-client Bearer remains the credential; another account returns 409 AccountChanged before reading or writing actor-scoped facts. Same-account new sessions remain compatible. View schema |
Authorization | header | Optional Bearer opaque Dee credential from agent browser authorization. Browser requests continue to use the current Cookie and Origin. View schema |
application/jsonModels: RemoveCollaboratorRequest
{
"$ref": "#/components/schemas/RemoveCollaboratorRequest"
}200 Committed direct grant removal; inherited sources remain400 Invalid request401 Current session required403 Administrator permission or valid origin required404 Document unavailable409 Access revision, operation or last administrator conflict AccountChanged: current Cookie belongs to another account; no actor-scoped action was performed.503 Result not confirmed/api/documents/{id}/joinJoin documentOperation: join_documentPermalink
Current human-account connector Bearer, or the browser Dee session. Independent Agent Service access is limited to its documented Phase 1 subset. Cookie mutations require the exact application Origin. Bearer requests must omit Cookie; any supplied Origin must match the application. Current resource permissions apply.
| Name | Location | Requirement and schema |
|---|---|---|
id | path | Required Models: Id View schema |
X-Dee-Expected-Account-Id | header | Optional Original Dee account ID. Current Dee Cookie or human-authorized native-client Bearer remains the credential; another account returns 409 AccountChanged before reading or writing actor-scoped facts. Same-account new sessions remain compatible. View schema |
Authorization | header | Optional Bearer opaque Dee credential from agent browser authorization. Browser requests continue to use the current Cookie and Origin. View schema |
application/jsonModels: JoinDocumentRequest
{
"$ref": "#/components/schemas/JoinDocumentRequest"
}200 Committed join or existing-access result; existing access is never upgraded400 Invalid request401 Current session required403 Valid origin required404 Document unavailable or joining closed for an unauthorized actor409 Operation conflict AccountChanged: current Cookie belongs to another account; no actor-scoped action was performed.410 Document is in the trash under current access503 Result not confirmed/api/documents/{id}/sharingGet document sharingOperation: get_document_sharingPermalink
Current human-account connector Bearer, or the browser Dee session. Independent Agent Service access is limited to its documented Phase 1 subset. Cookie mutations require the exact application Origin. Bearer requests must omit Cookie; any supplied Origin must match the application. Current resource permissions apply.
| Name | Location | Requirement and schema |
|---|---|---|
id | path | Required Models: Id View schema |
X-Dee-Expected-Account-Id | header | Optional Original Dee account ID. Current Dee Cookie or human-authorized native-client Bearer remains the credential; another account returns 409 AccountChanged before reading or writing actor-scoped facts. Same-account new sessions remain compatible. View schema |
Authorization | header | Optional Bearer opaque Dee credential from agent browser authorization. Browser requests continue to use the current Cookie and Origin. View schema |
200 Current link rule and access revision, document administrator onlyapplication/jsonModels: SharingResponse
{
"$ref": "#/components/schemas/SharingResponse"
}400 Invalid 22-character Base62 ID401 Current session required403 Administrator permission required404 Document unavailable409 AccountChanged: the current Cookie belongs to another account; no actor-scoped action was performed.410 Document is in the trash under current access503 Read unavailable/api/documents/{id}/sharingSet document sharingOperation: set_document_sharingPermalink
Current human-account connector Bearer, or the browser Dee session. Independent Agent Service access is limited to its documented Phase 1 subset. Cookie mutations require the exact application Origin. Bearer requests must omit Cookie; any supplied Origin must match the application. Current resource permissions apply.
| Name | Location | Requirement and schema |
|---|---|---|
id | path | Required Models: Id View schema |
X-Dee-Expected-Account-Id | header | Optional Original Dee account ID. Current Dee Cookie or human-authorized native-client Bearer remains the credential; another account returns 409 AccountChanged before reading or writing actor-scoped facts. Same-account new sessions remain compatible. View schema |
Authorization | header | Optional Bearer opaque Dee credential from agent browser authorization. Browser requests continue to use the current Cookie and Origin. View schema |
application/jsonModels: SetSharingRequest
{
"$ref": "#/components/schemas/SetSharingRequest"
}200 Committed link rule for future joins; existing grants remain400 Invalid request401 Current session required403 Administrator permission or valid origin required404 Document unavailable409 Access revision or operation conflict AccountChanged: current Cookie belongs to another account; no actor-scoped action was performed.503 Result not confirmedUpload original bytes, inspect upload status, and read currently authorized resource content.
/api/resources/uploadsUpload resourceOperation: upload_resourcePermalink
Current human-account connector Bearer, or the browser Dee session. Independent Agent Service access is limited to its documented Phase 1 subset. Cookie mutations require the exact application Origin. Bearer requests must omit Cookie; any supplied Origin must match the application. Current resource permissions apply.
| Name | Location | Requirement and schema |
|---|---|---|
operation_id | query | Required Models: Id View schema |
filename | query | RequiredView schema |
document_id | query | Optional Models: Id View schema |
create_operation_id | query | Optional Models: Id View schema |
X-Dee-Expected-Account-Id | header | Optional Original Dee account ID. Current Dee Cookie or human-authorized native-client Bearer remains the credential; another account returns 409 AccountChanged before reading or writing actor-scoped facts. Same-account new sessions remain compatible. View schema |
Authorization | header | Optional Bearer opaque Dee credential from agent browser authorization. Browser requests continue to use the current Cookie and Origin. View schema |
Raw file bytes, 1 byte to 20 MiB. Use a concrete Content-Type, default application/octet-stream when omitted or empty. PNG/JPEG/GIF/WebP retain matching raster-signature checks; other file types download as attachments.
*/*{
"type": "string",
"format": "binary"
}application/octet-stream{
"type": "string",
"format": "binary"
}image/gif{
"type": "string",
"format": "binary"
}image/jpeg{
"type": "string",
"format": "binary"
}image/png{
"type": "string",
"format": "binary"
}image/webp{
"type": "string",
"format": "binary"
}201 Confirmed private upload; content is not yet published400 Invalid scope, MIME or raster signature401 Current session required403 Current edit permission or Origin required404 Document unavailable409 Changed upload intent AccountChanged: current Cookie belongs to another account; no actor-scoped action was performed.410 Document is in the trash under current access413 File exceeds 20 MiB503 Upload pending or unconfirmed/api/resources/uploads/{operation_id}Get upload operationOperation: get_upload_operationPermalink
Current human-account connector Bearer, or the browser Dee session. Independent Agent Service access is limited to its documented Phase 1 subset. Cookie mutations require the exact application Origin. Bearer requests must omit Cookie; any supplied Origin must match the application. Current resource permissions apply.
| Name | Location | Requirement and schema |
|---|---|---|
operation_id | path | Required Models: Id View schema |
X-Dee-Expected-Account-Id | header | Optional Original Dee account ID. Current Dee Cookie or human-authorized native-client Bearer remains the credential; another account returns 409 AccountChanged before reading or writing actor-scoped facts. Same-account new sessions remain compatible. View schema |
Authorization | header | Optional Bearer opaque Dee credential from agent browser authorization. Browser requests continue to use the current Cookie and Origin. View schema |
200 Actor-only reservation or confirmed result; no current access grant400 Invalid request or expected account header.401 Current session required404 No reservation for this actor409 AccountChanged: the current Cookie belongs to another account; no actor-scoped action was performed.503 Read unavailable/api/resources/{id}Get resourceOperation: get_resourcePermalink
Current human-account connector Bearer, or the browser Dee session. Independent Agent Service access is limited to its documented Phase 1 subset. Cookie mutations require the exact application Origin. Bearer requests must omit Cookie; any supplied Origin must match the application. Current resource permissions apply.
| Name | Location | Requirement and schema |
|---|---|---|
id | path | Required Models: Id View schema |
X-Dee-Expected-Account-Id | header | Optional Original Dee account ID. Current Dee Cookie or human-authorized native-client Bearer remains the credential; another account returns 409 AccountChanged before reading or writing actor-scoped facts. Same-account new sessions remain compatible. View schema |
Authorization | header | Optional Bearer opaque Dee credential from agent browser authorization. Browser requests continue to use the current Cookie and Origin. View schema |
200 Current authorized resource metadataapplication/jsonModels: ResourceMetadata
{
"$ref": "#/components/schemas/ResourceMetadata"
}400 Invalid request or expected account header.401 Current session required404 Resource unavailable409 AccountChanged: the current Cookie belongs to another account; no actor-scoped action was performed.410 Document is in the trash under current access503 Read unavailable/api/resources/{id}/contentGet resource contentOperation: get_resource_contentPermalink
Current human-account connector Bearer, or the browser Dee session. Independent Agent Service access is limited to its documented Phase 1 subset. Cookie mutations require the exact application Origin. Bearer requests must omit Cookie; any supplied Origin must match the application. Current resource permissions apply.
| Name | Location | Requirement and schema |
|---|---|---|
id | path | Required Models: Id View schema |
X-Dee-Expected-Account-Id | header | Optional Original Dee account ID. Current Dee Cookie or human-authorized native-client Bearer remains the credential; another account returns 409 AccountChanged before reading or writing actor-scoped facts. Same-account new sessions remain compatible. View schema |
Authorization | header | Optional Bearer opaque Dee credential from agent browser authorization. Browser requests continue to use the current Cookie and Origin. View schema |
200 Verified private original bytes; PNG/JPEG/GIF/WebP inline, every other MIME type as an attachment with a UTF-8 filenameimage/png{
"type": "string",
"format": "binary"
}image/jpeg{
"type": "string",
"format": "binary"
}image/gif{
"type": "string",
"format": "binary"
}image/webp{
"type": "string",
"format": "binary"
}application/octet-stream{
"type": "string",
"format": "binary"
}*/*{
"type": "string",
"format": "binary"
}400 Invalid request or expected account header.401 Current session required404 Resource unavailable409 AccountChanged: the current Cookie belongs to another account; no actor-scoped action was performed.410 Document is in the trash under current access503 Original unavailablePublish and maintain messages, quote exact passages, and read discussions and their context.
/api/communication/operations/{operation_id}Get communication operationOperation: get_communication_operationPermalink
Current browser user, ordinary human-account connector, or independent Agent Bearer. An Agent uses X-Dee-Expected-Agent-Id and current scope permissions; actual document writes additionally require the approved plan or bound-memory authorization. Browser mutations require the exact application Origin.
| Name | Location | Requirement and schema |
|---|---|---|
operation_id | path | Required Models: Id View schema |
X-Dee-Expected-Account-Id | header | Optional Original Dee account ID. Current Dee Cookie or human-authorized native-client Bearer remains the credential; another account returns 409 AccountChanged before reading or writing actor-scoped facts. Same-account new sessions remain compatible. View schema |
X-Dee-Expected-Agent-Id | header | Optional Required for independent Agent requests; omitted for human requests. Send the original Agent ID with the Agent connection Bearer; a different Agent returns 409 AgentChanged. Do not combine with X-Dee-Expected-Account-Id. View schema |
Authorization | header | Optional Bearer opaque Dee credential from agent browser authorization. Browser requests continue to use the current Cookie and Origin. View schema |
200 Actor-only minimal original receipt; no current content or access400 Invalid request or expected account header.401 Current session required404 No result for this actor409 AccountChanged: the current Cookie belongs to another account; no actor-scoped action was performed.503 Read unavailable/api/documents/{id}/messagesList messagesOperation: list_messagesPermalink
Current browser user, ordinary human-account connector, or independent Agent Bearer. An Agent uses X-Dee-Expected-Agent-Id and current scope permissions; actual document writes additionally require the approved plan or bound-memory authorization. Browser mutations require the exact application Origin.
| Name | Location | Requirement and schema |
|---|---|---|
id | path | Required Models: Id View schema |
thread_id | query | Optional Absent: main messages. Present: replies in this Thread Models: Id View schema |
read_boundary_message_id | query | Optional Reuse the returned main/Thread boundary to preserve page membership during new messages Models: Id View schema |
page_index | query | OptionalView schema |
page_size | query | Optional Default 50, maximum 100; zero returns counts only View schema |
order_by | query | Optional created_at or id with asc/desc; default created_at.asc,id.asc View schema |
X-Dee-Expected-Account-Id | header | Optional Original Dee account ID. Current Dee Cookie or human-authorized native-client Bearer remains the credential; another account returns 409 AccountChanged before reading or writing actor-scoped facts. Same-account new sessions remain compatible. View schema |
X-Dee-Expected-Agent-Id | header | Optional Required for independent Agent requests; omitted for human requests. Send the original Agent ID with the Agent connection Bearer; a different Agent returns 409 AgentChanged. Do not combine with X-Dee-Expected-Account-Id. View schema |
Authorization | header | Optional Bearer opaque Dee credential from agent browser authorization. Browser requests continue to use the current Cookie and Origin. View schema |
200 Messages and current authorized counts from one snapshotapplication/jsonModels: MessagePageResponse
{
"$ref": "#/components/schemas/MessagePageResponse"
}400 Invalid query401 Current session required404 Document or Thread unavailable409 New entry shape requires the common entry read_url AccountChanged: current Cookie belongs to another account; no actor-scoped action was performed.410 Document is in the trash under current access503 Read unavailable/api/documents/{id}/messagesSend messageOperation: send_messagePermalink
Current browser user, ordinary human-account connector, or independent Agent Bearer. An Agent uses X-Dee-Expected-Agent-Id and current scope permissions; actual document writes additionally require the approved plan or bound-memory authorization. Browser mutations require the exact application Origin.
| Name | Location | Requirement and schema |
|---|---|---|
id | path | Required Models: Id View schema |
X-Dee-Expected-Account-Id | header | Optional Original Dee account ID. Current Dee Cookie or human-authorized native-client Bearer remains the credential; another account returns 409 AccountChanged before reading or writing actor-scoped facts. Same-account new sessions remain compatible. View schema |
X-Dee-Expected-Agent-Id | header | Optional Required for independent Agent requests; omitted for human requests. Send the original Agent ID with the Agent connection Bearer; a different Agent returns 409 AgentChanged. Do not combine with X-Dee-Expected-Account-Id. View schema |
Authorization | header | Optional Bearer opaque Dee credential from agent browser authorization. Browser requests continue to use the current Cookie and Origin. View schema |
201 Committed message and original minimal receipt400 Invalid content or source selection401 Current session required403 Edit role or Origin required404 Document, reply or source unavailable409 Operation or source conflict AccountChanged: current Cookie belongs to another account; no actor-scoped action was performed.410 Document is in the trash under current access503 Unconfirmed result/api/documents/{id}/messages/{message_id}Get messageOperation: get_messagePermalink
Current browser user, ordinary human-account connector, or independent Agent Bearer. An Agent uses X-Dee-Expected-Agent-Id and current scope permissions; actual document writes additionally require the approved plan or bound-memory authorization. Browser mutations require the exact application Origin.
| Name | Location | Requirement and schema |
|---|---|---|
id | path | Required Models: Id View schema |
message_id | path | Required Models: Id View schema |
X-Dee-Expected-Account-Id | header | Optional Original Dee account ID. Current Dee Cookie or human-authorized native-client Bearer remains the credential; another account returns 409 AccountChanged before reading or writing actor-scoped facts. Same-account new sessions remain compatible. View schema |
X-Dee-Expected-Agent-Id | header | Optional Required for independent Agent requests; omitted for human requests. Send the original Agent ID with the Agent connection Bearer; a different Agent returns 409 AgentChanged. Do not combine with X-Dee-Expected-Account-Id. View schema |
Authorization | header | Optional Bearer opaque Dee credential from agent browser authorization. Browser requests continue to use the current Cookie and Origin. View schema |
200 Currently authorized message or deletion placeholderapplication/jsonModels: MessageResponse
{
"$ref": "#/components/schemas/MessageResponse"
}400 Invalid request or expected account header.401 Current session required404 Unavailable target409 New entry shape requires the common entry read_url AccountChanged: current Cookie belongs to another account; no actor-scoped action was performed.410 Document is in the trash under current access503 Read unavailable/api/documents/{id}/messages/{message_id}Edit messageOperation: edit_messagePermalink
Current browser user, ordinary human-account connector, or independent Agent Bearer. An Agent uses X-Dee-Expected-Agent-Id and current scope permissions; actual document writes additionally require the approved plan or bound-memory authorization. Browser mutations require the exact application Origin.
| Name | Location | Requirement and schema |
|---|---|---|
id | path | Required Models: Id View schema |
message_id | path | Required Models: Id View schema |
X-Dee-Expected-Account-Id | header | Optional Original Dee account ID. Current Dee Cookie or human-authorized native-client Bearer remains the credential; another account returns 409 AccountChanged before reading or writing actor-scoped facts. Same-account new sessions remain compatible. View schema |
X-Dee-Expected-Agent-Id | header | Optional Required for independent Agent requests; omitted for human requests. Send the original Agent ID with the Agent connection Bearer; a different Agent returns 409 AgentChanged. Do not combine with X-Dee-Expected-Account-Id. View schema |
Authorization | header | Optional Bearer opaque Dee credential from agent browser authorization. Browser requests continue to use the current Cookie and Origin. View schema |
200 Committed edit or unchanged original snapshot400 Invalid content401 Current session required403 Current author edit role required404 Unavailable target or source409 Version, deleted, source or operation conflict AccountChanged: current Cookie belongs to another account; no actor-scoped action was performed.410 Document is in the trash under current access503 Unconfirmed result/api/documents/{id}/messages/{message_id}Delete messageOperation: delete_messagePermalink
Current browser user, ordinary human-account connector, or independent Agent Bearer. An Agent uses X-Dee-Expected-Agent-Id and current scope permissions; actual document writes additionally require the approved plan or bound-memory authorization. Browser mutations require the exact application Origin.
| Name | Location | Requirement and schema |
|---|---|---|
id | path | Required Models: Id View schema |
message_id | path | Required Models: Id View schema |
X-Dee-Expected-Account-Id | header | Optional Original Dee account ID. Current Dee Cookie or human-authorized native-client Bearer remains the credential; another account returns 409 AccountChanged before reading or writing actor-scoped facts. Same-account new sessions remain compatible. View schema |
X-Dee-Expected-Agent-Id | header | Optional Required for independent Agent requests; omitted for human requests. Send the original Agent ID with the Agent connection Bearer; a different Agent returns 409 AgentChanged. Do not combine with X-Dee-Expected-Account-Id. View schema |
Authorization | header | Optional Bearer opaque Dee credential from agent browser authorization. Browser requests continue to use the current Cookie and Origin. View schema |
200 Committed deletion or existing tombstone400 Invalid request401 Current session required403 Current author or administrator role required404 Target unavailable409 Version or operation conflict AccountChanged: current Cookie belongs to another account; no actor-scoped action was performed.410 Document is in the trash under current access503 Unconfirmed result/api/documents/{id}/messages/{message_id}/contextGet message contextOperation: get_message_contextPermalink
Current browser user, ordinary human-account connector, or independent Agent Bearer. An Agent uses X-Dee-Expected-Agent-Id and current scope permissions; actual document writes additionally require the approved plan or bound-memory authorization. Browser mutations require the exact application Origin.
| Name | Location | Requirement and schema |
|---|---|---|
id | path | Required Models: Id View schema |
message_id | path | Required Models: Id View schema |
before | query | Optional Default 10, maximum 50 View schema |
after | query | Optional Default 10, maximum 50 View schema |
X-Dee-Expected-Account-Id | header | Optional Original Dee account ID. Current Dee Cookie or human-authorized native-client Bearer remains the credential; another account returns 409 AccountChanged before reading or writing actor-scoped facts. Same-account new sessions remain compatible. View schema |
X-Dee-Expected-Agent-Id | header | Optional Required for independent Agent requests; omitted for human requests. Send the original Agent ID with the Agent connection Bearer; a different Agent returns 409 AgentChanged. Do not combine with X-Dee-Expected-Account-Id. View schema |
Authorization | header | Optional Bearer opaque Dee credential from agent browser authorization. Browser requests continue to use the current Cookie and Origin. View schema |
200 Stable-ID context in the message's actual main/Thread rangeapplication/jsonModels: ContextResponse
{
"$ref": "#/components/schemas/ContextResponse"
}400 Invalid context range401 Current session required404 Target unavailable409 New entry shape requires the common entry read_url AccountChanged: current Cookie belongs to another account; no actor-scoped action was performed.410 Document is in the trash under current access503 Read unavailable/api/documents/{id}/threads/{thread_id}Get threadOperation: get_threadPermalink
Current browser user, ordinary human-account connector, or independent Agent Bearer. An Agent uses X-Dee-Expected-Agent-Id and current scope permissions; actual document writes additionally require the approved plan or bound-memory authorization. Browser mutations require the exact application Origin.
| Name | Location | Requirement and schema |
|---|---|---|
id | path | Required Models: Id View schema |
thread_id | path | Required Models: Id View schema |
X-Dee-Expected-Account-Id | header | Optional Original Dee account ID. Current Dee Cookie or human-authorized native-client Bearer remains the credential; another account returns 409 AccountChanged before reading or writing actor-scoped facts. Same-account new sessions remain compatible. View schema |
X-Dee-Expected-Agent-Id | header | Optional Required for independent Agent requests; omitted for human requests. Send the original Agent ID with the Agent connection Bearer; a different Agent returns 409 AgentChanged. Do not combine with X-Dee-Expected-Account-Id. View schema |
Authorization | header | Optional Bearer opaque Dee credential from agent browser authorization. Browser requests continue to use the current Cookie and Origin. View schema |
200 Root, retained reply count and most recent reply time400 Invalid request or expected account header.401 Current session required404 Target unavailable409 New entry shape requires the common entry read_url AccountChanged: current Cookie belongs to another account; no actor-scoped action was performed.410 Document is in the trash under current access503 Read unavailableRead authorized change batches using opaque cursors, bootstrap fences, and long polling.
/api/agents/me/changesGet agent changesOperation: get_agent_changesPermalink
Independent Agent opaque Bearer with X-Dee-Expected-Agent-Id. No browser Cookie. The authenticated Agent, current scope, resource permissions, and work conditions determine access.
| Name | Location | Requirement and schema |
|---|---|---|
cursor | query | OptionalView schema |
max_events | query | OptionalView schema |
wait_ms | query | OptionalView schema |
include_activities | query | Optional Include typed activities using a separately bound cursor; default false View schema |
X-Dee-Expected-Account-Id | header | Optional Original Dee account ID. Current Dee Cookie or human-authorized native-client Bearer remains the credential; another account returns 409 AccountChanged before reading or writing actor-scoped facts. Same-account new sessions remain compatible. View schema |
X-Dee-Expected-Agent-Id | header | Optional Required for independent Agent requests; omitted for human requests. Send the original Agent ID with the Agent connection Bearer; a different Agent returns 409 AgentChanged. Do not combine with X-Dee-Expected-Account-Id. View schema |
Authorization | header | Optional Bearer opaque Dee credential from agent browser authorization. Browser requests continue to use the current Cookie and Origin. View schema |
200 400 Invalid request or expected account header.409 AccountChanged: current Cookie belongs to another account; no actor-scoped action was performed./api/documents/changesPersonal document changesOperation: personal_document_changesPermalink
Current human-account connector Bearer, or the browser Dee session. Independent Agent Service access is limited to its documented Phase 1 subset. Cookie mutations require the exact application Origin. Bearer requests must omit Cookie; any supplied Origin must match the application. Current resource permissions apply.
| Name | Location | Requirement and schema |
|---|---|---|
cursor | query | OptionalView schema |
max_events | query | OptionalView schema |
wait_ms | query | OptionalView schema |
include_activities | query | Optional Include typed activities using a separately bound cursor; default false View schema |
X-Dee-Expected-Account-Id | header | Optional Original Dee account ID. Current Dee Cookie or human-authorized native-client Bearer remains the credential; another account returns 409 AccountChanged before reading or writing actor-scoped facts. Same-account new sessions remain compatible. View schema |
Authorization | header | Optional Bearer opaque Dee credential from agent browser authorization. Browser requests continue to use the current Cookie and Origin. View schema |
200 This account's personal document and tree changes400 Invalid parameters401 Current session required409 Explicit resync required AccountChanged: current Cookie belongs to another account; no actor-scoped action was performed.503 Discovery unavailable/api/documents/{id}/changesDocument changesOperation: document_changesPermalink
Current human-account connector Bearer, or the browser Dee session. Independent Agent Service access is limited to its documented Phase 1 subset. Cookie mutations require the exact application Origin. Bearer requests must omit Cookie; any supplied Origin must match the application. Current resource permissions apply.
| Name | Location | Requirement and schema |
|---|---|---|
id | path | Required Models: Id View schema |
cursor | query | Optional Absent: bootstrap boundary before current reads; reuse for replay/resume View schema |
max_events | query | Optional Default 100, 1 to 200 View schema |
wait_ms | query | Optional Default 0, at most 25000; no database connection held during waits View schema |
include_activities | query | Optional Include typed activities using a separately bound cursor; default false View schema |
X-Dee-Expected-Account-Id | header | Optional Original Dee account ID. Current Dee Cookie or human-authorized native-client Bearer remains the credential; another account returns 409 AccountChanged before reading or writing actor-scoped facts. Same-account new sessions remain compatible. View schema |
Authorization | header | Optional Bearer opaque Dee credential from agent browser authorization. Browser requests continue to use the current Cookie and Origin. View schema |
200 Ordered committed identities under current access, or bootstrap boundary400 Invalid parameters401 Current session required404 Scope unavailable409 Invalid cursor; explicit reset boundary and current reads required AccountChanged: current Cookie belongs to another account; no actor-scoped action was performed.410 Document is in the trash under current access503 Resume original cursor after recovery/api/spaces/{id}/changesSpace changesOperation: space_changesPermalink
Current human-account connector Bearer, or the browser Dee session. Independent Agent Service access is limited to its documented Phase 1 subset. Cookie mutations require the exact application Origin. Bearer requests must omit Cookie; any supplied Origin must match the application. Current resource permissions apply.
| Name | Location | Requirement and schema |
|---|---|---|
id | path | Required Models: Id View schema |
cursor | query | Optional Absent: bootstrap boundary before current reads; scoped to current member View schema |
max_events | query | Optional Default 100, 1 to 200 View schema |
wait_ms | query | Optional Default 0, at most 25000 View schema |
include_activities | query | Optional Include typed activities using a separately bound cursor; default false View schema |
X-Dee-Expected-Account-Id | header | Optional Original Dee account ID. Current Dee Cookie or human-authorized native-client Bearer remains the credential; another account returns 409 AccountChanged before reading or writing actor-scoped facts. Same-account new sessions remain compatible. View schema |
Authorization | header | Optional Bearer opaque Dee credential from agent browser authorization. Browser requests continue to use the current Cookie and Origin. View schema |
200 Space and its document changes under current membership400 Invalid parameters401 Current session required404 Scope unavailable409 Explicit resync required AccountChanged: current Cookie belongs to another account; no actor-scoped action was performed.503 Discovery unavailableMaintain personal read progress, following, mute preferences, and notification confirmations.
/api/attention/followingList followed threadsOperation: list_followed_threadsPermalink
Current human-account connector Bearer, or the browser Dee session. Independent Agent Service access is limited to its documented Phase 1 subset. Cookie mutations require the exact application Origin. Bearer requests must omit Cookie; any supplied Origin must match the application. Current resource permissions apply.
| Name | Location | Requirement and schema |
|---|---|---|
page_index | query | OptionalView schema |
page_size | query | Optional Default 50, maximum 100; zero returns authorized counts View schema |
order_by | query | Optional updated_at,id; default updated_at.desc,id.asc View schema |
X-Dee-Expected-Account-Id | header | Optional Original Dee account ID. Current Dee Cookie or human-authorized native-client Bearer remains the credential; another account returns 409 AccountChanged before reading or writing actor-scoped facts. Same-account new sessions remain compatible. View schema |
Authorization | header | Optional Bearer opaque Dee credential from agent browser authorization. Browser requests continue to use the current Cookie and Origin. View schema |
200 Currently readable followed Threads; no read or follow mutationapplication/jsonModels: Paged_StateResponse
{
"$ref": "#/components/schemas/Paged_StateResponse"
}400 401 409 AccountChanged: the current Cookie belongs to another account; no actor-scoped action was performed.503 /api/attention/notificationsList notificationsOperation: list_notificationsPermalink
Current human-account connector Bearer, or the browser Dee session. Independent Agent Service access is limited to its documented Phase 1 subset. Cookie mutations require the exact application Origin. Bearer requests must omit Cookie; any supplied Origin must match the application. Current resource permissions apply.
| Name | Location | Requirement and schema |
|---|---|---|
unread | query | Optional Active unread filters exclude deleted sources View schema |
page_index | query | OptionalView schema |
page_size | query | Optional Default 50, maximum 100; zero returns authorized counts View schema |
order_by | query | Optional updated_at,created_at,id; default updated_at.desc,id.asc View schema |
X-Dee-Expected-Account-Id | header | Optional Original Dee account ID. Current Dee Cookie or human-authorized native-client Bearer remains the credential; another account returns 409 AccountChanged before reading or writing actor-scoped facts. Same-account new sessions remain compatible. View schema |
Authorization | header | Optional Bearer opaque Dee credential from agent browser authorization. Browser requests continue to use the current Cookie and Origin. View schema |
200 Receiver-only notifications under current document accessapplication/jsonModels: Paged_NotificationResponse
{
"$ref": "#/components/schemas/Paged_NotificationResponse"
}400 401 409 AccountChanged: the current Cookie belongs to another account; no actor-scoped action was performed.503 /api/attention/notifications/{id}Get notificationOperation: get_notificationPermalink
Current human-account connector Bearer, or the browser Dee session. Independent Agent Service access is limited to its documented Phase 1 subset. Cookie mutations require the exact application Origin. Bearer requests must omit Cookie; any supplied Origin must match the application. Current resource permissions apply.
| Name | Location | Requirement and schema |
|---|---|---|
id | path | Required Models: Id View schema |
X-Dee-Expected-Account-Id | header | Optional Original Dee account ID. Current Dee Cookie or human-authorized native-client Bearer remains the credential; another account returns 409 AccountChanged before reading or writing actor-scoped facts. Same-account new sessions remain compatible. View schema |
Authorization | header | Optional Bearer opaque Dee credential from agent browser authorization. Browser requests continue to use the current Cookie and Origin. View schema |
200 Current receiver-owned source metadata or deletion placeholderapplication/jsonModels: NotificationResponse
{
"$ref": "#/components/schemas/NotificationResponse"
}400 401 404 409 AccountChanged: the current Cookie belongs to another account; no actor-scoped action was performed.410 Document is in the trash under current access503 /api/attention/notifications/{id}/readRead notificationOperation: read_notificationPermalink
Current human-account connector Bearer, or the browser Dee session. Independent Agent Service access is limited to its documented Phase 1 subset. Cookie mutations require the exact application Origin. Bearer requests must omit Cookie; any supplied Origin must match the application. Current resource permissions apply.
| Name | Location | Requirement and schema |
|---|---|---|
id | path | Required Models: Id View schema |
X-Dee-Expected-Account-Id | header | Optional Original Dee account ID. Current Dee Cookie or human-authorized native-client Bearer remains the credential; another account returns 409 AccountChanged before reading or writing actor-scoped facts. Same-account new sessions remain compatible. View schema |
Authorization | header | Optional Bearer opaque Dee credential from agent browser authorization. Browser requests continue to use the current Cookie and Origin. View schema |
application/jsonModels: NotificationReadRequest
{
"$ref": "#/components/schemas/NotificationReadRequest"
}200 Explicit notification acknowledgement under its observed revisionapplication/jsonModels: AttentionReceipt
{
"$ref": "#/components/schemas/AttentionReceipt"
}400 401 403 404 409 AccountChanged: current Cookie belongs to another account; no actor-scoped action was performed.410 Document is in the trash under current access503 /api/attention/operations/{id}Get attention operationOperation: get_attention_operationPermalink
Current human-account connector Bearer, or the browser Dee session. Independent Agent Service access is limited to its documented Phase 1 subset. Cookie mutations require the exact application Origin. Bearer requests must omit Cookie; any supplied Origin must match the application. Current resource permissions apply.
| Name | Location | Requirement and schema |
|---|---|---|
id | path | Required Models: Id View schema |
X-Dee-Expected-Account-Id | header | Optional Original Dee account ID. Current Dee Cookie or human-authorized native-client Bearer remains the credential; another account returns 409 AccountChanged before reading or writing actor-scoped facts. Same-account new sessions remain compatible. View schema |
Authorization | header | Optional Bearer opaque Dee credential from agent browser authorization. Browser requests continue to use the current Cookie and Origin. View schema |
200 Actor-only original minimal result; no current content accessapplication/jsonModels: AttentionReceipt
{
"$ref": "#/components/schemas/AttentionReceipt"
}400 401 404 409 AccountChanged: the current Cookie belongs to another account; no actor-scoped action was performed.503 /api/attention/summaryAttention summaryOperation: attention_summaryPermalink
Current human-account connector Bearer, or the browser Dee session. Independent Agent Service access is limited to its documented Phase 1 subset. Cookie mutations require the exact application Origin. Bearer requests must omit Cookie; any supplied Origin must match the application. Current resource permissions apply.
| Name | Location | Requirement and schema |
|---|---|---|
X-Dee-Expected-Account-Id | header | Optional Original Dee account ID. Current Dee Cookie or human-authorized native-client Bearer remains the credential; another account returns 409 AccountChanged before reading or writing actor-scoped facts. Same-account new sessions remain compatible. View schema |
Authorization | header | Optional Bearer opaque Dee credential from agent browser authorization. Browser requests continue to use the current Cookie and Origin. View schema |
200 Receiver-only counts after current access filteringapplication/jsonModels: SummaryResponse
{
"$ref": "#/components/schemas/SummaryResponse"
}400 Invalid request or expected account header.401 409 AccountChanged: the current Cookie belongs to another account; no actor-scoped action was performed.503 /api/documents/{id}/attentionMain attentionOperation: main_attentionPermalink
Current human-account connector Bearer, or the browser Dee session. Independent Agent Service access is limited to its documented Phase 1 subset. Cookie mutations require the exact application Origin. Bearer requests must omit Cookie; any supplied Origin must match the application. Current resource permissions apply.
| Name | Location | Requirement and schema |
|---|---|---|
id | path | Required Models: Id View schema |
X-Dee-Expected-Account-Id | header | Optional Original Dee account ID. Current Dee Cookie or human-authorized native-client Bearer remains the credential; another account returns 409 AccountChanged before reading or writing actor-scoped facts. Same-account new sessions remain compatible. View schema |
Authorization | header | Optional Bearer opaque Dee credential from agent browser authorization. Browser requests continue to use the current Cookie and Origin. View schema |
200 Main reading state and current authorized unread counts; no mutation400 401 404 409 AccountChanged: the current Cookie belongs to another account; no actor-scoped action was performed.410 Document is in the trash under current access503 /api/documents/{id}/attention/readMark main readOperation: mark_main_readPermalink
Current human-account connector Bearer, or the browser Dee session. Independent Agent Service access is limited to its documented Phase 1 subset. Cookie mutations require the exact application Origin. Bearer requests must omit Cookie; any supplied Origin must match the application. Current resource permissions apply.
| Name | Location | Requirement and schema |
|---|---|---|
id | path | Required Models: Id View schema |
X-Dee-Expected-Account-Id | header | Optional Original Dee account ID. Current Dee Cookie or human-authorized native-client Bearer remains the credential; another account returns 409 AccountChanged before reading or writing actor-scoped facts. Same-account new sessions remain compatible. View schema |
Authorization | header | Optional Bearer opaque Dee credential from agent browser authorization. Browser requests continue to use the current Cookie and Origin. View schema |
200 Explicit monotone main message read position; independent of notification acknowledgementapplication/jsonModels: AttentionReceipt
{
"$ref": "#/components/schemas/AttentionReceipt"
}400 401 403 404 409 AccountChanged: current Cookie belongs to another account; no actor-scoped action was performed.410 Document is in the trash under current access503 /api/documents/{id}/favoriteGet document favoriteOperation: get_document_favoritePermalink
Current human-account connector Bearer, or the browser Dee session. Independent Agent Service access is limited to its documented Phase 1 subset. Cookie mutations require the exact application Origin. Bearer requests must omit Cookie; any supplied Origin must match the application. Current resource permissions apply.
| Name | Location | Requirement and schema |
|---|---|---|
id | path | Required Models: Id View schema |
X-Dee-Expected-Account-Id | header | Optional Original Dee account ID. Current Dee Cookie or human-authorized native-client Bearer remains the credential; another account returns 409 AccountChanged before reading or writing actor-scoped facts. Same-account new sessions remain compatible. View schema |
Authorization | header | Optional Bearer opaque Dee credential from agent browser authorization. Browser requests continue to use the current Cookie and Origin. View schema |
200 The current account's document favorite; no reading side effectsapplication/jsonModels: FavoriteResponse
{
"$ref": "#/components/schemas/FavoriteResponse"
}400 401 404 409 AccountChanged: the current Cookie belongs to another account; no actor-scoped action was performed.410 503 /api/documents/{id}/favoriteSet document favoriteOperation: set_document_favoritePermalink
Current human-account connector Bearer, or the browser Dee session. Independent Agent Service access is limited to its documented Phase 1 subset. Cookie mutations require the exact application Origin. Bearer requests must omit Cookie; any supplied Origin must match the application. Current resource permissions apply.
| Name | Location | Requirement and schema |
|---|---|---|
id | path | Required Models: Id View schema |
X-Dee-Expected-Account-Id | header | Optional Original Dee account ID. Current Dee Cookie or human-authorized native-client Bearer remains the credential; another account returns 409 AccountChanged before reading or writing actor-scoped facts. Same-account new sessions remain compatible. View schema |
Authorization | header | Optional Bearer opaque Dee credential from agent browser authorization. Browser requests continue to use the current Cookie and Origin. View schema |
application/jsonModels: FavoriteRequest
{
"$ref": "#/components/schemas/FavoriteRequest"
}200 Original account-only favorite result; explicit set, without CAS or discussion effectsapplication/jsonModels: AttentionReceipt
{
"$ref": "#/components/schemas/AttentionReceipt"
}400 401 403 404 409 AccountChanged: current Cookie belongs to another account; no actor-scoped action was performed.410 503 /api/documents/{id}/threads/{thread_id}/attentionThread attentionOperation: thread_attentionPermalink
Current human-account connector Bearer, or the browser Dee session. Independent Agent Service access is limited to its documented Phase 1 subset. Cookie mutations require the exact application Origin. Bearer requests must omit Cookie; any supplied Origin must match the application. Current resource permissions apply.
| Name | Location | Requirement and schema |
|---|---|---|
id | path | Required Models: Id View schema |
thread_id | path | Required A main message's stable root identity, including before its first reply Models: Id View schema |
X-Dee-Expected-Account-Id | header | Optional Original Dee account ID. Current Dee Cookie or human-authorized native-client Bearer remains the credential; another account returns 409 AccountChanged before reading or writing actor-scoped facts. Same-account new sessions remain compatible. View schema |
Authorization | header | Optional Bearer opaque Dee credential from agent browser authorization. Browser requests continue to use the current Cookie and Origin. View schema |
200 Thread preferences and independent reply read state400 401 404 409 AccountChanged: the current Cookie belongs to another account; no actor-scoped action was performed.410 Document is in the trash under current access503 /api/documents/{id}/threads/{thread_id}/attentionSet thread preferencesOperation: set_thread_preferencesPermalink
Current human-account connector Bearer, or the browser Dee session. Independent Agent Service access is limited to its documented Phase 1 subset. Cookie mutations require the exact application Origin. Bearer requests must omit Cookie; any supplied Origin must match the application. Current resource permissions apply.
| Name | Location | Requirement and schema |
|---|---|---|
id | path | Required Models: Id View schema |
thread_id | path | Required Models: Id View schema |
X-Dee-Expected-Account-Id | header | Optional Original Dee account ID. Current Dee Cookie or human-authorized native-client Bearer remains the credential; another account returns 409 AccountChanged before reading or writing actor-scoped facts. Same-account new sessions remain compatible. View schema |
Authorization | header | Optional Bearer opaque Dee credential from agent browser authorization. Browser requests continue to use the current Cookie and Origin. View schema |
application/jsonModels: PreferencesRequest
{
"$ref": "#/components/schemas/PreferencesRequest"
}200 Original preference result; zero baseline for default stateapplication/jsonModels: AttentionReceipt
{
"$ref": "#/components/schemas/AttentionReceipt"
}400 401 403 404 409 AccountChanged: current Cookie belongs to another account; no actor-scoped action was performed.410 Document is in the trash under current access503 /api/documents/{id}/threads/{thread_id}/attention/readMark thread readOperation: mark_thread_readPermalink
Current human-account connector Bearer, or the browser Dee session. Independent Agent Service access is limited to its documented Phase 1 subset. Cookie mutations require the exact application Origin. Bearer requests must omit Cookie; any supplied Origin must match the application. Current resource permissions apply.
| Name | Location | Requirement and schema |
|---|---|---|
id | path | Required Models: Id View schema |
thread_id | path | Required Models: Id View schema |
X-Dee-Expected-Account-Id | header | Optional Original Dee account ID. Current Dee Cookie or human-authorized native-client Bearer remains the credential; another account returns 409 AccountChanged before reading or writing actor-scoped facts. Same-account new sessions remain compatible. View schema |
Authorization | header | Optional Bearer opaque Dee credential from agent browser authorization. Browser requests continue to use the current Cookie and Origin. View schema |
200 Explicit monotone reply read position; main root has a separate reading scopeapplication/jsonModels: AttentionReceipt
{
"$ref": "#/components/schemas/AttentionReceipt"
}400 401 403 404 409 AccountChanged: current Cookie belongs to another account; no actor-scoped action was performed.410 Document is in the trash under current access503 /api/favoritesList favorite documentsOperation: list_favorite_documentsPermalink
Current human-account connector Bearer, or the browser Dee session. Independent Agent Service access is limited to its documented Phase 1 subset. Cookie mutations require the exact application Origin. Bearer requests must omit Cookie; any supplied Origin must match the application. Current resource permissions apply.
| Name | Location | Requirement and schema |
|---|---|---|
space_id | query | Optional Optional current member Space; omission aggregates all readable sources Models: Id View schema |
title | query | OptionalView schema |
page_index | query | OptionalView schema |
page_size | query | OptionalView schema |
order_by | query | Optional Same document ordering fields; default favorited_at.desc,id.asc View schema |
X-Dee-Expected-Account-Id | header | Optional Original Dee account ID. Current Dee Cookie or human-authorized native-client Bearer remains the credential; another account returns 409 AccountChanged before reading or writing actor-scoped facts. Same-account new sessions remain compatible. View schema |
Authorization | header | Optional Bearer opaque Dee credential from agent browser authorization. Browser requests continue to use the current Cookie and Origin. View schema |
200 application/jsonModels: Paged_DocumentSummary
{
"$ref": "#/components/schemas/Paged_DocumentSummary"
}400 401 404 409 AccountChanged: the current Cookie belongs to another account; no actor-scoped action was performed.503 Review current management conditions and move or restore documents without changing their identity.
/api/documents/lifecycle/operations/{operation_id}Get document lifecycle operationOperation: get_document_lifecycle_operationPermalink
Current human-account connector Bearer, or the browser Dee session. Independent Agent Service access is limited to its documented Phase 1 subset. Cookie mutations require the exact application Origin. Bearer requests must omit Cookie; any supplied Origin must match the application. Current resource permissions apply.
| Name | Location | Requirement and schema |
|---|---|---|
operation_id | path | Required Models: Id View schema |
X-Dee-Expected-Account-Id | header | Optional Original Dee account ID. Current Dee Cookie or human-authorized native-client Bearer remains the credential; another account returns 409 AccountChanged before reading or writing actor-scoped facts. Same-account new sessions remain compatible. View schema |
Authorization | header | Optional Bearer opaque Dee credential from agent browser authorization. Browser requests continue to use the current Cookie and Origin. View schema |
200 Only the actor's original lifecycle result, no current permissionapplication/jsonModels: LifecycleReceipt
{
"$ref": "#/components/schemas/LifecycleReceipt"
}400 Invalid 22-character Base62 ID401 Current session required404 No lifecycle result for this actor409 AccountChanged: the current Cookie belongs to another account; no actor-scoped action was performed.503 Read unavailable/api/documents/trashList document trashOperation: list_document_trashPermalink
Current human-account connector Bearer, or the browser Dee session. Independent Agent Service access is limited to its documented Phase 1 subset. Cookie mutations require the exact application Origin. Bearer requests must omit Cookie; any supplied Origin must match the application. Current resource permissions apply.
| Name | Location | Requirement and schema |
|---|---|---|
scope | query | Optional all (default), mine, collaborating, space View schema |
space_id | query | Optional Only space scope; current membership required Models: Id View schema |
title | query | Optional Literal case-insensitive title substring View schema |
page_index | query | OptionalView schema |
page_size | query | Optional 0 to 100; default 50 View schema |
order_by | query | Optional Comma-separated trashed_at,updated_at,title,id asc/desc; default trashed_at.desc,id.asc View schema |
X-Dee-Expected-Account-Id | header | Optional Original Dee account ID. Current Dee Cookie or human-authorized native-client Bearer remains the credential; another account returns 409 AccountChanged before reading or writing actor-scoped facts. Same-account new sessions remain compatible. View schema |
Authorization | header | Optional Bearer opaque Dee credential from agent browser authorization. Browser requests continue to use the current Cookie and Origin. View schema |
200 Current administrator metadata and filtered counts, without contents or tokensapplication/jsonModels: Paged_TrashSummary
{
"$ref": "#/components/schemas/Paged_TrashSummary"
}400 Invalid filter or pagination401 Current session required404 Space unavailable409 AccountChanged: the current Cookie belongs to another account; no actor-scoped action was performed.503 Read unavailable/api/documents/{id}/lifecycleGet document lifecycleOperation: get_document_lifecyclePermalink
Current human-account connector Bearer, or the browser Dee session. Independent Agent Service access is limited to its documented Phase 1 subset. Cookie mutations require the exact application Origin. Bearer requests must omit Cookie; any supplied Origin must match the application. Current resource permissions apply.
| Name | Location | Requirement and schema |
|---|---|---|
id | path | Required Models: Id View schema |
X-Dee-Expected-Account-Id | header | Optional Original Dee account ID. Current Dee Cookie or human-authorized native-client Bearer remains the credential; another account returns 409 AccountChanged before reading or writing actor-scoped facts. Same-account new sessions remain compatible. View schema |
Authorization | header | Optional Bearer opaque Dee credential from agent browser authorization. Browser requests continue to use the current Cookie and Origin. View schema |
200 Current administrator metadata and comparison token without common contentapplication/jsonModels: LifecycleResponse
{
"$ref": "#/components/schemas/LifecycleResponse"
}400 Invalid 22-character Base62 ID401 Current session required403 Current administrator required404 Document unavailable409 AccountChanged: the current Cookie belongs to another account; no actor-scoped action was performed.503 Read unavailable/api/documents/{id}/restoreRestore documentOperation: restore_documentPermalink
Current human-account connector Bearer, or the browser Dee session. Independent Agent Service access is limited to its documented Phase 1 subset. Cookie mutations require the exact application Origin. Bearer requests must omit Cookie; any supplied Origin must match the application. Current resource permissions apply.
| Name | Location | Requirement and schema |
|---|---|---|
id | path | Required Models: Id View schema |
X-Dee-Expected-Account-Id | header | Optional Original Dee account ID. Current Dee Cookie or human-authorized native-client Bearer remains the credential; another account returns 409 AccountChanged before reading or writing actor-scoped facts. Same-account new sessions remain compatible. View schema |
Authorization | header | Optional Bearer opaque Dee credential from agent browser authorization. Browser requests continue to use the current Cookie and Origin. View schema |
application/jsonModels: LifecycleRequest
{
"$ref": "#/components/schemas/LifecycleRequest"
}200 Same Document restored; link joining closed in the same transactionapplication/jsonModels: LifecycleReceipt
{
"$ref": "#/components/schemas/LifecycleReceipt"
}400 Invalid request401 Current session required403 Current administrator or Origin required404 Document unavailable409 Review current impact or original intent conflict AccountChanged: current Cookie belongs to another account; no actor-scoped action was performed.503 Result unconfirmed/api/documents/{id}/trashTrash documentOperation: trash_documentPermalink
Current human-account connector Bearer, or the browser Dee session. Independent Agent Service access is limited to its documented Phase 1 subset. Cookie mutations require the exact application Origin. Bearer requests must omit Cookie; any supplied Origin must match the application. Current resource permissions apply.
| Name | Location | Requirement and schema |
|---|---|---|
id | path | Required Models: Id View schema |
X-Dee-Expected-Account-Id | header | Optional Original Dee account ID. Current Dee Cookie or human-authorized native-client Bearer remains the credential; another account returns 409 AccountChanged before reading or writing actor-scoped facts. Same-account new sessions remain compatible. View schema |
Authorization | header | Optional Bearer opaque Dee credential from agent browser authorization. Browser requests continue to use the current Cookie and Origin. View schema |
application/jsonModels: LifecycleRequest
{
"$ref": "#/components/schemas/LifecycleRequest"
}200 Committed lifecycle result, or original minimal resultapplication/jsonModels: LifecycleReceipt
{
"$ref": "#/components/schemas/LifecycleReceipt"
}400 Invalid request401 Current session required403 Current administrator or Origin required404 Document unavailable409 Management facts or original intent changed AccountChanged: current Cookie belongs to another account; no actor-scoped action was performed.503 Result unconfirmedDistinguish process health, dependency readiness, and the running version.
/healthHealthOperation: healthPermalink
Public endpoint; readiness or recovery conditions can still affect availability.
200 The HTTP process is alive; no dependency check.x-request-id{
"type": "string"
}/readyReadyOperation: readyPermalink
Public endpoint; readiness or recovery conditions can still affect availability.
200 PostgreSQL and storage are available, recovery opening control is verified, and document links initialization is complete.x-request-id{
"type": "string"
}503 A dependency or recovery opening control is unavailable. data.dependencies lists safe component statuses.x-request-id{
"type": "string"
}/versionVersionOperation: versionPermalink
Public endpoint; readiness or recovery conditions can still affect availability.
200 Version and build commitapplication/jsonModels: VersionResponse
{
"$ref": "#/components/schemas/VersionResponse"
}HTTP operations from the current OpenAPI contract.
/agent/login/approveApprove agent loginOperation: approve_agent_loginPermalink
Current browser Cookie and exact application Origin. Only the personal owner or Space administrator may approve an independent Agent connection. An opaque Bearer cannot approve a connection. X-Dee-Expected-Account-Id pins the human.
application/jsonModels: AgentLoginApproveRequest
{
"$ref": "#/components/schemas/AgentLoginApproveRequest"
}204 The browser decision was recorded./agent/login/pollPoll agent loginOperation: poll_agent_loginPermalink
Prove possession of this request’s original device_secret in the JSON body.
application/jsonModels: AgentLoginPollRequest
{
"$ref": "#/components/schemas/AgentLoginPollRequest"
}200 application/jsonModels: AgentLoginPollResponse
{
"$ref": "#/components/schemas/AgentLoginPollResponse"
}/agent/login/startStart agent loginOperation: start_agent_loginPermalink
No existing Dee credential is required to begin a request. This does not authorize access.
application/jsonModels: AgentLoginStartRequest
{
"$ref": "#/components/schemas/AgentLoginStartRequest"
}200 application/jsonModels: AgentLoginStartResponse
{
"$ref": "#/components/schemas/AgentLoginStartResponse"
}HTTP operations from the current OpenAPI contract.
/api/agent-documentsCreate agent documentOperation: create_agent_documentPermalink
Current human-account connector Bearer, or the browser Dee session. Independent Agent Service access is limited to its documented Phase 1 subset. Cookie mutations require the exact application Origin. Bearer requests must omit Cookie; any supplied Origin must match the application. Current resource permissions apply.
| Name | Location | Requirement and schema |
|---|---|---|
X-Dee-Expected-Account-Id | header | Optional Original Dee account ID. Current Dee Cookie or human-authorized native-client Bearer remains the credential; another account returns 409 AccountChanged before reading or writing actor-scoped facts. Same-account new sessions remain compatible. View schema |
Authorization | header | Optional Bearer opaque Dee credential from agent browser authorization. Browser requests continue to use the current Cookie and Origin. View schema |
application/jsonModels: CreateAgentDocumentRequest
{
"$ref": "#/components/schemas/CreateAgentDocumentRequest"
}201 Agent main document and configuration committed at the explicit location; Pages are created as neededapplication/jsonModels: AgentDocumentReceipt
{
"$ref": "#/components/schemas/AgentDocumentReceipt"
}400 Invalid input or parent location401 Current session required403 Space administrator required404 Origin or parent unavailable409 Original operation input conflict AccountChanged: current Cookie belongs to another account; no actor-scoped action was performed.503 Result unconfirmed/api/agent-documents/operations/{operation_id}Get agent document operationOperation: get_agent_document_operationPermalink
Current human-account connector Bearer, or the browser Dee session. Independent Agent Service access is limited to its documented Phase 1 subset. Cookie mutations require the exact application Origin. Bearer requests must omit Cookie; any supplied Origin must match the application. Current resource permissions apply.
| Name | Location | Requirement and schema |
|---|---|---|
operation_id | path | Required Models: Id View schema |
X-Dee-Expected-Account-Id | header | Optional Original Dee account ID. Current Dee Cookie or human-authorized native-client Bearer remains the credential; another account returns 409 AccountChanged before reading or writing actor-scoped facts. Same-account new sessions remain compatible. View schema |
Authorization | header | Optional Bearer opaque Dee credential from agent browser authorization. Browser requests continue to use the current Cookie and Origin. View schema |
200 Only this actor's original minimal initialization or related-document receiptapplication/jsonModels: AgentDocumentOperationReceipt
{
"$ref": "#/components/schemas/AgentDocumentOperationReceipt"
}400 Invalid request or expected account header.401 Current session required404 No result for this actor409 AccountChanged: the current Cookie belongs to another account; no actor-scoped action was performed.503 Read unavailable/api/agent-documents/{id}Get agent documentOperation: get_agent_documentPermalink
Current human-account connector Bearer, or the browser Dee session. Independent Agent Service access is limited to its documented Phase 1 subset. Cookie mutations require the exact application Origin. Bearer requests must omit Cookie; any supplied Origin must match the application. Current resource permissions apply.
| Name | Location | Requirement and schema |
|---|---|---|
id | path | Required Models: Id View schema |
X-Dee-Expected-Account-Id | header | Optional Original Dee account ID. Current Dee Cookie or human-authorized native-client Bearer remains the credential; another account returns 409 AccountChanged before reading or writing actor-scoped facts. Same-account new sessions remain compatible. View schema |
Authorization | header | Optional Bearer opaque Dee credential from agent browser authorization. Browser requests continue to use the current Cookie and Origin. View schema |
200 Current readable Agent document associations and management qualificationapplication/jsonModels: AgentDocumentDetail
{
"$ref": "#/components/schemas/AgentDocumentDetail"
}400 Invalid identity401 Current session required404 Agent document unavailable409 AccountChanged: the current Cookie belongs to another account; no actor-scoped action was performed.410 Agent document in trash503 Read unavailableHTTP operations from the current OpenAPI contract.
/api/agent/connectionsAgent connectionsOperation: agent_connectionsPermalink
Current browser Dee session Cookie only. Authorization headers, including opaque Dee Bearers, are rejected. This read does not require an Origin header. The optional X-Dee-Expected-Account-Id pins the current account.
| Name | Location | Requirement and schema |
|---|---|---|
page_index | query | OptionalView schema |
page_size | query | OptionalView schema |
order_by | query | Optional Comma-separated id, authorized_at or last_used_at with .asc/.desc; default authorized_at.desc,id.asc View schema |
X-Dee-Expected-Account-Id | header | Optional Original Dee account ID. The current browser Dee session Cookie remains the credential; another account returns 409 AccountChanged before reading or writing actor-scoped facts. Same-account new sessions remain compatible. View schema |
200 Current account's safe Agent connection metadata; browser session requiredapplication/jsonModels: AgentConnectionsResponse
{
"$ref": "#/components/schemas/AgentConnectionsResponse"
}400 Invalid page or ordering401 Current browser session required409 AccountChanged: the current Cookie belongs to another account; no actor-scoped action was performed.503 Identity storage unavailable/api/agent/connectionsRevoke agent connectionsOperation: revoke_agent_connectionsPermalink
Current browser Dee session Cookie only. Authorization headers, including opaque Dee Bearers, are rejected. Revocation requires the exact application Origin. The optional X-Dee-Expected-Account-Id pins the current account.
| Name | Location | Requirement and schema |
|---|---|---|
X-Dee-Expected-Account-Id | header | Optional Original Dee account ID. The current browser Dee session Cookie remains the credential; another account returns 409 AccountChanged before reading or writing actor-scoped facts. Same-account new sessions remain compatible. View schema |
application/jsonModels: RevokeConnectionsRequest
{
"$ref": "#/components/schemas/RevokeConnectionsRequest"
}204 Reviewed Agent generation revoked, including legacy clients. Retries preserve newer grants and browser sessions.400 Invalid generation401 Current browser session required409 Connection generation unavailable; reload the list AccountChanged: current Cookie belongs to another account; no actor-scoped action was performed.503 Revocation was not confirmed/api/agent/connections/{id}Revoke agent connectionOperation: revoke_agent_connectionPermalink
Current browser Dee session Cookie only. Authorization headers, including opaque Dee Bearers, are rejected. Revocation requires the exact application Origin. The optional X-Dee-Expected-Account-Id pins the current account.
| Name | Location | Requirement and schema |
|---|---|---|
id | path | Required Models: Id View schema |
X-Dee-Expected-Account-Id | header | Optional Original Dee account ID. The current browser Dee session Cookie remains the credential; another account returns 409 AccountChanged before reading or writing actor-scoped facts. Same-account new sessions remain compatible. View schema |
204 Owned client revoked; already-revoked owned connections are idempotent400 Invalid request or expected account header.401 Current browser session required404 Client unavailable to this account409 AccountChanged: the current Cookie belongs to another account; no actor-scoped action was performed.503 Revocation was not confirmedHTTP operations from the current OpenAPI contract.
/api/agents/meGet agent meOperation: get_agent_mePermalink
Independent Agent opaque Bearer with X-Dee-Expected-Agent-Id. No browser Cookie. The authenticated Agent, current scope, resource permissions, and work conditions determine access.
| Name | Location | Requirement and schema |
|---|---|---|
X-Dee-Expected-Account-Id | header | Optional Original Dee account ID. Current Dee Cookie or human-authorized native-client Bearer remains the credential; another account returns 409 AccountChanged before reading or writing actor-scoped facts. Same-account new sessions remain compatible. View schema |
X-Dee-Expected-Agent-Id | header | Optional Required for independent Agent requests; omitted for human requests. Send the original Agent ID with the Agent connection Bearer; a different Agent returns 409 AgentChanged. Do not combine with X-Dee-Expected-Account-Id. View schema |
Authorization | header | Optional Bearer opaque Dee credential from agent browser authorization. Browser requests continue to use the current Cookie and Origin. View schema |
200 400 Invalid request or expected account header.401 409 AccountChanged: the current Cookie belongs to another account; no actor-scoped action was performed./api/agents/me/documentsList agent documentsOperation: list_agent_documentsPermalink
Independent Agent opaque Bearer with X-Dee-Expected-Agent-Id. No browser Cookie. The authenticated Agent, current scope, resource permissions, and work conditions determine access.
| Name | Location | Requirement and schema |
|---|---|---|
X-Dee-Expected-Account-Id | header | Optional Original Dee account ID. Current Dee Cookie or human-authorized native-client Bearer remains the credential; another account returns 409 AccountChanged before reading or writing actor-scoped facts. Same-account new sessions remain compatible. View schema |
X-Dee-Expected-Agent-Id | header | Optional Required for independent Agent requests; omitted for human requests. Send the original Agent ID with the Agent connection Bearer; a different Agent returns 409 AgentChanged. Do not combine with X-Dee-Expected-Account-Id. View schema |
Authorization | header | Optional Bearer opaque Dee credential from agent browser authorization. Browser requests continue to use the current Cookie and Origin. View schema |
200 application/jsonModels: Paged_DocumentSummary
{
"$ref": "#/components/schemas/Paged_DocumentSummary"
}400 Invalid request or expected account header.409 AccountChanged: the current Cookie belongs to another account; no actor-scoped action was performed./api/agents/{agent_id}Get agent configurationOperation: get_agent_configurationPermalink
Current authorized browser user or independent Agent Bearer. Bind the original actor with X-Dee-Expected-Account-Id or X-Dee-Expected-Agent-Id respectively. A read is current evidence, not cached authority to execute.
| Name | Location | Requirement and schema |
|---|---|---|
agent_id | path | Required Models: Id View schema |
X-Dee-Expected-Account-Id | header | Optional Original Dee account ID. Current Dee Cookie or human-authorized native-client Bearer remains the credential; another account returns 409 AccountChanged before reading or writing actor-scoped facts. Same-account new sessions remain compatible. View schema |
X-Dee-Expected-Agent-Id | header | Optional Required for independent Agent requests; omitted for human requests. Send the original Agent ID with the Agent connection Bearer; a different Agent returns 409 AgentChanged. Do not combine with X-Dee-Expected-Account-Id. View schema |
Authorization | header | Optional Bearer opaque Dee credential from agent browser authorization. Browser requests continue to use the current Cookie and Origin. View schema |
200 400 Invalid request or expected account header.404 409 AccountChanged: the current Cookie belongs to another account; no actor-scoped action was performed./api/agents/{agent_id}Save agent configurationOperation: save_agent_configurationPermalink
Real browser Dee session only. Current owner/Space administrator manages Agent settings and connections; current document permissions govern decisions and control. Browser mutations require the exact application Origin and X-Dee-Expected-Account-Id pins the human. A tool or service Bearer cannot replace the browser confirmation.
| Name | Location | Requirement and schema |
|---|---|---|
agent_id | path | Required Models: Id View schema |
X-Dee-Expected-Account-Id | header | Optional Original Dee account ID. Current Dee Cookie or human-authorized native-client Bearer remains the credential; another account returns 409 AccountChanged before reading or writing actor-scoped facts. Same-account new sessions remain compatible. View schema |
Authorization | header | Optional Bearer opaque Dee credential from agent browser authorization. Browser requests continue to use the current Cookie and Origin. View schema |
application/jsonModels: AgentConfigurationRequest
{
"$ref": "#/components/schemas/AgentConfigurationRequest"
}200 application/jsonModels: AgentConfigurationReceipt
{
"$ref": "#/components/schemas/AgentConfigurationReceipt"
}400 Invalid request or expected account header.409 AccountChanged: current Cookie belongs to another account; no actor-scoped action was performed./api/agents/{agent_id}/connectionsList agent service connectionsOperation: list_agent_service_connectionsPermalink
Real browser Dee session only. Current owner/Space administrator manages Agent settings and connections; current document permissions govern decisions and control. Browser mutations require the exact application Origin and X-Dee-Expected-Account-Id pins the human. A tool or service Bearer cannot replace the browser confirmation.
| Name | Location | Requirement and schema |
|---|---|---|
agent_id | path | Required Models: Id View schema |
X-Dee-Expected-Account-Id | header | Optional Original Dee account ID. Current Dee Cookie or human-authorized native-client Bearer remains the credential; another account returns 409 AccountChanged before reading or writing actor-scoped facts. Same-account new sessions remain compatible. View schema |
Authorization | header | Optional Bearer opaque Dee credential from agent browser authorization. Browser requests continue to use the current Cookie and Origin. View schema |
200 application/jsonModels: Paged_ServiceConnection
{
"$ref": "#/components/schemas/Paged_ServiceConnection"
}400 Invalid request or expected account header.409 AccountChanged: the current Cookie belongs to another account; no actor-scoped action was performed./api/agents/{agent_id}/connections/{connection_id}Revoke agent service connectionOperation: revoke_agent_service_connectionPermalink
Real browser Dee session only. Current owner/Space administrator manages Agent settings and connections; current document permissions govern decisions and control. Browser mutations require the exact application Origin and X-Dee-Expected-Account-Id pins the human. A tool or service Bearer cannot replace the browser confirmation.
| Name | Location | Requirement and schema |
|---|---|---|
agent_id | path | Required Models: Id View schema |
connection_id | path | Required Models: Id View schema |
X-Dee-Expected-Account-Id | header | Optional Original Dee account ID. Current Dee Cookie or human-authorized native-client Bearer remains the credential; another account returns 409 AccountChanged before reading or writing actor-scoped facts. Same-account new sessions remain compatible. View schema |
Authorization | header | Optional Bearer opaque Dee credential from agent browser authorization. Browser requests continue to use the current Cookie and Origin. View schema |
204 400 Invalid request or expected account header.409 AccountChanged: the current Cookie belongs to another account; no actor-scoped action was performed./api/documents/{document_id}/agentsList document agentsOperation: list_document_agentsPermalink
Current human-account connector Bearer, or the browser Dee session. Independent Agent Service access is limited to its documented Phase 1 subset. Cookie mutations require the exact application Origin. Bearer requests must omit Cookie; any supplied Origin must match the application. Current resource permissions apply.
| Name | Location | Requirement and schema |
|---|---|---|
document_id | path | Required Models: Id View schema |
X-Dee-Expected-Account-Id | header | Optional Original Dee account ID. Current Dee Cookie or human-authorized native-client Bearer remains the credential; another account returns 409 AccountChanged before reading or writing actor-scoped facts. Same-account new sessions remain compatible. View schema |
X-Dee-Expected-Agent-Id | header | Optional Required for independent Agent requests; omitted for human requests. Send the original Agent ID with the Agent connection Bearer; a different Agent returns 409 AgentChanged. Do not combine with X-Dee-Expected-Account-Id. View schema |
Authorization | header | Optional Bearer opaque Dee credential from agent browser authorization. Browser requests continue to use the current Cookie and Origin. View schema |
200 application/jsonModels: Paged_MentionCandidate
{
"$ref": "#/components/schemas/Paged_MentionCandidate"
}400 Invalid request or expected account header.409 AccountChanged: the current Cookie belongs to another account; no actor-scoped action was performed./api/documents/{document_id}/collaborators/agents/{agent_id}Set agent document grantOperation: set_agent_document_grantPermalink
Real browser Dee session only. Current owner/Space administrator manages Agent settings and connections; current document permissions govern decisions and control. Browser mutations require the exact application Origin and X-Dee-Expected-Account-Id pins the human. A tool or service Bearer cannot replace the browser confirmation.
| Name | Location | Requirement and schema |
|---|---|---|
document_id | path | Required Models: Id View schema |
agent_id | path | Required Models: Id View schema |
X-Dee-Expected-Account-Id | header | Optional Original Dee account ID. Current Dee Cookie or human-authorized native-client Bearer remains the credential; another account returns 409 AccountChanged before reading or writing actor-scoped facts. Same-account new sessions remain compatible. View schema |
Authorization | header | Optional Bearer opaque Dee credential from agent browser authorization. Browser requests continue to use the current Cookie and Origin. View schema |
application/jsonModels: AgentGrantRequest
{
"$ref": "#/components/schemas/AgentGrantRequest"
}200 application/jsonModels: AgentGrantReceipt
{
"$ref": "#/components/schemas/AgentGrantReceipt"
}400 Invalid request or expected account header.409 AccountChanged: the current Cookie belongs to another account; no actor-scoped action was performed./api/documents/{document_id}/collaborators/agents/{agent_id}Remove agent document grantOperation: remove_agent_document_grantPermalink
Real browser Dee session only. Current owner/Space administrator manages Agent settings and connections; current document permissions govern decisions and control. Browser mutations require the exact application Origin and X-Dee-Expected-Account-Id pins the human. A tool or service Bearer cannot replace the browser confirmation.
| Name | Location | Requirement and schema |
|---|---|---|
document_id | path | Required Models: Id View schema |
agent_id | path | Required Models: Id View schema |
X-Dee-Expected-Account-Id | header | Optional Original Dee account ID. Current Dee Cookie or human-authorized native-client Bearer remains the credential; another account returns 409 AccountChanged before reading or writing actor-scoped facts. Same-account new sessions remain compatible. View schema |
Authorization | header | Optional Bearer opaque Dee credential from agent browser authorization. Browser requests continue to use the current Cookie and Origin. View schema |
application/jsonModels: RemoveAgentGrantRequest
{
"$ref": "#/components/schemas/RemoveAgentGrantRequest"
}200 application/jsonModels: AgentGrantReceipt
{
"$ref": "#/components/schemas/AgentGrantReceipt"
}400 Invalid request or expected account header.409 AccountChanged: the current Cookie belongs to another account; no actor-scoped action was performed.HTTP operations from the current OpenAPI contract.
/api/agents/me/disclosure-checkCheck agent disclosureOperation: check_agent_disclosurePermalink
Independent Agent opaque Bearer with X-Dee-Expected-Agent-Id. No browser Cookie. The authenticated Agent, current scope, resource permissions, and work conditions determine access.
| Name | Location | Requirement and schema |
|---|---|---|
X-Dee-Expected-Account-Id | header | Optional Original Dee account ID. Current Dee Cookie or human-authorized native-client Bearer remains the credential; another account returns 409 AccountChanged before reading or writing actor-scoped facts. Same-account new sessions remain compatible. View schema |
X-Dee-Expected-Agent-Id | header | Optional Required for independent Agent requests; omitted for human requests. Send the original Agent ID with the Agent connection Bearer; a different Agent returns 409 AgentChanged. Do not combine with X-Dee-Expected-Account-Id. View schema |
Authorization | header | Optional Bearer opaque Dee credential from agent browser authorization. Browser requests continue to use the current Cookie and Origin. View schema |
application/jsonModels: DisclosureCheckRequest
{
"$ref": "#/components/schemas/DisclosureCheckRequest"
}200 Current reader-set relation, not output or write approvalapplication/jsonModels: DisclosureCheckResponse
{
"$ref": "#/components/schemas/DisclosureCheckResponse"
}400 Invalid request or expected account header.404 409 AccountChanged: the current Cookie belongs to another account; no actor-scoped action was performed./api/agents/operations/{operation_id}Get agent protocol operationOperation: get_agent_protocol_operationPermalink
Current authorized browser user or independent Agent Bearer. Bind the original actor with X-Dee-Expected-Account-Id or X-Dee-Expected-Agent-Id respectively. A read is current evidence, not cached authority to execute.
| Name | Location | Requirement and schema |
|---|---|---|
operation_id | path | Required Models: Id View schema |
X-Dee-Expected-Account-Id | header | Optional Original Dee account ID. Current Dee Cookie or human-authorized native-client Bearer remains the credential; another account returns 409 AccountChanged before reading or writing actor-scoped facts. Same-account new sessions remain compatible. View schema |
X-Dee-Expected-Agent-Id | header | Optional Required for independent Agent requests; omitted for human requests. Send the original Agent ID with the Agent connection Bearer; a different Agent returns 409 AgentChanged. Do not combine with X-Dee-Expected-Account-Id. View schema |
Authorization | header | Optional Bearer opaque Dee credential from agent browser authorization. Browser requests continue to use the current Cookie and Origin. View schema |
200 Original actor's minimal receiptapplication/jsonModels: ProtocolOperationResponse
{
"$ref": "#/components/schemas/ProtocolOperationResponse"
}400 Invalid request or expected account header.404 409 AccountChanged: the current Cookie belongs to another account; no actor-scoped action was performed./api/documents/{document_id}/agent-plansSubmit agent planOperation: submit_agent_planPermalink
Independent Agent opaque Bearer with X-Dee-Expected-Agent-Id. No browser Cookie. The authenticated Agent, current scope, resource permissions, and work conditions determine access.
| Name | Location | Requirement and schema |
|---|---|---|
document_id | path | Required Models: Id View schema |
X-Dee-Expected-Account-Id | header | Optional Original Dee account ID. Current Dee Cookie or human-authorized native-client Bearer remains the credential; another account returns 409 AccountChanged before reading or writing actor-scoped facts. Same-account new sessions remain compatible. View schema |
X-Dee-Expected-Agent-Id | header | Optional Required for independent Agent requests; omitted for human requests. Send the original Agent ID with the Agent connection Bearer; a different Agent returns 409 AgentChanged. Do not combine with X-Dee-Expected-Account-Id. View schema |
Authorization | header | Optional Bearer opaque Dee credential from agent browser authorization. Browser requests continue to use the current Cookie and Origin. View schema |
201 Immutable plan and protected discussion record400 Invalid request or expected account header.409 AccountChanged: current Cookie belongs to another account; no actor-scoped action was performed./api/documents/{document_id}/agent-plans/{plan_id}Get agent planOperation: get_agent_planPermalink
Current authorized browser user or independent Agent Bearer. Bind the original actor with X-Dee-Expected-Account-Id or X-Dee-Expected-Agent-Id respectively. A read is current evidence, not cached authority to execute.
| Name | Location | Requirement and schema |
|---|---|---|
document_id | path | Required Models: Id View schema |
plan_id | path | Required Models: Id View schema |
X-Dee-Expected-Account-Id | header | Optional Original Dee account ID. Current Dee Cookie or human-authorized native-client Bearer remains the credential; another account returns 409 AccountChanged before reading or writing actor-scoped facts. Same-account new sessions remain compatible. View schema |
X-Dee-Expected-Agent-Id | header | Optional Required for independent Agent requests; omitted for human requests. Send the original Agent ID with the Agent connection Bearer; a different Agent returns 409 AgentChanged. Do not combine with X-Dee-Expected-Account-Id. View schema |
Authorization | header | Optional Bearer opaque Dee credential from agent browser authorization. Browser requests continue to use the current Cookie and Origin. View schema |
200 Current authorized plan and execution facts400 Invalid request or expected account header.404 409 AccountChanged: the current Cookie belongs to another account; no actor-scoped action was performed./api/documents/{document_id}/agent-plans/{plan_id}/decisionsDecide agent planOperation: decide_agent_planPermalink
Real browser Dee session only. Current owner/Space administrator manages Agent settings and connections; current document permissions govern decisions and control. Browser mutations require the exact application Origin and X-Dee-Expected-Account-Id pins the human. A tool or service Bearer cannot replace the browser confirmation.
| Name | Location | Requirement and schema |
|---|---|---|
document_id | path | Required Models: Id View schema |
plan_id | path | Required Models: Id View schema |
X-Dee-Expected-Account-Id | header | Optional Original Dee account ID. Current Dee Cookie or human-authorized native-client Bearer remains the credential; another account returns 409 AccountChanged before reading or writing actor-scoped facts. Same-account new sessions remain compatible. View schema |
Authorization | header | Optional Bearer opaque Dee credential from agent browser authorization. Browser requests continue to use the current Cookie and Origin. View schema |
application/jsonModels: DecisionRequest
{
"$ref": "#/components/schemas/DecisionRequest"
}201 Browser-human decisionapplication/jsonModels: DecisionReceipt
{
"$ref": "#/components/schemas/DecisionReceipt"
}400 Invalid request or expected account header.409 AccountChanged: current Cookie belongs to another account; no actor-scoped action was performed./api/documents/{document_id}/threads/{root}/agent-controlGet agent controlOperation: get_agent_controlPermalink
Current authorized browser user or independent Agent Bearer. Bind the original actor with X-Dee-Expected-Account-Id or X-Dee-Expected-Agent-Id respectively. A read is current evidence, not cached authority to execute.
| Name | Location | Requirement and schema |
|---|---|---|
document_id | path | Required Models: Id View schema |
root | path | Required Models: Id View schema |
X-Dee-Expected-Account-Id | header | Optional Original Dee account ID. Current Dee Cookie or human-authorized native-client Bearer remains the credential; another account returns 409 AccountChanged before reading or writing actor-scoped facts. Same-account new sessions remain compatible. View schema |
X-Dee-Expected-Agent-Id | header | Optional Required for independent Agent requests; omitted for human requests. Send the original Agent ID with the Agent connection Bearer; a different Agent returns 409 AgentChanged. Do not combine with X-Dee-Expected-Account-Id. View schema |
Authorization | header | Optional Bearer opaque Dee credential from agent browser authorization. Browser requests continue to use the current Cookie and Origin. View schema |
200 Current work control; active does not mean running400 Invalid request or expected account header.409 AccountChanged: the current Cookie belongs to another account; no actor-scoped action was performed./api/documents/{document_id}/threads/{root}/agent-controlSet agent controlOperation: set_agent_controlPermalink
Real browser Dee session only. Current owner/Space administrator manages Agent settings and connections; current document permissions govern decisions and control. Browser mutations require the exact application Origin and X-Dee-Expected-Account-Id pins the human. A tool or service Bearer cannot replace the browser confirmation.
| Name | Location | Requirement and schema |
|---|---|---|
document_id | path | Required Models: Id View schema |
root | path | Required Models: Id View schema |
X-Dee-Expected-Account-Id | header | Optional Original Dee account ID. Current Dee Cookie or human-authorized native-client Bearer remains the credential; another account returns 409 AccountChanged before reading or writing actor-scoped facts. Same-account new sessions remain compatible. View schema |
Authorization | header | Optional Bearer opaque Dee credential from agent browser authorization. Browser requests continue to use the current Cookie and Origin. View schema |
200 Human stop/restart recordedapplication/jsonModels: ControlWriteResponse
{
"$ref": "#/components/schemas/ControlWriteResponse"
}400 Invalid request or expected account header.409 AccountChanged: current Cookie belongs to another account; no actor-scoped action was performed./api/documents/{document_id}/threads/{root}/agent-feedback/{agent_id}Get agent feedbackOperation: get_agent_feedbackPermalink
Current authorized browser user or independent Agent Bearer. Bind the original actor with X-Dee-Expected-Account-Id or X-Dee-Expected-Agent-Id respectively. A read is current evidence, not cached authority to execute.
| Name | Location | Requirement and schema |
|---|---|---|
document_id | path | Required Models: Id View schema |
root | path | Required Models: Id View schema |
agent_id | path | Required Models: Id View schema |
X-Dee-Expected-Account-Id | header | Optional Original Dee account ID. Current Dee Cookie or human-authorized native-client Bearer remains the credential; another account returns 409 AccountChanged before reading or writing actor-scoped facts. Same-account new sessions remain compatible. View schema |
X-Dee-Expected-Agent-Id | header | Optional Required for independent Agent requests; omitted for human requests. Send the original Agent ID with the Agent connection Bearer; a different Agent returns 409 AgentChanged. Do not combine with X-Dee-Expected-Account-Id. View schema |
Authorization | header | Optional Bearer opaque Dee credential from agent browser authorization. Browser requests continue to use the current Cookie and Origin. View schema |
200 Latest received report and current control400 Invalid request or expected account header.409 AccountChanged: the current Cookie belongs to another account; no actor-scoped action was performed./api/documents/{document_id}/threads/{root}/agent-feedback/{agent_id}Report agent feedbackOperation: report_agent_feedbackPermalink
Independent Agent opaque Bearer with X-Dee-Expected-Agent-Id. No browser Cookie. The authenticated Agent, current scope, resource permissions, and work conditions determine access.
| Name | Location | Requirement and schema |
|---|---|---|
document_id | path | Required Models: Id View schema |
root | path | Required Models: Id View schema |
agent_id | path | Required Models: Id View schema |
X-Dee-Expected-Account-Id | header | Optional Original Dee account ID. Current Dee Cookie or human-authorized native-client Bearer remains the credential; another account returns 409 AccountChanged before reading or writing actor-scoped facts. Same-account new sessions remain compatible. View schema |
X-Dee-Expected-Agent-Id | header | Optional Required for independent Agent requests; omitted for human requests. Send the original Agent ID with the Agent connection Bearer; a different Agent returns 409 AgentChanged. Do not combine with X-Dee-Expected-Account-Id. View schema |
Authorization | header | Optional Bearer opaque Dee credential from agent browser authorization. Browser requests continue to use the current Cookie and Origin. View schema |
application/jsonModels: FeedbackRequest
{
"$ref": "#/components/schemas/FeedbackRequest"
}200 New protected factual reportapplication/jsonModels: FeedbackReceipt
{
"$ref": "#/components/schemas/FeedbackReceipt"
}400 Invalid request or expected account header.409 AccountChanged: current Cookie belongs to another account; no actor-scoped action was performed.HTTP operations from the current OpenAPI contract.
/api/documents/page-operations/{operation_id}Get page operationOperation: get_page_operationPermalink
Current human-account connector Bearer, or the browser Dee session. Independent Agent Service access is limited to its documented Phase 1 subset. Cookie mutations require the exact application Origin. Bearer requests must omit Cookie; any supplied Origin must match the application. Current resource permissions apply.
| Name | Location | Requirement and schema |
|---|---|---|
operation_id | path | Required Models: Id View schema |
X-Dee-Expected-Account-Id | header | Optional Original Dee account ID. Current Dee Cookie or human-authorized native-client Bearer remains the credential; another account returns 409 AccountChanged before reading or writing actor-scoped facts. Same-account new sessions remain compatible. View schema |
Authorization | header | Optional Bearer opaque Dee credential from agent browser authorization. Browser requests continue to use the current Cookie and Origin. View schema |
200 400 Invalid request or expected account header.404 409 AccountChanged: the current Cookie belongs to another account; no actor-scoped action was performed.503 /api/documents/{document_id}/pagesList document pagesOperation: list_document_pagesPermalink
Current human-account connector Bearer, or the browser Dee session. Independent Agent Service access is limited to its documented Phase 1 subset. Cookie mutations require the exact application Origin. Bearer requests must omit Cookie; any supplied Origin must match the application. Current resource permissions apply.
| Name | Location | Requirement and schema |
|---|---|---|
document_id | path | Required Models: Id View schema |
state | query | Optional active (default) or deleted; deleted requires edit permission View schema |
page_index | query | OptionalView schema |
page_size | query | Optional 0 to 100; default 50 View schema |
order_by | query | Optional created_at,title,updated_at,id; default created_at.asc,id.asc View schema |
X-Dee-Expected-Account-Id | header | Optional Original Dee account ID. Current Dee Cookie or human-authorized native-client Bearer remains the credential; another account returns 409 AccountChanged before reading or writing actor-scoped facts. Same-account new sessions remain compatible. View schema |
Authorization | header | Optional Bearer opaque Dee credential from agent browser authorization. Browser requests continue to use the current Cookie and Origin. View schema |
200 application/jsonModels: Paged_PageSummary
{
"$ref": "#/components/schemas/Paged_PageSummary"
}400 Invalid request or expected account header.403 404 409 AccountChanged: the current Cookie belongs to another account; no actor-scoped action was performed.410 503 /api/documents/{document_id}/pagesCreate document pageOperation: create_document_pagePermalink
Current human-account connector Bearer, or the browser Dee session. Independent Agent Service access is limited to its documented Phase 1 subset. Cookie mutations require the exact application Origin. Bearer requests must omit Cookie; any supplied Origin must match the application. Current resource permissions apply.
| Name | Location | Requirement and schema |
|---|---|---|
document_id | path | Required Models: Id View schema |
X-Dee-Expected-Account-Id | header | Optional Original Dee account ID. Current Dee Cookie or human-authorized native-client Bearer remains the credential; another account returns 409 AccountChanged before reading or writing actor-scoped facts. Same-account new sessions remain compatible. View schema |
Authorization | header | Optional Bearer opaque Dee credential from agent browser authorization. Browser requests continue to use the current Cookie and Origin. View schema |
application/jsonModels: CreatePageRequest
{
"$ref": "#/components/schemas/CreatePageRequest"
}201 400 403 404 409 AccountChanged: current Cookie belongs to another account; no actor-scoped action was performed.410 503 /api/documents/{document_id}/pages/by-keyFind document page by keyOperation: find_document_page_by_keyPermalink
Current human-account connector Bearer, or the browser Dee session. Independent Agent Service access is limited to its documented Phase 1 subset. Cookie mutations require the exact application Origin. Bearer requests must omit Cookie; any supplied Origin must match the application. Current resource permissions apply.
| Name | Location | Requirement and schema |
|---|---|---|
document_id | path | Required Models: Id View schema |
key | query | Required Exact current key within this Document View schema |
X-Dee-Expected-Account-Id | header | Optional Original Dee account ID. Current Dee Cookie or human-authorized native-client Bearer remains the credential; another account returns 409 AccountChanged before reading or writing actor-scoped facts. Same-account new sessions remain compatible. View schema |
Authorization | header | Optional Bearer opaque Dee credential from agent browser authorization. Browser requests continue to use the current Cookie and Origin. View schema |
200 400 Invalid request or expected account header.404 409 AccountChanged: the current Cookie belongs to another account; no actor-scoped action was performed.410 503 /api/documents/{document_id}/pages/{page_id}Get document pageOperation: get_document_pagePermalink
Current human-account connector Bearer, or the browser Dee session. Independent Agent Service access is limited to its documented Phase 1 subset. Cookie mutations require the exact application Origin. Bearer requests must omit Cookie; any supplied Origin must match the application. Current resource permissions apply.
| Name | Location | Requirement and schema |
|---|---|---|
document_id | path | Required Models: Id View schema |
page_id | path | Required Models: Id View schema |
X-Dee-Expected-Account-Id | header | Optional Original Dee account ID. Current Dee Cookie or human-authorized native-client Bearer remains the credential; another account returns 409 AccountChanged before reading or writing actor-scoped facts. Same-account new sessions remain compatible. View schema |
Authorization | header | Optional Bearer opaque Dee credential from agent browser authorization. Browser requests continue to use the current Cookie and Origin. View schema |
200 400 Invalid request or expected account header.404 409 AccountChanged: the current Cookie belongs to another account; no actor-scoped action was performed.410 503 /api/documents/{document_id}/pages/{page_id}Save document pageOperation: save_document_pagePermalink
Current human-account connector Bearer, or the browser Dee session. Independent Agent Service access is limited to its documented Phase 1 subset. Cookie mutations require the exact application Origin. Bearer requests must omit Cookie; any supplied Origin must match the application. Current resource permissions apply.
| Name | Location | Requirement and schema |
|---|---|---|
document_id | path | Required Models: Id View schema |
page_id | path | Required Models: Id View schema |
X-Dee-Expected-Account-Id | header | Optional Original Dee account ID. Current Dee Cookie or human-authorized native-client Bearer remains the credential; another account returns 409 AccountChanged before reading or writing actor-scoped facts. Same-account new sessions remain compatible. View schema |
Authorization | header | Optional Bearer opaque Dee credential from agent browser authorization. Browser requests continue to use the current Cookie and Origin. View schema |
application/jsonModels: SavePageRequest
{
"$ref": "#/components/schemas/SavePageRequest"
}200 400 403 404 409 AccountChanged: current Cookie belongs to another account; no actor-scoped action was performed.410 503 /api/documents/{document_id}/pages/{page_id}/keySet document page keyOperation: set_document_page_keyPermalink
Current human-account connector Bearer, or the browser Dee session. Independent Agent Service access is limited to its documented Phase 1 subset. Cookie mutations require the exact application Origin. Bearer requests must omit Cookie; any supplied Origin must match the application. Current resource permissions apply.
| Name | Location | Requirement and schema |
|---|---|---|
document_id | path | Required Models: Id View schema |
page_id | path | Required Models: Id View schema |
X-Dee-Expected-Account-Id | header | Optional Original Dee account ID. Current Dee Cookie or human-authorized native-client Bearer remains the credential; another account returns 409 AccountChanged before reading or writing actor-scoped facts. Same-account new sessions remain compatible. View schema |
Authorization | header | Optional Bearer opaque Dee credential from agent browser authorization. Browser requests continue to use the current Cookie and Origin. View schema |
200 400 403 404 409 AccountChanged: current Cookie belongs to another account; no actor-scoped action was performed.410 503 /api/documents/{document_id}/pages/{page_id}/restoreRestore document pageOperation: restore_document_pagePermalink
Current human-account connector Bearer, or the browser Dee session. Independent Agent Service access is limited to its documented Phase 1 subset. Cookie mutations require the exact application Origin. Bearer requests must omit Cookie; any supplied Origin must match the application. Current resource permissions apply.
| Name | Location | Requirement and schema |
|---|---|---|
document_id | path | Required Models: Id View schema |
page_id | path | Required Models: Id View schema |
X-Dee-Expected-Account-Id | header | Optional Original Dee account ID. Current Dee Cookie or human-authorized native-client Bearer remains the credential; another account returns 409 AccountChanged before reading or writing actor-scoped facts. Same-account new sessions remain compatible. View schema |
Authorization | header | Optional Bearer opaque Dee credential from agent browser authorization. Browser requests continue to use the current Cookie and Origin. View schema |
application/jsonModels: PageLifecycleRequest
{
"$ref": "#/components/schemas/PageLifecycleRequest"
}200 400 403 404 409 AccountChanged: current Cookie belongs to another account; no actor-scoped action was performed.410 503 /api/documents/{document_id}/pages/{page_id}/revisionsList page revisionsOperation: list_page_revisionsPermalink
Current human-account connector Bearer, or the browser Dee session. Independent Agent Service access is limited to its documented Phase 1 subset. Cookie mutations require the exact application Origin. Bearer requests must omit Cookie; any supplied Origin must match the application. Current resource permissions apply.
| Name | Location | Requirement and schema |
|---|---|---|
document_id | path | Required Models: Id View schema |
page_id | path | Required Models: Id View schema |
page_index | query | OptionalView schema |
page_size | query | OptionalView schema |
order_by | query | Optional created_at,id; default created_at.desc,id.desc View schema |
X-Dee-Expected-Account-Id | header | Optional Original Dee account ID. Current Dee Cookie or human-authorized native-client Bearer remains the credential; another account returns 409 AccountChanged before reading or writing actor-scoped facts. Same-account new sessions remain compatible. View schema |
Authorization | header | Optional Bearer opaque Dee credential from agent browser authorization. Browser requests continue to use the current Cookie and Origin. View schema |
200 application/jsonModels: PageHistoryResponse
{
"$ref": "#/components/schemas/PageHistoryResponse"
}400 Invalid request or expected account header.404 409 AccountChanged: the current Cookie belongs to another account; no actor-scoped action was performed.410 503 /api/documents/{document_id}/pages/{page_id}/revisions/{revision_id}Get page revisionOperation: get_page_revisionPermalink
Current human-account connector Bearer, or the browser Dee session. Independent Agent Service access is limited to its documented Phase 1 subset. Cookie mutations require the exact application Origin. Bearer requests must omit Cookie; any supplied Origin must match the application. Current resource permissions apply.
| Name | Location | Requirement and schema |
|---|---|---|
document_id | path | Required Models: Id View schema |
page_id | path | Required Models: Id View schema |
revision_id | path | Required Models: Id View schema |
X-Dee-Expected-Account-Id | header | Optional Original Dee account ID. Current Dee Cookie or human-authorized native-client Bearer remains the credential; another account returns 409 AccountChanged before reading or writing actor-scoped facts. Same-account new sessions remain compatible. View schema |
Authorization | header | Optional Bearer opaque Dee credential from agent browser authorization. Browser requests continue to use the current Cookie and Origin. View schema |
200 application/jsonModels: PageRevisionResponse
{
"$ref": "#/components/schemas/PageRevisionResponse"
}400 Invalid request or expected account header.404 409 AccountChanged: the current Cookie belongs to another account; no actor-scoped action was performed.410 503 /api/documents/{document_id}/pages/{page_id}/trashTrash document pageOperation: trash_document_pagePermalink
Current human-account connector Bearer, or the browser Dee session. Independent Agent Service access is limited to its documented Phase 1 subset. Cookie mutations require the exact application Origin. Bearer requests must omit Cookie; any supplied Origin must match the application. Current resource permissions apply.
| Name | Location | Requirement and schema |
|---|---|---|
document_id | path | Required Models: Id View schema |
page_id | path | Required Models: Id View schema |
X-Dee-Expected-Account-Id | header | Optional Original Dee account ID. Current Dee Cookie or human-authorized native-client Bearer remains the credential; another account returns 409 AccountChanged before reading or writing actor-scoped facts. Same-account new sessions remain compatible. View schema |
Authorization | header | Optional Bearer opaque Dee credential from agent browser authorization. Browser requests continue to use the current Cookie and Origin. View schema |
application/jsonModels: PageLifecycleRequest
{
"$ref": "#/components/schemas/PageLifecycleRequest"
}200 400 403 404 409 AccountChanged: current Cookie belongs to another account; no actor-scoped action was performed.410 503 HTTP operations from the current OpenAPI contract.
/api/documents/pin-operations/{operation_id}Get document pin operationOperation: get_document_pin_operationPermalink
Current human-account connector Bearer, or the browser Dee session. Independent Agent Service access is limited to its documented Phase 1 subset. Cookie mutations require the exact application Origin. Bearer requests must omit Cookie; any supplied Origin must match the application. Current resource permissions apply.
| Name | Location | Requirement and schema |
|---|---|---|
operation_id | path | Required Models: Id View schema |
X-Dee-Expected-Account-Id | header | Optional Original Dee account ID. Current Dee Cookie or human-authorized native-client Bearer remains the credential; another account returns 409 AccountChanged before reading or writing actor-scoped facts. Same-account new sessions remain compatible. View schema |
Authorization | header | Optional Bearer opaque Dee credential from agent browser authorization. Browser requests continue to use the current Cookie and Origin. View schema |
200 This actor's minimal original pin result; grants no current document access400 401 404 409 AccountChanged: the current Cookie belongs to another account; no actor-scoped action was performed.503 /api/documents/{id}/pinGet document pinOperation: get_document_pinPermalink
Current human-account connector Bearer, or the browser Dee session. Independent Agent Service access is limited to its documented Phase 1 subset. Cookie mutations require the exact application Origin. Bearer requests must omit Cookie; any supplied Origin must match the application. Current resource permissions apply.
| Name | Location | Requirement and schema |
|---|---|---|
id | path | Required Models: Id View schema |
X-Dee-Expected-Account-Id | header | Optional Original Dee account ID. Current Dee Cookie or human-authorized native-client Bearer remains the credential; another account returns 409 AccountChanged before reading or writing actor-scoped facts. Same-account new sessions remain compatible. View schema |
Authorization | header | Optional Bearer opaque Dee credential from agent browser authorization. Browser requests continue to use the current Cookie and Origin. View schema |
200 Origin-owned pin state and current permission, without reading side effects400 401 404 409 AccountChanged: the current Cookie belongs to another account; no actor-scoped action was performed.410 503 /api/documents/{id}/pinSet document pinOperation: set_document_pinPermalink
Current human-account connector Bearer, or the browser Dee session. Independent Agent Service access is limited to its documented Phase 1 subset. Cookie mutations require the exact application Origin. Bearer requests must omit Cookie; any supplied Origin must match the application. Current resource permissions apply.
| Name | Location | Requirement and schema |
|---|---|---|
id | path | Required Models: Id View schema |
X-Dee-Expected-Account-Id | header | Optional Original Dee account ID. Current Dee Cookie or human-authorized native-client Bearer remains the credential; another account returns 409 AccountChanged before reading or writing actor-scoped facts. Same-account new sessions remain compatible. View schema |
Authorization | header | Optional Bearer opaque Dee credential from agent browser authorization. Browser requests continue to use the current Cookie and Origin. View schema |
200 Original explicit pin result; personal holder or Space administrator required for a new operation400 401 403 404 409 AccountChanged: current Cookie belongs to another account; no actor-scoped action was performed.410 503 HTTP operations from the current OpenAPI contract.
/api/documents/treeGet personal document treeOperation: get_personal_document_treePermalink
Current human-account connector Bearer, or the browser Dee session. Independent Agent Service access is limited to its documented Phase 1 subset. Cookie mutations require the exact application Origin. Bearer requests must omit Cookie; any supplied Origin must match the application. Current resource permissions apply.
| Name | Location | Requirement and schema |
|---|---|---|
page_index | query | OptionalView schema |
page_size | query | Optional 0 to 100; default 50 View schema |
order_by | query | Optional position,title,id; default position.asc,id.asc View schema |
X-Dee-Expected-Account-Id | header | Optional Original Dee account ID. Current Dee Cookie or human-authorized native-client Bearer remains the credential; another account returns 409 AccountChanged before reading or writing actor-scoped facts. Same-account new sessions remain compatible. View schema |
Authorization | header | Optional Bearer opaque Dee credential from agent browser authorization. Browser requests continue to use the current Cookie and Origin. View schema |
200 This account's active document nodes and structure versionapplication/jsonModels: PersonalDocumentTree
{
"$ref": "#/components/schemas/PersonalDocumentTree"
}400 Invalid pagination401 Current identity required409 AccountChanged: the current Cookie belongs to another account; no actor-scoped action was performed.503 Read unavailable/api/documents/tree-operations/{operation_id}Get document tree operationOperation: get_document_tree_operationPermalink
Current human-account connector Bearer, or the browser Dee session. Independent Agent Service access is limited to its documented Phase 1 subset. Cookie mutations require the exact application Origin. Bearer requests must omit Cookie; any supplied Origin must match the application. Current resource permissions apply.
| Name | Location | Requirement and schema |
|---|---|---|
operation_id | path | Required Models: Id View schema |
X-Dee-Expected-Account-Id | header | Optional Original Dee account ID. Current Dee Cookie or human-authorized native-client Bearer remains the credential; another account returns 409 AccountChanged before reading or writing actor-scoped facts. Same-account new sessions remain compatible. View schema |
Authorization | header | Optional Bearer opaque Dee credential from agent browser authorization. Browser requests continue to use the current Cookie and Origin. View schema |
200 Only this actor's original minimal placement receiptapplication/jsonModels: TreeMoveReceipt
{
"$ref": "#/components/schemas/TreeMoveReceipt"
}400 Invalid request or expected account header.401 Current identity required404 No result for this actor409 AccountChanged: the current Cookie belongs to another account; no actor-scoped action was performed.503 Read unavailable/api/documents/{id}/moveMove documentOperation: move_documentPermalink
Current human-account connector Bearer, or the browser Dee session. Independent Agent Service access is limited to its documented Phase 1 subset. Cookie mutations require the exact application Origin. Bearer requests must omit Cookie; any supplied Origin must match the application. Current resource permissions apply.
| Name | Location | Requirement and schema |
|---|---|---|
id | path | Required Models: Id View schema |
X-Dee-Expected-Account-Id | header | Optional Original Dee account ID. Current Dee Cookie or human-authorized native-client Bearer remains the credential; another account returns 409 AccountChanged before reading or writing actor-scoped facts. Same-account new sessions remain compatible. View schema |
Authorization | header | Optional Bearer opaque Dee credential from agent browser authorization. Browser requests continue to use the current Cookie and Origin. View schema |
application/jsonModels: MoveDocumentRequest
{
"$ref": "#/components/schemas/MoveDocumentRequest"
}200 Committed placement or original exact retry receiptapplication/jsonModels: TreeMoveReceipt
{
"$ref": "#/components/schemas/TreeMoveReceipt"
}400 Invalid parent or cycle401 Current identity required404 Origin authority or document unavailable409 Structure or operation conflict AccountChanged: current Cookie belongs to another account; no actor-scoped action was performed.410 Document in trash503 Result unconfirmed/api/spaces/{id}/treeGet space document treeOperation: get_space_document_treePermalink
Current human-account connector Bearer, or the browser Dee session. Independent Agent Service access is limited to its documented Phase 1 subset. Cookie mutations require the exact application Origin. Bearer requests must omit Cookie; any supplied Origin must match the application. Current resource permissions apply.
| Name | Location | Requirement and schema |
|---|---|---|
id | path | Required Models: Id View schema |
page_index | query | OptionalView schema |
page_size | query | Optional 0 to 100; default 50 View schema |
order_by | query | Optional position,title,id; default position.asc,id.asc View schema |
X-Dee-Expected-Account-Id | header | Optional Original Dee account ID. Current Dee Cookie or human-authorized native-client Bearer remains the credential; another account returns 409 AccountChanged before reading or writing actor-scoped facts. Same-account new sessions remain compatible. View schema |
Authorization | header | Optional Bearer opaque Dee credential from agent browser authorization. Browser requests continue to use the current Cookie and Origin. View schema |
200 Active document nodes and structure version in one Space-member snapshotapplication/jsonModels: SpaceDocumentTree
{
"$ref": "#/components/schemas/SpaceDocumentTree"
}400 Invalid pagination401 Current identity required404 Space membership unavailable409 AccountChanged: the current Cookie belongs to another account; no actor-scoped action was performed.503 Read unavailableHTTP operations from the current OpenAPI contract.
/api/documents/{id}/attachmentsList document attachmentsOperation: list_document_attachmentsPermalink
Current human-account connector Bearer, or the browser Dee session. Independent Agent Service access is limited to its documented Phase 1 subset. Cookie mutations require the exact application Origin. Bearer requests must omit Cookie; any supplied Origin must match the application. Current resource permissions apply.
| Name | Location | Requirement and schema |
|---|---|---|
id | path | Required Models: Id View schema |
scope | query | Optional body (default), main, or thread; thread includes root and replies View schema |
revision_id | query | Optional Only body; omission selects the current Revision Models: Id View schema |
thread_id | query | Optional Required root message identity only with scope=thread Models: Id View schema |
page_index | query | Optional Zero-based safe integer, default 0 View schema |
page_size | query | Optional 0..100, default 50; zero returns count only View schema |
order_by | query | Optional source_created_at/source_id/resource_id with .asc/.desc; unique source/resource ties are appended View schema |
X-Dee-Expected-Account-Id | header | Optional Original Dee account ID. Current Dee Cookie or human-authorized native-client Bearer remains the credential; another account returns 409 AccountChanged before reading or writing actor-scoped facts. Same-account new sessions remain compatible. View schema |
Authorization | header | Optional Bearer opaque Dee credential from agent browser authorization. Browser requests continue to use the current Cookie and Origin. View schema |
200 Selected attachment references and object-level sources under current document access400 Invalid target, scope, selectors or pagination401 Current identity required404 Document or selected source unavailable409 AccountChanged: the current Cookie belongs to another account; no actor-scoped action was performed.410 Document is in trash under current access503 Read unavailableHTTP operations from the current OpenAPI contract.
/api/documents/{id}/backlinksList document backlinksOperation: list_document_backlinksPermalink
Current human-account connector Bearer, or the browser Dee session. Independent Agent Service access is limited to its documented Phase 1 subset. Cookie mutations require the exact application Origin. Bearer requests must omit Cookie; any supplied Origin must match the application. Current resource permissions apply.
| Name | Location | Requirement and schema |
|---|---|---|
id | path | Required Models: Id View schema |
page_index | query | OptionalView schema |
page_size | query | Optional 0 to 100; default 50 View schema |
order_by | query | Optional title,updated_at,id asc/desc; default updated_at.desc,id.asc View schema |
X-Dee-Expected-Account-Id | header | Optional Original Dee account ID. Current Dee Cookie or human-authorized native-client Bearer remains the credential; another account returns 409 AccountChanged before reading or writing actor-scoped facts. Same-account new sessions remain compatible. View schema |
Authorization | header | Optional Bearer opaque Dee credential from agent browser authorization. Browser requests continue to use the current Cookie and Origin. View schema |
200 Current visible incoming document relationshipsapplication/jsonModels: DocumentLinkPage
{
"$ref": "#/components/schemas/DocumentLinkPage"
}400 Invalid ID or pagination401 Current identity required404 Anchor unavailable409 AccountChanged: the current Cookie belongs to another account; no actor-scoped action was performed.410 Anchor is in trash503 Read unavailable/api/documents/{id}/linksList document linksOperation: list_document_linksPermalink
Current human-account connector Bearer, or the browser Dee session. Independent Agent Service access is limited to its documented Phase 1 subset. Cookie mutations require the exact application Origin. Bearer requests must omit Cookie; any supplied Origin must match the application. Current resource permissions apply.
| Name | Location | Requirement and schema |
|---|---|---|
id | path | Required Models: Id View schema |
page_index | query | OptionalView schema |
page_size | query | Optional 0 to 100; default 50 View schema |
order_by | query | Optional title,updated_at,id asc/desc; default updated_at.desc,id.asc View schema |
X-Dee-Expected-Account-Id | header | Optional Original Dee account ID. Current Dee Cookie or human-authorized native-client Bearer remains the credential; another account returns 409 AccountChanged before reading or writing actor-scoped facts. Same-account new sessions remain compatible. View schema |
Authorization | header | Optional Bearer opaque Dee credential from agent browser authorization. Browser requests continue to use the current Cookie and Origin. View schema |
200 Current visible outgoing document relationshipsapplication/jsonModels: DocumentLinkPage
{
"$ref": "#/components/schemas/DocumentLinkPage"
}400 Invalid ID or pagination401 Current identity required404 Anchor unavailable409 AccountChanged: the current Cookie belongs to another account; no actor-scoped action was performed.410 Anchor is in trash503 Read unavailableHTTP operations from the current OpenAPI contract.
/api/documents/{id}/entriesList entriesOperation: list_entriesPermalink
Current human-account connector Bearer, or the browser Dee session. Independent Agent Service access is limited to its documented Phase 1 subset. Cookie mutations require the exact application Origin. Bearer requests must omit Cookie; any supplied Origin must match the application. Current resource permissions apply.
| Name | Location | Requirement and schema |
|---|---|---|
id | path | Required Models: Id View schema |
thread_id | query | Optional Models: Id View schema |
read_boundary_entry_id | query | Optional Models: Id View schema |
kind | query | Optional all (default), messages or activities Models: EntryKind View schema |
event_type | query | OptionalView schema |
changed_field | query | OptionalView schema |
page_index | query | OptionalView schema |
page_size | query | OptionalView schema |
order_by | query | OptionalView schema |
X-Dee-Expected-Account-Id | header | Optional Original Dee account ID. Current Dee Cookie or human-authorized native-client Bearer remains the credential; another account returns 409 AccountChanged before reading or writing actor-scoped facts. Same-account new sessions remain compatible. View schema |
X-Dee-Expected-Agent-Id | header | Optional Required for independent Agent requests; omitted for human requests. Send the original Agent ID with the Agent connection Bearer; a different Agent returns 409 AgentChanged. Do not combine with X-Dee-Expected-Account-Id. View schema |
Authorization | header | Optional Bearer opaque Dee credential from agent browser authorization. Browser requests continue to use the current Cookie and Origin. View schema |
200 application/jsonModels: EntryPageResponse
{
"$ref": "#/components/schemas/EntryPageResponse"
}400 401 404 409 AccountChanged: the current Cookie belongs to another account; no actor-scoped action was performed.410 503 /api/documents/{id}/entries/{entry_id}Get entryOperation: get_entryPermalink
Current human-account connector Bearer, or the browser Dee session. Independent Agent Service access is limited to its documented Phase 1 subset. Cookie mutations require the exact application Origin. Bearer requests must omit Cookie; any supplied Origin must match the application. Current resource permissions apply.
| Name | Location | Requirement and schema |
|---|---|---|
id | path | Required Models: Id View schema |
entry_id | path | Required Models: Id View schema |
X-Dee-Expected-Account-Id | header | Optional Original Dee account ID. Current Dee Cookie or human-authorized native-client Bearer remains the credential; another account returns 409 AccountChanged before reading or writing actor-scoped facts. Same-account new sessions remain compatible. View schema |
X-Dee-Expected-Agent-Id | header | Optional Required for independent Agent requests; omitted for human requests. Send the original Agent ID with the Agent connection Bearer; a different Agent returns 409 AgentChanged. Do not combine with X-Dee-Expected-Account-Id. View schema |
Authorization | header | Optional Bearer opaque Dee credential from agent browser authorization. Browser requests continue to use the current Cookie and Origin. View schema |
200 400 Invalid request or expected account header.401 404 409 AccountChanged: the current Cookie belongs to another account; no actor-scoped action was performed.410 503 /api/documents/{id}/entries/{entry_id}/contextGet entry contextOperation: get_entry_contextPermalink
Current human-account connector Bearer, or the browser Dee session. Independent Agent Service access is limited to its documented Phase 1 subset. Cookie mutations require the exact application Origin. Bearer requests must omit Cookie; any supplied Origin must match the application. Current resource permissions apply.
| Name | Location | Requirement and schema |
|---|---|---|
id | path | Required Models: Id View schema |
entry_id | path | Required Models: Id View schema |
before | query | OptionalView schema |
after | query | OptionalView schema |
X-Dee-Expected-Account-Id | header | Optional Original Dee account ID. Current Dee Cookie or human-authorized native-client Bearer remains the credential; another account returns 409 AccountChanged before reading or writing actor-scoped facts. Same-account new sessions remain compatible. View schema |
X-Dee-Expected-Agent-Id | header | Optional Required for independent Agent requests; omitted for human requests. Send the original Agent ID with the Agent connection Bearer; a different Agent returns 409 AgentChanged. Do not combine with X-Dee-Expected-Account-Id. View schema |
Authorization | header | Optional Bearer opaque Dee credential from agent browser authorization. Browser requests continue to use the current Cookie and Origin. View schema |
200 application/jsonModels: EntryContextResponse
{
"$ref": "#/components/schemas/EntryContextResponse"
}400 401 404 409 AccountChanged: the current Cookie belongs to another account; no actor-scoped action was performed.410 503 /api/documents/{id}/entries/{entry_id}/threadGet entry threadOperation: get_entry_threadPermalink
Current human-account connector Bearer, or the browser Dee session. Independent Agent Service access is limited to its documented Phase 1 subset. Cookie mutations require the exact application Origin. Bearer requests must omit Cookie; any supplied Origin must match the application. Current resource permissions apply.
| Name | Location | Requirement and schema |
|---|---|---|
id | path | Required Models: Id View schema |
entry_id | path | Required Models: Id View schema |
X-Dee-Expected-Account-Id | header | Optional Original Dee account ID. Current Dee Cookie or human-authorized native-client Bearer remains the credential; another account returns 409 AccountChanged before reading or writing actor-scoped facts. Same-account new sessions remain compatible. View schema |
X-Dee-Expected-Agent-Id | header | Optional Required for independent Agent requests; omitted for human requests. Send the original Agent ID with the Agent connection Bearer; a different Agent returns 409 AgentChanged. Do not combine with X-Dee-Expected-Account-Id. View schema |
Authorization | header | Optional Bearer opaque Dee credential from agent browser authorization. Browser requests continue to use the current Cookie and Origin. View schema |
200 application/jsonModels: EntryThreadResponse
{
"$ref": "#/components/schemas/EntryThreadResponse"
}400 Invalid request or expected account header.401 404 409 AccountChanged: the current Cookie belongs to another account; no actor-scoped action was performed.410 503 HTTP operations from the current OpenAPI contract.
/api/documents/{id}/revisionsList document revisionsOperation: list_document_revisionsPermalink
Current human-account connector Bearer, or the browser Dee session. Independent Agent Service access is limited to its documented Phase 1 subset. Cookie mutations require the exact application Origin. Bearer requests must omit Cookie; any supplied Origin must match the application. Current resource permissions apply.
| Name | Location | Requirement and schema |
|---|---|---|
id | path | Required Models: Id View schema |
page_index | query | OptionalView schema |
page_size | query | Optional 0 to 100; default 50 View schema |
order_by | query | Optional Comma-separated created_at,id asc/desc; default created_at.desc,id.asc View schema |
X-Dee-Expected-Account-Id | header | Optional Original Dee account ID. Current Dee Cookie or human-authorized native-client Bearer remains the credential; another account returns 409 AccountChanged before reading or writing actor-scoped facts. Same-account new sessions remain compatible. View schema |
Authorization | header | Optional Bearer opaque Dee credential from agent browser authorization. Browser requests continue to use the current Cookie and Origin. View schema |
200 Current authorized revision metadata and current identity from one snapshotapplication/jsonModels: RevisionHistoryResponse
{
"$ref": "#/components/schemas/RevisionHistoryResponse"
}400 Invalid pagination or ID401 Current identity required404 Document unavailable409 AccountChanged: the current Cookie belongs to another account; no actor-scoped action was performed.410 Document is in trash503 Read unavailable/api/documents/{id}/revisions/diffDiff document revisionsOperation: diff_document_revisionsPermalink
Current human-account connector Bearer, or the browser Dee session. Independent Agent Service access is limited to its documented Phase 1 subset. Cookie mutations require the exact application Origin. Bearer requests must omit Cookie; any supplied Origin must match the application. Current resource permissions apply.
| Name | Location | Requirement and schema |
|---|---|---|
id | path | Required Models: Id View schema |
from_revision_id | query | Required Models: Id View schema |
to_revision_id | query | Required Models: Id View schema |
X-Dee-Expected-Account-Id | header | Optional Original Dee account ID. Current Dee Cookie or human-authorized native-client Bearer remains the credential; another account returns 409 AccountChanged before reading or writing actor-scoped facts. Same-account new sessions remain compatible. View schema |
Authorization | header | Optional Bearer opaque Dee credential from agent browser authorization. Browser requests continue to use the current Cookie and Origin. View schema |
200 Complete immutable comparison or an explicit work/output budget resultapplication/jsonModels: RevisionDiffResponse
{
"$ref": "#/components/schemas/RevisionDiffResponse"
}400 Both exact Revision IDs are required401 Current identity required404 Document or Revision unavailable409 AccountChanged: the current Cookie belongs to another account; no actor-scoped action was performed.410 Document is in trash503 Read or execution capacity unavailableHTTP operations from the current OpenAPI contract.
/api/documents/{id}/sourceGet document sourceOperation: get_document_sourcePermalink
Current human-account connector Bearer, or the browser Dee session. Independent Agent Service access is limited to its documented Phase 1 subset. Cookie mutations require the exact application Origin. Bearer requests must omit Cookie; any supplied Origin must match the application. Current resource permissions apply.
| Name | Location | Requirement and schema |
|---|---|---|
id | path | Required Models: Id View schema |
revision_id | query | Optional Models: Id View schema |
view | query | Optional markdown (default) or outline View schema |
start | query | OptionalView schema |
end | query | OptionalView schema |
max_bytes | query | Optional Markdown bytes, 4 to 131072; default 32768 View schema |
page_index | query | OptionalView schema |
page_size | query | Optional Outline only, 0 to 100; default 50 View schema |
order_by | query | Optional Outline only: position.asc View schema |
X-Dee-Expected-Account-Id | header | Optional Original Dee account ID. Current Dee Cookie or human-authorized native-client Bearer remains the credential; another account returns 409 AccountChanged before reading or writing actor-scoped facts. Same-account new sessions remain compatible. View schema |
Authorization | header | Optional Bearer opaque Dee credential from agent browser authorization. Browser requests continue to use the current Cookie and Origin. View schema |
200 Selected immutable source without HTML400 Invalid source view, range or pagination401 Current identity required404 Document or Revision unavailable409 AccountChanged: the current Cookie belongs to another account; no actor-scoped action was performed.410 Document is in trash503 Read unavailableHTTP operations from the current OpenAPI contract.
/api/searchSearch contentOperation: search_contentPermalink
Current browser user, ordinary human-account connector, or independent Agent Bearer. An Agent uses X-Dee-Expected-Agent-Id and current scope permissions; actual document writes additionally require the approved plan or bound-memory authorization. Browser mutations require the exact application Origin.
| Name | Location | Requirement and schema |
|---|---|---|
X-Dee-Expected-Account-Id | header | Optional Original Dee account ID. Current Dee Cookie or human-authorized native-client Bearer remains the credential; another account returns 409 AccountChanged before reading or writing actor-scoped facts. Same-account new sessions remain compatible. View schema |
X-Dee-Expected-Agent-Id | header | Optional Required for independent Agent requests; omitted for human requests. Send the original Agent ID with the Agent connection Bearer; a different Agent returns 409 AgentChanged. Do not combine with X-Dee-Expected-Account-Id. View schema |
Authorization | header | Optional Bearer opaque Dee credential from agent browser authorization. Browser requests continue to use the current Cookie and Origin. View schema |
200 Exact scoped content results and count from one authorized snapshot; read-only and no-storeapplication/jsonModels: Paged_SearchResult
{
"$ref": "#/components/schemas/Paged_SearchResult"
}400 Invalid literal terms, scope, ID, kind, JSON or Pos401 Current session or Agent credential required404 Explicit document or member Space unavailable409 AccountChanged: the current Cookie belongs to another account; no actor-scoped action was performed.410 Explicit authorized document is in the trash503 Search storage or execution budget unavailable; no partial resultsHTTP operations from the current OpenAPI contract.
/api/tasksCreate taskOperation: create_taskPermalink
Current human-account connector Bearer, or the browser Dee session. Independent Agent Service access is limited to its documented Phase 1 subset. Cookie mutations require the exact application Origin. Bearer requests must omit Cookie; any supplied Origin must match the application. Current resource permissions apply.
| Name | Location | Requirement and schema |
|---|---|---|
X-Dee-Expected-Account-Id | header | Optional Original Dee account ID. Current Dee Cookie or human-authorized native-client Bearer remains the credential; another account returns 409 AccountChanged before reading or writing actor-scoped facts. Same-account new sessions remain compatible. View schema |
Authorization | header | Optional Bearer opaque Dee credential from agent browser authorization. Browser requests continue to use the current Cookie and Origin. View schema |
application/jsonModels: CreateTaskRequest
{
"$ref": "#/components/schemas/CreateTaskRequest"
}201 Task source, first versions, creation activity and assignment notification committed together400 401 403 404 409 AccountChanged: current Cookie belongs to another account; no actor-scoped action was performed.410 503 /api/tasks/operations/{operation_id}Get task operationOperation: get_task_operationPermalink
Current human-account connector Bearer, or the browser Dee session. Independent Agent Service access is limited to its documented Phase 1 subset. Cookie mutations require the exact application Origin. Bearer requests must omit Cookie; any supplied Origin must match the application. Current resource permissions apply.
| Name | Location | Requirement and schema |
|---|---|---|
operation_id | path | Required Models: Id View schema |
X-Dee-Expected-Account-Id | header | Optional Original Dee account ID. Current Dee Cookie or human-authorized native-client Bearer remains the credential; another account returns 409 AccountChanged before reading or writing actor-scoped facts. Same-account new sessions remain compatible. View schema |
Authorization | header | Optional Bearer opaque Dee credential from agent browser authorization. Browser requests continue to use the current Cookie and Origin. View schema |
200 Only the authenticated human actor's original minimal Task receipt; does not grant current target access400 Invalid request or expected account header.401 404 409 AccountChanged: the current Cookie belongs to another account; no actor-scoped action was performed.503 /api/tasks/{id}Get taskOperation: get_taskPermalink
Current human-account connector Bearer, or the browser Dee session. Independent Agent Service access is limited to its documented Phase 1 subset. Cookie mutations require the exact application Origin. Bearer requests must omit Cookie; any supplied Origin must match the application. Current resource permissions apply.
| Name | Location | Requirement and schema |
|---|---|---|
id | path | Required Models: Id View schema |
X-Dee-Expected-Account-Id | header | Optional Original Dee account ID. Current Dee Cookie or human-authorized native-client Bearer remains the credential; another account returns 409 AccountChanged before reading or writing actor-scoped facts. Same-account new sessions remain compatible. View schema |
X-Dee-Expected-Agent-Id | header | Optional Required for independent Agent requests; omitted for human requests. Send the original Agent ID with the Agent connection Bearer; a different Agent returns 409 AgentChanged. Do not combine with X-Dee-Expected-Account-Id. View schema |
Authorization | header | Optional Bearer opaque Dee credential from agent browser authorization. Browser requests continue to use the current Cookie and Origin. View schema |
200 Current authorized source, Task fields, three condition identities and newest activity400 401 404 409 AccountChanged: the current Cookie belongs to another account; no actor-scoped action was performed.410 503 /api/tasks/{id}/activitiesList task activitiesOperation: list_task_activitiesPermalink
Current human-account connector Bearer, or the browser Dee session. Independent Agent Service access is limited to its documented Phase 1 subset. Cookie mutations require the exact application Origin. Bearer requests must omit Cookie; any supplied Origin must match the application. Current resource permissions apply.
| Name | Location | Requirement and schema |
|---|---|---|
id | path | Required Models: Id View schema |
page_index | query | OptionalView schema |
page_size | query | OptionalView schema |
order_by | query | Optional created_at or id, comma-separated asc/desc; default created_at.desc,id.asc View schema |
X-Dee-Expected-Account-Id | header | Optional Original Dee account ID. Current Dee Cookie or human-authorized native-client Bearer remains the credential; another account returns 409 AccountChanged before reading or writing actor-scoped facts. Same-account new sessions remain compatible. View schema |
X-Dee-Expected-Agent-Id | header | Optional Required for independent Agent requests; omitted for human requests. Send the original Agent ID with the Agent connection Bearer; a different Agent returns 409 AgentChanged. Do not combine with X-Dee-Expected-Account-Id. View schema |
Authorization | header | Optional Bearer opaque Dee credential from agent browser authorization. Browser requests continue to use the current Cookie and Origin. View schema |
200 One currently authorized Task's activity in an authorized count/page snapshot; each handoff note is bounded to 8192 UTF-8 bytesapplication/jsonModels: Paged_TaskActivity
{
"$ref": "#/components/schemas/Paged_TaskActivity"
}400 401 404 409 AccountChanged: the current Cookie belongs to another account; no actor-scoped action was performed.410 503 /api/tasks/{id}/claimClaim taskOperation: claim_taskPermalink
Current human-account connector Bearer, or the browser Dee session. Independent Agent Service access is limited to its documented Phase 1 subset. Cookie mutations require the exact application Origin. Bearer requests must omit Cookie; any supplied Origin must match the application. Current resource permissions apply.
| Name | Location | Requirement and schema |
|---|---|---|
id | path | Required Models: Id View schema |
X-Dee-Expected-Account-Id | header | Optional Original Dee account ID. Current Dee Cookie or human-authorized native-client Bearer remains the credential; another account returns 409 AccountChanged before reading or writing actor-scoped facts. Same-account new sessions remain compatible. View schema |
Authorization | header | Optional Bearer opaque Dee credential from agent browser authorization. Browser requests continue to use the current Cookie and Origin. View schema |
application/jsonModels: ClaimTaskRequest
{
"$ref": "#/components/schemas/ClaimTaskRequest"
}200 400 401 403 404 409 AccountChanged: current Cookie belongs to another account; no actor-scoped action was performed.410 503 /api/tasks/{id}/descriptionSave task descriptionOperation: save_task_descriptionPermalink
Current human-account connector Bearer, or the browser Dee session. Independent Agent Service access is limited to its documented Phase 1 subset. Cookie mutations require the exact application Origin. Bearer requests must omit Cookie; any supplied Origin must match the application. Current resource permissions apply.
| Name | Location | Requirement and schema |
|---|---|---|
id | path | Required Models: Id View schema |
X-Dee-Expected-Account-Id | header | Optional Original Dee account ID. Current Dee Cookie or human-authorized native-client Bearer remains the credential; another account returns 409 AccountChanged before reading or writing actor-scoped facts. Same-account new sessions remain compatible. View schema |
Authorization | header | Optional Bearer opaque Dee credential from agent browser authorization. Browser requests continue to use the current Cookie and Origin. View schema |
application/jsonModels: TaskDescriptionRequest
{
"$ref": "#/components/schemas/TaskDescriptionRequest"
}200 Title and complete free description merged with the latest entire frontmatter400 401 403 404 409 AccountChanged: current Cookie belongs to another account; no actor-scoped action was performed.410 503 /api/tasks/{id}/fieldsUpdate task fieldsOperation: update_task_fieldsPermalink
Current human-account connector Bearer, or the browser Dee session. Independent Agent Service access is limited to its documented Phase 1 subset. Cookie mutations require the exact application Origin. Bearer requests must omit Cookie; any supplied Origin must match the application. Current resource permissions apply.
| Name | Location | Requirement and schema |
|---|---|---|
id | path | Required Models: Id View schema |
X-Dee-Expected-Account-Id | header | Optional Original Dee account ID. Current Dee Cookie or human-authorized native-client Bearer remains the credential; another account returns 409 AccountChanged before reading or writing actor-scoped facts. Same-account new sessions remain compatible. View schema |
Authorization | header | Optional Bearer opaque Dee credential from agent browser authorization. Browser requests continue to use the current Cookie and Origin. View schema |
application/jsonModels: TaskFieldsRequest
{
"$ref": "#/components/schemas/TaskFieldsRequest"
}200 400 401 403 404 409 AccountChanged: current Cookie belongs to another account; no actor-scoped action was performed.410 503 /api/tasks/{id}/handoffHandoff taskOperation: handoff_taskPermalink
Current human-account connector Bearer, or the browser Dee session. Independent Agent Service access is limited to its documented Phase 1 subset. Cookie mutations require the exact application Origin. Bearer requests must omit Cookie; any supplied Origin must match the application. Current resource permissions apply.
| Name | Location | Requirement and schema |
|---|---|---|
id | path | Required Models: Id View schema |
X-Dee-Expected-Account-Id | header | Optional Original Dee account ID. Current Dee Cookie or human-authorized native-client Bearer remains the credential; another account returns 409 AccountChanged before reading or writing actor-scoped facts. Same-account new sessions remain compatible. View schema |
Authorization | header | Optional Bearer opaque Dee credential from agent browser authorization. Browser requests continue to use the current Cookie and Origin. View schema |
application/jsonModels: HandoffTaskRequest
{
"$ref": "#/components/schemas/HandoffTaskRequest"
}200 Explicit assignee and optional status take effect immediately; a note is published only with a real fields change400 401 403 404 409 AccountChanged: current Cookie belongs to another account; no actor-scoped action was performed.410 503 /api/tasks/{id}/restore-descriptionRestore task descriptionOperation: restore_task_descriptionPermalink
Current human-account connector Bearer, or the browser Dee session. Independent Agent Service access is limited to its documented Phase 1 subset. Cookie mutations require the exact application Origin. Bearer requests must omit Cookie; any supplied Origin must match the application. Current resource permissions apply.
| Name | Location | Requirement and schema |
|---|---|---|
id | path | Required Models: Id View schema |
X-Dee-Expected-Account-Id | header | Optional Original Dee account ID. Current Dee Cookie or human-authorized native-client Bearer remains the credential; another account returns 409 AccountChanged before reading or writing actor-scoped facts. Same-account new sessions remain compatible. View schema |
Authorization | header | Optional Bearer opaque Dee credential from agent browser authorization. Browser requests continue to use the current Cookie and Origin. View schema |
application/jsonModels: RestoreTaskDescriptionRequest
{
"$ref": "#/components/schemas/RestoreTaskDescriptionRequest"
}200 Selected historical title and description restored while preserving the latest entire frontmatter400 401 403 404 409 AccountChanged: current Cookie belongs to another account; no actor-scoped action was performed.410 503 /api/tasks/{id}/restore-sourceRestore task sourceOperation: restore_task_sourcePermalink
Current human-account connector Bearer, or the browser Dee session. Independent Agent Service access is limited to its documented Phase 1 subset. Cookie mutations require the exact application Origin. Bearer requests must omit Cookie; any supplied Origin must match the application. Current resource permissions apply.
| Name | Location | Requirement and schema |
|---|---|---|
id | path | Required Models: Id View schema |
X-Dee-Expected-Account-Id | header | Optional Original Dee account ID. Current Dee Cookie or human-authorized native-client Bearer remains the credential; another account returns 409 AccountChanged before reading or writing actor-scoped facts. Same-account new sessions remain compatible. View schema |
Authorization | header | Optional Bearer opaque Dee credential from agent browser authorization. Browser requests continue to use the current Cookie and Origin. View schema |
application/jsonModels: RestoreTaskSourceRequest
{
"$ref": "#/components/schemas/RestoreTaskSourceRequest"
}200 Explicit complete historical source restored under the reviewed full Revision CAS and current assignment qualification400 401 403 404 409 AccountChanged: current Cookie belongs to another account; no actor-scoped action was performed.410 503 HTTP operations from the current OpenAPI contract.
/api/tasks/queryQuery tasksOperation: query_tasksPermalink
Current human-account connector Bearer, or the browser Dee session. Independent Agent Service access is limited to its documented Phase 1 subset. Cookie mutations require the exact application Origin. Bearer requests must omit Cookie; any supplied Origin must match the application. Current resource permissions apply.
| Name | Location | Requirement and schema |
|---|---|---|
X-Dee-Expected-Account-Id | header | Optional Original Dee account ID. Current Dee Cookie or human-authorized native-client Bearer remains the credential; another account returns 409 AccountChanged before reading or writing actor-scoped facts. Same-account new sessions remain compatible. View schema |
Authorization | header | Optional Bearer opaque Dee credential from agent browser authorization. Browser requests continue to use the current Cookie and Origin. View schema |
application/jsonModels: TaskCollectionRequest
{
"$ref": "#/components/schemas/TaskCollectionRequest"
}200 Current authorized Task summaries, count and five-state totals from one bounded read snapshot; no business mutation400 401 403 Cookie POST requires the configured Origin404 Space membership unavailable409 AccountChanged: the current Cookie belongs to another account; no actor-scoped action was performed.503 Source projection, condition evidence or read budget unavailableThese runtime protocols are documented from the implemented connector. They are supplemental to the downloadable OpenAPI contract.
/agent/connectReview access in the browserOperation: agent_consent_pagePermalink
Current runtime protocol; not part of the downloadable OpenAPI declaration.
Browser Dee session. A signed-out person is redirected through sign-in and returns to this request.
| Name | Location | Requirement and schema |
|---|---|---|
request | query | Required Models: Id View schema |
200 HTML approval page displaying the client, signed-in account, and verification code.text/html{
"type": "string"
}303 Continue through browser sign-in.400 The request could not be accepted or confirmed. Inspect HTTP status, name, and data.401 The request could not be accepted or confirmed. Inspect HTTP status, name, and data.503 The request could not be accepted or confirmed. Inspect HTTP status, name, and data./mcpUse the document tools over JSON-RPCOperation: document_mcpPermalink
Current runtime protocol; not part of the downloadable OpenAPI declaration.
Opaque Dee Bearer only; no browser Cookie. Current document permissions apply to every tool.
200 JSON-RPC response. Domain tool failures use result.isError=true; syntax and parameter failures use JSON-RPC error objects.application/json{
"type": "object"
}202 Valid notification accepted; empty response body.401 The request could not be accepted or confirmed. Inspect HTTP status, name, and data.403 The request could not be accepted or confirmed. Inspect HTTP status, name, and data.503 The request could not be accepted or confirmed. Inspect HTTP status, name, and data.Full schemas preserve required fields, nullable values, enums, formats, and constraints. Models prefixed by Agent or MCP may belong to the supplemental runtime protocols described above.
AccessReceiptRelated models: Id, AccessRole
{
"type": "object",
"required": [
"operation_id",
"document_id",
"revision",
"effect"
],
"properties": {
"document_id": {
"$ref": "#/components/schemas/Id"
},
"effect": {
"type": "string"
},
"operation_id": {
"$ref": "#/components/schemas/Id"
},
"revision": {
"type": "integer",
"format": "int64"
},
"role": {
"oneOf": [
{
"type": "null"
},
{
"$ref": "#/components/schemas/AccessRole"
}
]
},
"target_account_id": {
"oneOf": [
{
"type": "null"
},
{
"$ref": "#/components/schemas/Id"
}
]
},
"target_agent_id": {
"oneOf": [
{
"type": "null"
},
{
"$ref": "#/components/schemas/Id"
}
]
}
}
}AccessRole{
"type": "string",
"enum": [
"viewer",
"editor",
"administrator"
]
}AccessSourceResponseRelated models: AccessRole, Id
{
"oneOf": [
{
"type": "object",
"required": [
"role",
"kind"
],
"properties": {
"kind": {
"type": "string",
"enum": [
"agent_scope"
]
},
"role": {
"$ref": "#/components/schemas/AccessRole"
}
}
},
{
"type": "object",
"required": [
"account_id",
"kind"
],
"properties": {
"account_id": {
"$ref": "#/components/schemas/Id"
},
"kind": {
"type": "string",
"enum": [
"personal_holding"
]
}
}
},
{
"type": "object",
"required": [
"space_id",
"role",
"kind"
],
"properties": {
"kind": {
"type": "string",
"enum": [
"space_membership"
]
},
"role": {
"$ref": "#/components/schemas/AccessRole"
},
"space_id": {
"$ref": "#/components/schemas/Id"
}
}
},
{
"type": "object",
"required": [
"role",
"kind"
],
"properties": {
"kind": {
"type": "string",
"enum": [
"direct_grant"
]
},
"role": {
"$ref": "#/components/schemas/AccessRole"
}
}
}
]
}AccountResponseRelated models: Id
{
"type": "object",
"required": [
"id"
],
"properties": {
"avatar_url": {
"type": [
"string",
"null"
]
},
"display_name": {
"type": [
"string",
"null"
]
},
"email": {
"type": [
"string",
"null"
]
},
"id": {
"$ref": "#/components/schemas/Id"
}
}
}ActivityDataA versioned business payload. Unknown types retain their original structure.
Related models: Id
{
"type": "object",
"description": "A versioned business payload. Unknown types retain their original structure.",
"required": [
"event_type",
"detail_version",
"fields",
"details"
],
"properties": {
"detail_version": {
"type": "integer",
"format": "int32",
"minimum": 0
},
"details": {},
"event_type": {
"type": "string"
},
"fields": {
"type": "array",
"items": {
"type": "string"
}
},
"legacy_id": {
"oneOf": [
{
"type": "null"
},
{
"$ref": "#/components/schemas/Id"
}
]
},
"note": {
"type": [
"string",
"null"
]
},
"source_operation_id": {
"oneOf": [
{
"type": "null"
},
{
"$ref": "#/components/schemas/Id"
}
]
},
"source_operation_owner": {
"type": [
"string",
"null"
]
},
"source_revision_id": {
"oneOf": [
{
"type": "null"
},
{
"$ref": "#/components/schemas/Id"
}
]
}
}
}ActivityResponseRelated models: ActivityData, AuthorResponse, Id, ThreadSummary
{
"type": "object",
"required": [
"id",
"document_id",
"author",
"created_at",
"version",
"activity",
"quote_text",
"source_status",
"entry_url"
],
"properties": {
"activity": {
"$ref": "#/components/schemas/ActivityData"
},
"author": {
"$ref": "#/components/schemas/AuthorResponse"
},
"created_at": {
"type": "integer",
"format": "int64"
},
"document_id": {
"$ref": "#/components/schemas/Id"
},
"entry_url": {
"type": "string"
},
"id": {
"$ref": "#/components/schemas/Id"
},
"quote_text": {
"type": "string"
},
"source_status": {
"type": "string"
},
"source_url": {
"type": [
"string",
"null"
]
},
"thread": {
"oneOf": [
{
"type": "null"
},
{
"$ref": "#/components/schemas/ThreadSummary"
}
]
},
"version": {
"type": "integer",
"format": "int64",
"minimum": 0
}
}
}ActorIdRelated models: Id
{
"oneOf": [
{
"type": "object",
"required": [
"account_id",
"kind"
],
"properties": {
"account_id": {
"$ref": "#/components/schemas/Id"
},
"kind": {
"type": "string",
"enum": [
"user"
]
}
}
},
{
"type": "object",
"required": [
"agent_id",
"kind"
],
"properties": {
"agent_id": {
"$ref": "#/components/schemas/Id"
},
"kind": {
"type": "string",
"enum": [
"agent"
]
}
}
}
]
}AddMemberRequestRelated models: Id, MemberRole
{
"type": "object",
"required": [
"operation_id",
"expected_revision",
"account_id"
],
"properties": {
"account_id": {
"$ref": "#/components/schemas/Id"
},
"expected_revision": {
"type": "integer",
"format": "int64"
},
"operation_id": {
"$ref": "#/components/schemas/Id"
},
"role": {
"$ref": "#/components/schemas/MemberRole"
}
},
"additionalProperties": false
}AgentBuiltinPurpose{
"type": "string",
"enum": [
"definition",
"memory"
]
}AgentConfigurationReceiptRelated models: Id
{
"type": "object",
"required": [
"operation_id",
"agent_id",
"revision"
],
"properties": {
"agent_id": {
"$ref": "#/components/schemas/Id"
},
"operation_id": {
"$ref": "#/components/schemas/Id"
},
"revision": {
"type": "integer",
"format": "int64",
"minimum": 0
}
}
}AgentConfigurationRequestRelated models: Id, ResponseMode, AgentRole
{
"type": "object",
"required": [
"operation_id",
"expected_revision",
"response_mode",
"scope_role",
"definition_document_ids",
"memory_document_ids"
],
"properties": {
"definition_document_ids": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Id"
}
},
"expected_revision": {
"type": "integer",
"format": "int64",
"minimum": 0
},
"memory_document_ids": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Id"
}
},
"operation_id": {
"$ref": "#/components/schemas/Id"
},
"response_mode": {
"$ref": "#/components/schemas/ResponseMode"
},
"scope_role": {
"$ref": "#/components/schemas/AgentRole"
}
},
"additionalProperties": false
}AgentConnectionResponseRelated models: Id, ConnectionStatus
{
"type": "object",
"required": [
"id",
"client_name",
"authorized_at",
"expires_at",
"status"
],
"properties": {
"authorized_at": {
"type": "integer",
"format": "int64"
},
"client_name": {
"type": "string"
},
"expires_at": {
"type": "integer",
"format": "int64"
},
"id": {
"$ref": "#/components/schemas/Id"
},
"last_used_at": {
"type": [
"integer",
"null"
],
"format": "int64"
},
"revoked_at": {
"type": [
"integer",
"null"
],
"format": "int64"
},
"status": {
"$ref": "#/components/schemas/ConnectionStatus"
}
}
}AgentConnectionsResponseRelated models: Paged_AgentConnectionResponse
{
"allOf": [
{
"$ref": "#/components/schemas/Paged_AgentConnectionResponse"
},
{
"type": "object",
"required": [
"generation"
],
"properties": {
"generation": {
"type": "string",
"description": "Opaque decimal generation used to safely retry revoke-all without affecting newer grants."
}
}
}
]
}AgentContextRelated models: Authorization, Id
{
"type": "object",
"required": [
"document_id",
"root_message_id",
"control_revision",
"authorization"
],
"properties": {
"authorization": {
"$ref": "#/components/schemas/Authorization"
},
"control_revision": {
"type": "string"
},
"document_id": {
"$ref": "#/components/schemas/Id"
},
"root_message_id": {
"$ref": "#/components/schemas/Id"
}
},
"additionalProperties": false
}AgentDocumentDetailRelated models: Id, AgentRelatedDocument
{
"type": "object",
"required": [
"document_id",
"can_manage",
"related_documents"
],
"properties": {
"can_manage": {
"type": "boolean"
},
"definition_document_id": {
"oneOf": [
{
"type": "null"
},
{
"$ref": "#/components/schemas/Id",
"description": "The immutable initial Definition document. Current bindings are in Agent Configuration."
}
]
},
"document_id": {
"$ref": "#/components/schemas/Id"
},
"memory_document_id": {
"oneOf": [
{
"type": "null"
},
{
"$ref": "#/components/schemas/Id",
"description": "The immutable initial Memory document. Current bindings are in Agent Configuration."
}
]
},
"related_documents": {
"type": "array",
"items": {
"$ref": "#/components/schemas/AgentRelatedDocument"
},
"description": "Only active related documents this viewer can currently read; links do not grant access."
}
}
}AgentDocumentOperationReceiptRelated models: AgentDocumentReceipt, RelatedDocumentReceipt
{
"oneOf": [
{
"$ref": "#/components/schemas/AgentDocumentReceipt"
},
{
"$ref": "#/components/schemas/RelatedDocumentReceipt"
}
]
}AgentDocumentReceiptRelated models: Id
{
"type": "object",
"required": [
"operation_id",
"document_id"
],
"properties": {
"definition_document_id": {
"oneOf": [
{
"type": "null"
},
{
"$ref": "#/components/schemas/Id"
}
]
},
"document_id": {
"$ref": "#/components/schemas/Id"
},
"memory_document_id": {
"oneOf": [
{
"type": "null"
},
{
"$ref": "#/components/schemas/Id"
}
]
},
"operation_id": {
"$ref": "#/components/schemas/Id"
}
}
}AgentGrantReceiptRelated models: Id
{
"type": "object",
"required": [
"operation_id",
"document_id",
"revision",
"effect",
"target_agent_id"
],
"properties": {
"document_id": {
"$ref": "#/components/schemas/Id"
},
"effect": {
"type": "string"
},
"operation_id": {
"$ref": "#/components/schemas/Id"
},
"revision": {
"type": "integer",
"format": "int64"
},
"role": {
"type": [
"string",
"null"
]
},
"target_account_id": {
"oneOf": [
{
"type": "null"
},
{
"$ref": "#/components/schemas/Id"
}
]
},
"target_agent_id": {
"$ref": "#/components/schemas/Id"
}
}
}AgentGrantRequest{
"type": "object",
"required": [
"operation_id",
"expected_revision",
"role"
],
"properties": {
"expected_revision": {
"type": "integer",
"format": "int64"
},
"operation_id": {
"$ref": "#/components/schemas/Id"
},
"role": {
"$ref": "#/components/schemas/AgentRole"
}
},
"additionalProperties": false
}AgentLoginActorRelated models: Id
{
"oneOf": [
{
"type": "object",
"required": [
"agent_id",
"kind"
],
"properties": {
"agent_id": {
"$ref": "#/components/schemas/Id"
},
"kind": {
"type": "string",
"enum": [
"agent"
]
}
}
}
]
}AgentLoginApproveRequestRelated models: Id
{
"type": "object",
"required": [
"request",
"approve"
],
"properties": {
"approve": {
"type": "boolean"
},
"request": {
"$ref": "#/components/schemas/Id"
}
},
"additionalProperties": false
}AgentLoginPollRequestRelated models: Id
{
"type": "object",
"required": [
"id",
"device_secret"
],
"properties": {
"device_secret": {
"type": "string"
},
"id": {
"$ref": "#/components/schemas/Id"
}
},
"additionalProperties": false
}AgentLoginPollResponseRelated models: ServiceLoginPollResponse, HumanLoginPollResponse
{
"oneOf": [
{
"$ref": "#/components/schemas/ServiceLoginPollResponse"
},
{
"$ref": "#/components/schemas/HumanLoginPollResponse"
}
]
}AgentLoginStartRequestRelated models: LoginSubject
{
"type": "object",
"required": [
"device_secret",
"credential_sha256",
"client_name"
],
"properties": {
"client_name": {
"type": "string"
},
"credential_sha256": {
"type": "string"
},
"device_secret": {
"type": "string"
},
"subject": {
"$ref": "#/components/schemas/LoginSubject"
}
},
"additionalProperties": false
}AgentLoginStartResponseRelated models: Id
{
"type": "object",
"required": [
"id",
"client_name",
"expires_at",
"verification_code",
"verification_url"
],
"properties": {
"client_name": {
"type": "string"
},
"expires_at": {
"type": "integer",
"format": "int64"
},
"id": {
"$ref": "#/components/schemas/Id"
},
"verification_code": {
"type": "string"
},
"verification_url": {
"type": "string"
}
}
}AgentMeRelated models: ActorId, Configuration, Id
{
"type": "object",
"required": [
"protocol",
"actor",
"connection_id",
"configuration"
],
"properties": {
"actor": {
"$ref": "#/components/schemas/ActorId"
},
"configuration": {
"$ref": "#/components/schemas/Configuration"
},
"connection_id": {
"$ref": "#/components/schemas/Id"
},
"protocol": {
"type": "string"
}
}
}AgentRecord{
"type": "object",
"required": [
"kind",
"read_url"
],
"properties": {
"kind": {
"type": "string"
},
"read_url": {
"type": "string"
}
}
}AgentRelatedDocumentRelated models: Id
{
"type": "object",
"required": [
"document_id",
"title",
"document_url"
],
"properties": {
"document_id": {
"$ref": "#/components/schemas/Id"
},
"document_url": {
"type": "string"
},
"title": {
"type": "string"
}
}
}AgentRole{
"type": "string",
"enum": [
"viewer",
"editor",
"administrator"
]
}AgentScopeRelated models: Id
{
"oneOf": [
{
"type": "object",
"required": [
"owner_account_id",
"kind"
],
"properties": {
"kind": {
"type": "string",
"enum": [
"personal"
]
},
"owner_account_id": {
"$ref": "#/components/schemas/Id"
}
}
},
{
"type": "object",
"required": [
"space_id",
"kind"
],
"properties": {
"kind": {
"type": "string",
"enum": [
"space"
]
},
"space_id": {
"$ref": "#/components/schemas/Id"
}
}
}
]
}AttachmentListRelated models: Id, Paged_AttachmentReference, AttachmentScope
{
"type": "object",
"required": [
"document_id",
"scope",
"revision_id",
"thread_id",
"references"
],
"properties": {
"document_id": {
"$ref": "#/components/schemas/Id"
},
"references": {
"$ref": "#/components/schemas/Paged_AttachmentReference"
},
"revision_id": {
"oneOf": [
{
"type": "null"
},
{
"$ref": "#/components/schemas/Id"
}
]
},
"scope": {
"$ref": "#/components/schemas/AttachmentScope"
},
"thread_id": {
"oneOf": [
{
"type": "null"
},
{
"$ref": "#/components/schemas/Id"
}
]
}
}
}AttachmentReferenceRelated models: ResourceMetadata, AttachmentSource
{
"type": "object",
"required": [
"resource",
"source"
],
"properties": {
"resource": {
"$ref": "#/components/schemas/ResourceMetadata"
},
"source": {
"$ref": "#/components/schemas/AttachmentSource"
}
}
}AttachmentScope{
"type": "string",
"enum": [
"body",
"main",
"thread"
]
}AttachmentSourceRelated models: Id
{
"oneOf": [
{
"type": "object",
"required": [
"revision_id",
"created_at",
"source_url",
"kind"
],
"properties": {
"created_at": {
"type": "integer",
"format": "int64"
},
"kind": {
"type": "string",
"enum": [
"revision"
]
},
"revision_id": {
"$ref": "#/components/schemas/Id"
},
"source_url": {
"type": "string"
}
}
},
{
"type": "object",
"required": [
"message_id",
"message_version",
"thread_id",
"created_at",
"source_url",
"kind"
],
"properties": {
"created_at": {
"type": "integer",
"format": "int64"
},
"kind": {
"type": "string",
"enum": [
"message"
]
},
"message_id": {
"$ref": "#/components/schemas/Id"
},
"message_version": {
"type": "integer",
"format": "int64",
"minimum": 0
},
"source_url": {
"type": "string"
},
"thread_id": {
"oneOf": [
{
"type": "null"
},
{
"$ref": "#/components/schemas/Id"
}
]
}
}
}
]
}AttentionReceiptPast personal-operation confirmation, without content or current access authority.
Related models: Id
{
"type": "object",
"description": "Past personal-operation confirmation, without content or current access authority.",
"required": [
"operation_id",
"document_id",
"revision",
"effect"
],
"properties": {
"document_id": {
"$ref": "#/components/schemas/Id"
},
"effect": {
"type": "string"
},
"notification_id": {
"oneOf": [
{
"type": "null"
},
{
"$ref": "#/components/schemas/Id"
}
]
},
"operation_id": {
"$ref": "#/components/schemas/Id"
},
"revision": {
"type": "integer",
"format": "int64",
"minimum": 0
},
"thread_id": {
"oneOf": [
{
"type": "null"
},
{
"$ref": "#/components/schemas/Id"
}
]
}
}
}AuthorResponseRelated models: Id
{
"oneOf": [
{
"type": "object",
"required": [
"agent_id",
"kind"
],
"properties": {
"agent_id": {
"$ref": "#/components/schemas/Id"
},
"avatar_url": {
"type": [
"string",
"null"
]
},
"display_name": {
"type": [
"string",
"null"
]
},
"kind": {
"type": "string",
"enum": [
"agent"
]
}
}
},
{
"type": "object",
"required": [
"account_id",
"kind"
],
"properties": {
"account_id": {
"$ref": "#/components/schemas/Id"
},
"avatar_url": {
"type": [
"string",
"null"
]
},
"display_name": {
"type": [
"string",
"null"
]
},
"kind": {
"type": "string",
"enum": [
"user"
]
}
}
}
]
}AuthorizationRelated models: Id
{
"oneOf": [
{
"type": "object",
"required": [
"plan_id",
"decision_id",
"change_id",
"qualification_id",
"kind"
],
"properties": {
"change_id": {
"$ref": "#/components/schemas/Id"
},
"decision_id": {
"$ref": "#/components/schemas/Id"
},
"kind": {
"type": "string",
"enum": [
"plan"
]
},
"plan_id": {
"$ref": "#/components/schemas/Id"
},
"qualification_id": {
"oneOf": [
{
"type": "null"
},
{
"$ref": "#/components/schemas/Id"
}
]
}
}
},
{
"type": "object",
"required": [
"kind"
],
"properties": {
"kind": {
"type": "string",
"enum": [
"memory"
]
}
}
}
]
}ChangeRelated models: Id, ChangeKind
{
"type": "object",
"required": [
"id",
"position",
"kind",
"effect",
"object_id",
"read_url"
],
"properties": {
"document_id": {
"oneOf": [
{
"type": "null"
},
{
"$ref": "#/components/schemas/Id"
}
]
},
"effect": {
"type": "string"
},
"id": {
"$ref": "#/components/schemas/Id"
},
"kind": {
"$ref": "#/components/schemas/ChangeKind"
},
"object_id": {
"$ref": "#/components/schemas/Id"
},
"position": {
"type": "string",
"description": "Decimal commit position, kept lossless in every client language."
},
"read_url": {
"type": "string"
},
"revision": {
"type": [
"string",
"null"
]
},
"revision_id": {
"oneOf": [
{
"type": "null"
},
{
"$ref": "#/components/schemas/Id"
}
]
},
"structure_version": {
"oneOf": [
{
"type": "null"
},
{
"$ref": "#/components/schemas/Id"
}
]
},
"thread_id": {
"oneOf": [
{
"type": "null"
},
{
"$ref": "#/components/schemas/Id"
}
]
},
"version": {
"type": [
"string",
"null"
]
}
}
}ChangeFeedRelated models: Change, FeedMode
{
"type": "object",
"required": [
"mode",
"events",
"cursor",
"has_more"
],
"properties": {
"cursor": {
"type": "string"
},
"events": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Change"
}
},
"has_more": {
"type": "boolean"
},
"mode": {
"$ref": "#/components/schemas/FeedMode"
}
}
}ChangeKind{
"type": "string",
"enum": [
"document",
"document_tree",
"message",
"activity",
"access",
"space",
"agent_configuration",
"agent_plan",
"agent_decision",
"agent_control",
"agent_feedback"
]
}ClaimTaskRequestRelated models: Id
{
"type": "object",
"required": [
"operation_id",
"expected_task_fields_version"
],
"properties": {
"expected_task_fields_version": {
"$ref": "#/components/schemas/Id"
},
"operation_id": {
"$ref": "#/components/schemas/Id"
}
},
"additionalProperties": false
}CollaboratorResponseRelated models: Id, AccessRole, AccessSourceResponse, ActorId
{
"type": "object",
"required": [
"role",
"joined_at",
"effective_role",
"sources"
],
"properties": {
"account_id": {
"oneOf": [
{
"type": "null"
},
{
"$ref": "#/components/schemas/Id"
}
]
},
"avatar_url": {
"type": [
"string",
"null"
]
},
"display_name": {
"type": [
"string",
"null"
]
},
"effective_role": {
"$ref": "#/components/schemas/AccessRole"
},
"joined_at": {
"type": "integer",
"format": "int64"
},
"role": {
"$ref": "#/components/schemas/AccessRole"
},
"sources": {
"type": "array",
"items": {
"$ref": "#/components/schemas/AccessSourceResponse"
}
},
"subject": {
"oneOf": [
{
"type": "null"
},
{
"$ref": "#/components/schemas/ActorId"
}
]
}
}
}ConfigurationRelated models: Id, ResponseMode, AgentScope, AgentRole
{
"type": "object",
"required": [
"agent_id",
"scope",
"revision",
"response_mode",
"scope_role",
"definition_document_ids",
"memory_document_ids"
],
"properties": {
"agent_id": {
"$ref": "#/components/schemas/Id"
},
"definition_document_ids": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Id"
}
},
"memory_document_ids": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Id"
}
},
"response_mode": {
"$ref": "#/components/schemas/ResponseMode"
},
"revision": {
"type": "integer",
"format": "int64",
"minimum": 0
},
"scope": {
"$ref": "#/components/schemas/AgentScope"
},
"scope_role": {
"$ref": "#/components/schemas/AgentRole"
}
}
}ConnectionStatus{
"type": "string",
"enum": [
"active",
"expired",
"revoked"
]
}ContextResponseRelated models: MessageResponse, Id
{
"type": "object",
"required": [
"message",
"before",
"after"
],
"properties": {
"after": {
"type": "array",
"items": {
"$ref": "#/components/schemas/MessageResponse"
}
},
"before": {
"type": "array",
"items": {
"$ref": "#/components/schemas/MessageResponse"
}
},
"message": {
"$ref": "#/components/schemas/MessageResponse"
},
"thread_id": {
"oneOf": [
{
"type": "null"
},
{
"$ref": "#/components/schemas/Id"
}
]
}
}
}ControlRelated models: Id, ControlAction, ControlState
{
"type": "object",
"required": [
"document_id",
"root_message_id",
"revision",
"state",
"last_action"
],
"properties": {
"document_id": {
"$ref": "#/components/schemas/Id"
},
"last_action": {
"oneOf": [
{
"type": "null"
},
{
"$ref": "#/components/schemas/ControlAction"
}
]
},
"revision": {
"type": "string"
},
"root_message_id": {
"$ref": "#/components/schemas/Id"
},
"state": {
"$ref": "#/components/schemas/ControlState"
}
}
}ControlActionRelated models: WorkAction, ActorId, Id
{
"type": "object",
"required": [
"action",
"actor",
"created_at",
"message_id",
"message_url"
],
"properties": {
"action": {
"$ref": "#/components/schemas/WorkAction"
},
"actor": {
"$ref": "#/components/schemas/ActorId"
},
"created_at": {
"type": "integer",
"format": "int64"
},
"message_id": {
"$ref": "#/components/schemas/Id"
},
"message_url": {
"type": "string"
}
}
}ControlRequestRelated models: WorkAction, Id
{
"type": "object",
"required": [
"operation_id",
"expected_revision",
"action"
],
"properties": {
"action": {
"$ref": "#/components/schemas/WorkAction"
},
"expected_revision": {
"type": "string"
},
"operation_id": {
"$ref": "#/components/schemas/Id"
}
},
"additionalProperties": false
}ControlState{
"type": "string",
"enum": [
"active",
"stopped"
]
}ControlWriteResponseCreateAgentDocumentRequestRelated models: Id, CreateOrigin
{
"type": "object",
"required": [
"operation_id",
"origin",
"title"
],
"properties": {
"operation_id": {
"$ref": "#/components/schemas/Id"
},
"origin": {
"$ref": "#/components/schemas/CreateOrigin"
},
"parent_document_id": {
"oneOf": [
{
"type": "null"
},
{
"$ref": "#/components/schemas/Id",
"description": "Optional active parent in the same personal account or Space. Omission or null creates at root."
}
]
},
"title": {
"type": "string"
}
},
"additionalProperties": false
}CreateDocumentRequestRelated models: AgentContext, Id, CreateOrigin
{
"type": "object",
"required": [
"operation_id",
"title",
"markdown"
],
"properties": {
"agent_context": {
"oneOf": [
{
"type": "null"
},
{
"$ref": "#/components/schemas/AgentContext"
}
]
},
"extension": {
"type": [
"string",
"null"
]
},
"markdown": {
"type": "string"
},
"operation_id": {
"$ref": "#/components/schemas/Id"
},
"origin": {
"oneOf": [
{
"type": "null"
},
{
"$ref": "#/components/schemas/CreateOrigin"
}
]
},
"parent_document_id": {
"oneOf": [
{
"type": "null"
},
{
"$ref": "#/components/schemas/Id"
}
]
},
"title": {
"type": "string"
}
},
"additionalProperties": false
}CreateOriginRelated models: Id
{
"oneOf": [
{
"type": "object",
"required": [
"kind"
],
"properties": {
"kind": {
"type": "string",
"enum": [
"personal"
]
}
}
},
{
"type": "object",
"required": [
"space_id",
"kind"
],
"properties": {
"kind": {
"type": "string",
"enum": [
"space"
]
},
"space_id": {
"$ref": "#/components/schemas/Id"
}
}
}
]
}CreatePageRequestRelated models: HistoryPolicy, Id
{
"type": "object",
"required": [
"operation_id",
"title",
"markdown"
],
"properties": {
"history_policy": {
"$ref": "#/components/schemas/HistoryPolicy"
},
"key": {
"type": [
"string",
"null"
]
},
"markdown": {
"type": "string"
},
"operation_id": {
"$ref": "#/components/schemas/Id"
},
"title": {
"type": "string"
}
},
"additionalProperties": false
}CreateRelatedDocumentRequestRelated models: Id, AgentBuiltinPurpose
{
"type": "object",
"required": [
"operation_id",
"title"
],
"properties": {
"expected_revision": {
"type": [
"integer",
"null"
],
"format": "int64",
"description": "Required with purpose. Compared against the Agent configuration revision.",
"minimum": 0
},
"operation_id": {
"$ref": "#/components/schemas/Id"
},
"purpose": {
"oneOf": [
{
"type": "null"
},
{
"$ref": "#/components/schemas/AgentBuiltinPurpose",
"description": "Create and bind this built-in only when its current binding group is empty."
}
]
},
"title": {
"type": "string",
"description": "Generic related-document title. With purpose, the fixed Agent Definition or Memory title is used."
}
},
"additionalProperties": false
}CreateRequestRelated models: Id
{
"type": "object",
"required": [
"operation_id",
"name"
],
"properties": {
"description": {
"type": "string"
},
"name": {
"type": "string"
},
"operation_id": {
"$ref": "#/components/schemas/Id"
}
},
"additionalProperties": false
}CreateTaskRequestRelated models: Id, CreateOrigin, TaskStatus
{
"type": "object",
"required": [
"operation_id",
"title"
],
"properties": {
"assignee_account_id": {
"oneOf": [
{
"type": "null"
},
{
"$ref": "#/components/schemas/Id",
"description": "Omitted: personal holder or unassigned in a Space. Explicit null: unassigned."
}
]
},
"description": {
"type": "string"
},
"due_date": {
"type": [
"string",
"null"
]
},
"operation_id": {
"$ref": "#/components/schemas/Id"
},
"origin": {
"oneOf": [
{
"type": "null"
},
{
"$ref": "#/components/schemas/CreateOrigin"
}
]
},
"parent_document_id": {
"oneOf": [
{
"type": "null"
},
{
"$ref": "#/components/schemas/Id"
}
]
},
"status": {
"oneOf": [
{
"type": "null"
},
{
"$ref": "#/components/schemas/TaskStatus"
}
]
},
"title": {
"type": "string"
}
},
"additionalProperties": false
}CreatedDocumentRelated models: Id
{
"type": "object",
"required": [
"change_id",
"document_id",
"revision_id"
],
"properties": {
"change_id": {
"$ref": "#/components/schemas/Id"
},
"document_id": {
"$ref": "#/components/schemas/Id"
},
"revision_id": {
"$ref": "#/components/schemas/Id"
}
}
}CurrentSessionResponseRelated models: AccountResponse, SessionResponse
{
"type": "object",
"required": [
"account",
"session"
],
"properties": {
"account": {
"$ref": "#/components/schemas/AccountResponse"
},
"session": {
"$ref": "#/components/schemas/SessionResponse"
}
}
}DecisionRelated models: DecisionAction, ActorId, Id
{
"type": "object",
"required": [
"decision_id",
"actor",
"action",
"created_at",
"control_revision"
],
"properties": {
"action": {
"$ref": "#/components/schemas/DecisionAction"
},
"actor": {
"$ref": "#/components/schemas/ActorId"
},
"control_revision": {
"type": "string"
},
"created_at": {
"type": "integer",
"format": "int64"
},
"decision_id": {
"$ref": "#/components/schemas/Id"
}
}
}DecisionAction{
"type": "string",
"enum": [
"approve",
"reject"
]
}DecisionReceiptRelated models: Id
{
"type": "object",
"required": [
"operation_id",
"decision_id",
"message_url"
],
"properties": {
"decision_id": {
"$ref": "#/components/schemas/Id"
},
"message_url": {
"type": "string"
},
"operation_id": {
"$ref": "#/components/schemas/Id"
}
}
}DecisionRequestRelated models: DecisionAction, Id
{
"type": "object",
"required": [
"operation_id",
"expected_control_revision",
"expected_decision_id",
"action"
],
"properties": {
"action": {
"$ref": "#/components/schemas/DecisionAction"
},
"expected_control_revision": {
"type": "string"
},
"expected_decision_id": {
"oneOf": [
{
"type": "null"
},
{
"$ref": "#/components/schemas/Id"
}
]
},
"operation_id": {
"$ref": "#/components/schemas/Id"
}
},
"additionalProperties": false
}DeleteRequestRelated models: Id
{
"type": "object",
"required": [
"operation_id",
"expected_version"
],
"properties": {
"expected_version": {
"type": "integer",
"format": "int64",
"minimum": 0
},
"operation_id": {
"$ref": "#/components/schemas/Id"
}
},
"additionalProperties": false
}DisclosureCheckRequestDisclosureCheckResponseRelated models: DisclosureResult
{
"type": "object",
"required": [
"allowed",
"checked_at",
"results"
],
"properties": {
"allowed": {
"type": "boolean"
},
"checked_at": {
"type": "integer",
"format": "int64"
},
"results": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DisclosureResult"
}
}
}
}DisclosureResultRelated models: Id
{
"type": "object",
"required": [
"source_document_id",
"allowed"
],
"properties": {
"allowed": {
"type": "boolean"
},
"source_document_id": {
"$ref": "#/components/schemas/Id"
}
}
}DocumentAccessResponseRelated models: Id, AccessRole, AccessSourceResponse
{
"type": "object",
"required": [
"document_id",
"role",
"sources"
],
"properties": {
"document_id": {
"$ref": "#/components/schemas/Id"
},
"role": {
"$ref": "#/components/schemas/AccessRole"
},
"sources": {
"type": "array",
"items": {
"$ref": "#/components/schemas/AccessSourceResponse"
}
}
}
}DocumentLinkPageRelated models: Paged_DocumentLinkSummary, Id
{
"allOf": [
{
"$ref": "#/components/schemas/Paged_DocumentLinkSummary"
},
{
"type": "object",
"required": [
"document_id",
"anchor_revision_id"
],
"properties": {
"anchor_revision_id": {
"$ref": "#/components/schemas/Id"
},
"document_id": {
"$ref": "#/components/schemas/Id"
}
}
}
]
}DocumentLinkSummary{
"type": "object",
"required": [
"id",
"title",
"current_revision_id",
"document_url",
"updated_at",
"link_types"
],
"properties": {
"current_revision_id": {
"$ref": "#/components/schemas/Id"
},
"document_url": {
"type": "string"
},
"id": {
"$ref": "#/components/schemas/Id"
},
"link_types": {
"type": "array",
"items": {
"$ref": "#/components/schemas/LinkType"
}
},
"title": {
"type": "string"
},
"updated_at": {
"type": "integer",
"format": "int64",
"minimum": 0
}
}
}DocumentReceiptRelated models: Id
{
"type": "object",
"required": [
"operation_id",
"document_id",
"revision_id",
"effect",
"snapshot_hash"
],
"properties": {
"document_id": {
"$ref": "#/components/schemas/Id"
},
"effect": {
"type": "string"
},
"operation_id": {
"$ref": "#/components/schemas/Id"
},
"revision_id": {
"$ref": "#/components/schemas/Id"
},
"snapshot_hash": {
"type": "string",
"description": "SHA-256 of UTF-8 compact JSON [title,markdown], lowercase hexadecimal."
}
}
}DocumentResponseRelated models: DocumentSummary, RenderedMarkdown
{
"allOf": [
{
"$ref": "#/components/schemas/DocumentSummary"
},
{
"type": "object",
"required": [
"markdown",
"rendered"
],
"properties": {
"markdown": {
"type": "string"
},
"rendered": {
"$ref": "#/components/schemas/RenderedMarkdown"
}
}
}
]
}DocumentSummaryRelated models: ActorId, Id, OriginResponse
{
"type": "object",
"required": [
"id",
"origin",
"created_by",
"current_revision_id",
"title",
"created_at",
"updated_at",
"can_pin",
"readers_30d",
"my_role",
"document_url",
"revision_url"
],
"properties": {
"agent_document": {
"type": [
"boolean",
"null"
],
"description": "Present only for ordinary documents with an Agent-purpose association record."
},
"can_pin": {
"type": "boolean",
"description": "Current personal holder or Space administrator; direct grants do not confer pin authority."
},
"created_at": {
"type": "integer",
"format": "int64"
},
"created_by": {
"$ref": "#/components/schemas/ActorId"
},
"current_revision_id": {
"$ref": "#/components/schemas/Id"
},
"document_url": {
"type": "string"
},
"extension": {
"type": [
"string",
"null"
],
"description": "Explicit immutable document type. Null uses Markdown."
},
"favorited_at": {
"type": [
"integer",
"null"
],
"format": "int64",
"description": "This account's current favorite timestamp, in Unix epoch milliseconds."
},
"id": {
"$ref": "#/components/schemas/Id"
},
"last_viewed_at": {
"type": [
"integer",
"null"
],
"format": "int64",
"description": "This account's last explicitly recorded opening, in Unix epoch milliseconds."
},
"my_role": {
"type": "string",
"description": "Maximum current role. Creator provenance is not an authorization source."
},
"origin": {
"$ref": "#/components/schemas/OriginResponse"
},
"pinned_at": {
"type": [
"integer",
"null"
],
"format": "int64",
"description": "Origin-owned pin time: personal holding or shared Space, in Unix epoch milliseconds."
},
"readers_30d": {
"type": "integer",
"format": "int64",
"description": "Distinct accounts that explicitly recorded an opening during the past 30 days.",
"minimum": 0
},
"response_mode": {
"type": [
"string",
"null"
],
"description": "Agent response mode projected with the collection; ordinary documents omit it."
},
"revision_url": {
"type": "string"
},
"title": {
"type": "string"
},
"updated_at": {
"type": "integer",
"format": "int64"
}
}
}DocumentTreeNodeRelated models: Id
{
"type": "object",
"required": [
"id",
"title",
"position",
"document_url",
"current_revision_id"
],
"properties": {
"current_revision_id": {
"$ref": "#/components/schemas/Id"
},
"document_url": {
"type": "string"
},
"extension": {
"type": [
"string",
"null"
],
"description": "Explicit stored type; null uses ordinary Markdown, unknown names remain intact."
},
"id": {
"$ref": "#/components/schemas/Id"
},
"parent_document_id": {
"oneOf": [
{
"type": "null"
},
{
"$ref": "#/components/schemas/Id"
}
]
},
"position": {
"type": "integer",
"format": "int64"
},
"title": {
"type": "string"
}
}
}DocumentViewResponseRelated models: Id
{
"type": "object",
"required": [
"document_id",
"viewed_at"
],
"properties": {
"document_id": {
"$ref": "#/components/schemas/Id"
},
"viewed_at": {
"type": "integer",
"format": "int64",
"description": "Unix epoch milliseconds of the retained opening for this account."
}
}
}EditRequest{
"type": "object",
"required": [
"operation_id",
"expected_version",
"parts"
],
"properties": {
"agent_mentions": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Id"
}
},
"expected_version": {
"type": "integer",
"format": "int64",
"minimum": 0
},
"mentions": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Id"
}
},
"operation_id": {
"$ref": "#/components/schemas/Id"
},
"parts": {
"type": "array",
"items": {
"$ref": "#/components/schemas/InputPart"
}
}
},
"additionalProperties": false
}EntryContextResponseRelated models: EntryResponse, Id
{
"type": "object",
"required": [
"entry",
"before",
"after"
],
"properties": {
"after": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EntryResponse"
}
},
"before": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EntryResponse"
}
},
"entry": {
"$ref": "#/components/schemas/EntryResponse"
},
"thread_id": {
"oneOf": [
{
"type": "null"
},
{
"$ref": "#/components/schemas/Id"
}
]
}
}
}EntryKind{
"type": "string",
"enum": [
"all",
"messages",
"activities"
]
}EntryPageResponseRelated models: Paged_EntryResponse, Id
{
"allOf": [
{
"$ref": "#/components/schemas/Paged_EntryResponse"
},
{
"type": "object",
"properties": {
"read_boundary_entry_id": {
"oneOf": [
{
"type": "null"
},
{
"$ref": "#/components/schemas/Id"
}
]
}
}
}
]
}EntryResponseRelated models: MessageResponse, ActivityResponse
{
"oneOf": [
{
"allOf": [
{
"$ref": "#/components/schemas/MessageResponse"
},
{
"type": "object",
"required": [
"kind"
],
"properties": {
"kind": {
"type": "string",
"enum": [
"message"
]
}
}
}
]
},
{
"allOf": [
{
"$ref": "#/components/schemas/ActivityResponse"
},
{
"type": "object",
"required": [
"kind"
],
"properties": {
"kind": {
"type": "string",
"enum": [
"activity"
]
}
}
}
]
}
]
}EntryThreadResponseRelated models: Id, EntryResponse
{
"type": "object",
"required": [
"id",
"document_id",
"root",
"reply_count"
],
"properties": {
"document_id": {
"$ref": "#/components/schemas/Id"
},
"id": {
"$ref": "#/components/schemas/Id"
},
"last_reply_at": {
"type": [
"integer",
"null"
],
"format": "int64"
},
"reply_count": {
"type": "integer",
"format": "int64",
"minimum": 0
},
"root": {
"$ref": "#/components/schemas/EntryResponse"
}
}
}ErrorBody{
"type": "object",
"required": [
"name",
"message"
],
"properties": {
"data": {},
"message": {
"type": "string"
},
"name": {
"type": "string"
}
}
}Excerpt{
"type": "object",
"required": [
"text",
"field"
],
"properties": {
"field": {
"type": "string"
},
"part_id": {
"oneOf": [
{
"type": "null"
},
{
"$ref": "#/components/schemas/Id"
}
]
},
"source_range": {
"$ref": "#/components/schemas/Selection"
},
"text": {
"type": "string"
}
}
}Execution{
"type": "object",
"required": [
"allowed",
"blockers",
"checked_at"
],
"properties": {
"allowed": {
"type": "boolean"
},
"blockers": {
"type": "array",
"items": {
"type": "string"
}
},
"checked_at": {
"type": "integer",
"format": "int64"
}
}
}FavoriteRequestRelated models: Id
{
"type": "object",
"required": [
"operation_id",
"favorited"
],
"properties": {
"favorited": {
"type": "boolean"
},
"operation_id": {
"$ref": "#/components/schemas/Id"
}
},
"additionalProperties": false
}FavoriteResponseRelated models: Id
{
"type": "object",
"required": [
"document_id",
"favorited"
],
"properties": {
"document_id": {
"$ref": "#/components/schemas/Id"
},
"favorited": {
"type": "boolean"
},
"favorited_at": {
"type": [
"integer",
"null"
],
"format": "int64"
}
}
}FeedMode{
"type": "string",
"enum": [
"bootstrap",
"changes"
]
}FeedbackRelated models: ActorId, Id, FeedbackState
{
"type": "object",
"required": [
"document_id",
"root_message_id",
"actor",
"revision",
"control_revision",
"state",
"markdown",
"updated_at",
"message_url"
],
"properties": {
"actor": {
"$ref": "#/components/schemas/ActorId"
},
"control_revision": {
"type": "string"
},
"document_id": {
"$ref": "#/components/schemas/Id"
},
"markdown": {
"type": "string"
},
"message_url": {
"type": "string"
},
"revision": {
"type": "string"
},
"root_message_id": {
"$ref": "#/components/schemas/Id"
},
"state": {
"$ref": "#/components/schemas/FeedbackState"
},
"updated_at": {
"type": "integer",
"format": "int64"
}
}
}FeedbackReadFeedbackReceiptRelated models: Id
{
"type": "object",
"required": [
"operation_id",
"document_id",
"root_message_id",
"agent_id",
"revision",
"message_url"
],
"properties": {
"agent_id": {
"$ref": "#/components/schemas/Id"
},
"document_id": {
"$ref": "#/components/schemas/Id"
},
"message_url": {
"type": "string"
},
"operation_id": {
"$ref": "#/components/schemas/Id"
},
"revision": {
"type": "string"
},
"root_message_id": {
"$ref": "#/components/schemas/Id"
}
}
}FeedbackRequestRelated models: Id, FeedbackState
{
"type": "object",
"required": [
"operation_id",
"expected_revision",
"control_revision",
"state",
"markdown"
],
"properties": {
"control_revision": {
"type": "string"
},
"expected_revision": {
"type": "string"
},
"markdown": {
"type": "string"
},
"operation_id": {
"$ref": "#/components/schemas/Id"
},
"state": {
"$ref": "#/components/schemas/FeedbackState"
}
},
"additionalProperties": false
}FeedbackState{
"type": "string",
"enum": [
"processing",
"waiting",
"completed",
"stopped",
"failed"
]
}GoogleLoginRequest{
"type": "object",
"properties": {
"return_to": {
"type": [
"string",
"null"
],
"description": "Same-origin relative destination, including a query and fragment if present."
}
},
"additionalProperties": false
}GoogleLoginResponse{
"type": "object",
"required": [
"authorization_url"
],
"properties": {
"authorization_url": {
"type": "string",
"description": "Google authorization URL with a one-time state, nonce, and PKCE challenge."
}
}
}HandoffTaskRequestRelated models: Id, TaskStatus
{
"type": "object",
"required": [
"operation_id",
"expected_task_fields_version",
"assignee_account_id"
],
"properties": {
"assignee_account_id": {
"oneOf": [
{
"type": "null"
},
{
"$ref": "#/components/schemas/Id"
}
]
},
"expected_task_fields_version": {
"$ref": "#/components/schemas/Id"
},
"note": {
"type": [
"string",
"null"
],
"description": "Optional handoff explanation, at most 8192 UTF-8 bytes. Published only with a real field change."
},
"operation_id": {
"$ref": "#/components/schemas/Id"
},
"status": {
"oneOf": [
{
"type": "null"
},
{
"$ref": "#/components/schemas/TaskStatus"
}
]
}
},
"additionalProperties": false
}Heading{
"type": "object",
"required": [
"id",
"level",
"text"
],
"properties": {
"id": {
"type": "string"
},
"level": {
"type": "integer",
"format": "int32",
"minimum": 0
},
"text": {
"type": "string"
}
}
}HealthResponse{
"type": "object",
"required": [
"status"
],
"properties": {
"status": {
"type": "string"
}
}
}HistoryLimits{
"type": "object",
"required": [
"max_versions",
"max_bytes"
],
"properties": {
"max_bytes": {
"type": "integer",
"format": "int64",
"minimum": 0
},
"max_versions": {
"type": "integer",
"format": "int64",
"minimum": 0
}
}
}HistoryPolicy{
"type": "string",
"enum": [
"standard",
"limited"
]
}HumanLoginPollResponseRelated models: Id, LoginStatus
{
"type": "object",
"required": [
"status"
],
"properties": {
"account_id": {
"oneOf": [
{
"type": "null"
},
{
"$ref": "#/components/schemas/Id"
}
]
},
"expires_at": {
"type": [
"integer",
"null"
],
"format": "int64"
},
"session_id": {
"oneOf": [
{
"type": "null"
},
{
"$ref": "#/components/schemas/Id"
}
]
},
"status": {
"$ref": "#/components/schemas/LoginStatus"
}
}
}IdA UUID with one case-sensitive, fixed-width text representation. Ordering compares the underlying UUID, independently of its text alphabet.
{
"type": "string",
"description": "A UUID with one case-sensitive, fixed-width text representation.\nOrdering compares the underlying UUID, independently of its text alphabet.",
"pattern": "^[A-Za-z0-9]{22}$"
}IncompleteReason{
"type": "string",
"enum": [
"work_budget",
"output_budget"
]
}InputPartSubmitted content. Quote snapshots are supplied only after the workflow verifies their source.
{
"oneOf": [
{
"type": "object",
"required": [
"id",
"markdown",
"kind"
],
"properties": {
"id": {
"$ref": "#/components/schemas/Id"
},
"kind": {
"type": "string",
"enum": [
"markdown"
]
},
"markdown": {
"type": "string"
}
}
},
{
"type": "object",
"required": [
"id",
"resource_id",
"alt",
"kind"
],
"properties": {
"alt": {
"type": "string"
},
"id": {
"$ref": "#/components/schemas/Id"
},
"kind": {
"type": "string",
"enum": [
"image"
]
},
"resource_id": {
"$ref": "#/components/schemas/Id"
}
}
},
{
"type": "object",
"required": [
"id",
"source",
"kind"
],
"properties": {
"id": {
"$ref": "#/components/schemas/Id"
},
"kind": {
"type": "string",
"enum": [
"quote"
]
},
"source": {
"$ref": "#/components/schemas/Source"
}
}
},
{
"type": "object",
"required": [
"id",
"revision_id",
"kind"
],
"properties": {
"id": {
"$ref": "#/components/schemas/Id"
},
"kind": {
"type": "string",
"enum": [
"revision_link"
]
},
"revision_id": {
"$ref": "#/components/schemas/Id"
}
}
}
],
"description": "Submitted content. Quote snapshots are supplied only after the workflow verifies their source."
}JoinDocumentRequestRelated models: Id
{
"type": "object",
"required": [
"operation_id"
],
"properties": {
"operation_id": {
"$ref": "#/components/schemas/Id"
}
},
"additionalProperties": false
}Kind{
"type": "string",
"enum": [
"document",
"page",
"message"
]
}LifecycleReceiptRelated models: Id
{
"type": "object",
"required": [
"operation_id",
"document_id",
"lifecycle_revision",
"effect"
],
"properties": {
"document_id": {
"$ref": "#/components/schemas/Id"
},
"effect": {
"type": "string"
},
"lifecycle_revision": {
"type": "integer",
"format": "int64",
"minimum": 0
},
"operation_id": {
"$ref": "#/components/schemas/Id"
}
}
}LifecycleRequestRelated models: Id
{
"type": "object",
"required": [
"operation_id",
"expected_management_token"
],
"properties": {
"expected_management_token": {
"type": "string"
},
"operation_id": {
"$ref": "#/components/schemas/Id"
}
},
"additionalProperties": false
}LifecycleResponseRelated models: Id, DocumentAccessResponse, OriginResponse, SharingResponse, LifecycleState
{
"type": "object",
"required": [
"document_id",
"origin",
"title",
"current_revision_id",
"lifecycle_revision",
"state",
"sharing",
"my_access",
"management_token",
"collaborators_url",
"document_url"
],
"properties": {
"collaborators_url": {
"type": "string"
},
"current_revision_id": {
"$ref": "#/components/schemas/Id"
},
"document_id": {
"$ref": "#/components/schemas/Id"
},
"document_url": {
"type": "string"
},
"lifecycle_revision": {
"type": "integer",
"format": "int64",
"minimum": 0
},
"management_token": {
"type": "string"
},
"my_access": {
"$ref": "#/components/schemas/DocumentAccessResponse"
},
"origin": {
"$ref": "#/components/schemas/OriginResponse"
},
"sharing": {
"$ref": "#/components/schemas/SharingResponse"
},
"state": {
"$ref": "#/components/schemas/LifecycleState"
},
"title": {
"type": "string"
},
"trashed_at": {
"type": [
"integer",
"null"
],
"format": "int64"
},
"trashed_by": {
"oneOf": [
{
"type": "null"
},
{
"$ref": "#/components/schemas/Id"
}
]
}
}
}LifecycleState{
"type": "string",
"enum": [
"active",
"trashed"
]
}LinkType{
"type": "string",
"enum": [
"current",
"revision"
]
}LoginConfigResponseRelated models: LoginProviderResponse
{
"type": "object",
"required": [
"provider",
"enabled",
"providers",
"return_to"
],
"properties": {
"enabled": {
"type": "boolean"
},
"provider": {
"type": "string",
"description": "Default sign-in provider. Only configured providers can be used."
},
"providers": {
"type": "array",
"items": {
"$ref": "#/components/schemas/LoginProviderResponse"
}
},
"return_to": {
"type": "string"
}
}
}LoginIdentitiesResponseRelated models: LoginIdentityResponse
{
"type": "object",
"required": [
"items"
],
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/LoginIdentityResponse"
}
}
}
}LoginIdentityResponseRelated models: Id
{
"type": "object",
"required": [
"id",
"provider",
"created_at"
],
"properties": {
"avatar_url": {
"type": [
"string",
"null"
]
},
"created_at": {
"type": "integer",
"format": "int64"
},
"display_name": {
"type": [
"string",
"null"
]
},
"email": {
"type": [
"string",
"null"
]
},
"id": {
"$ref": "#/components/schemas/Id"
},
"provider": {
"type": "string"
}
}
}LoginProviderResponse{
"type": "object",
"required": [
"id",
"enabled"
],
"properties": {
"enabled": {
"type": "boolean"
},
"id": {
"type": "string"
}
}
}LoginStatus{
"type": "string",
"enum": [
"pending",
"denied",
"approved"
]
}LoginSubjectRelated models: Id
{
"oneOf": [
{
"type": "object",
"required": [
"kind"
],
"properties": {
"kind": {
"type": "string",
"enum": [
"user"
]
}
}
},
{
"type": "object",
"required": [
"agent_id",
"kind"
],
"properties": {
"agent_id": {
"$ref": "#/components/schemas/Id"
},
"kind": {
"type": "string",
"enum": [
"agent"
]
}
}
}
]
}LogoutRequestRelated models: Id
{
"type": "object",
"properties": {
"expected_session_id": {
"oneOf": [
{
"type": "null"
},
{
"$ref": "#/components/schemas/Id",
"description": "Original public Dee session ID. Cookie alone selects the session to revoke."
}
]
}
},
"additionalProperties": false
}MaintenanceProvenanceRelated models: Id
{
"type": "object",
"required": [
"kind",
"recovery_id",
"previous_revision_id",
"performed_at"
],
"properties": {
"kind": {
"type": "string",
"description": "Internal recovery transformation, independent of the retained source author."
},
"performed_at": {
"type": "integer",
"format": "int64"
},
"previous_revision_id": {
"$ref": "#/components/schemas/Id"
},
"recovery_id": {
"$ref": "#/components/schemas/Id"
}
}
}MemberResponseRelated models: Id
{
"type": "object",
"required": [
"account_id",
"role",
"joined_at"
],
"properties": {
"account_id": {
"$ref": "#/components/schemas/Id"
},
"avatar_url": {
"type": [
"string",
"null"
]
},
"display_name": {
"type": [
"string",
"null"
]
},
"joined_at": {
"type": "integer",
"format": "int64"
},
"role": {
"type": "string",
"description": "editor or administrator."
}
}
}MemberRole{
"type": "string",
"enum": [
"editor",
"administrator"
]
}MentionCandidateRelated models: Id, ResponseMode
{
"type": "object",
"required": [
"agent_id",
"name",
"response_mode"
],
"properties": {
"agent_id": {
"$ref": "#/components/schemas/Id"
},
"name": {
"type": "string"
},
"response_mode": {
"$ref": "#/components/schemas/ResponseMode"
}
}
}MessagePageResponseRelated models: Paged_MessageResponse, Id
{
"allOf": [
{
"$ref": "#/components/schemas/Paged_MessageResponse"
},
{
"type": "object",
"properties": {
"read_boundary_message_id": {
"oneOf": [
{
"type": "null"
},
{
"$ref": "#/components/schemas/Id",
"description": "Reuse this main/Thread message identity to freeze membership on subsequent pages."
}
]
}
}
}
]
}MessageResponseRelated models: Id, AgentRecord, AuthorResponse, PartResponse, ThreadSummary
{
"type": "object",
"required": [
"id",
"document_id",
"author",
"parts",
"mentions",
"agent_mentions",
"version",
"edited",
"deleted",
"created_at",
"updated_at",
"message_url"
],
"properties": {
"agent_mentions": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Id"
}
},
"agent_record": {
"oneOf": [
{
"type": "null"
},
{
"$ref": "#/components/schemas/AgentRecord"
}
]
},
"author": {
"$ref": "#/components/schemas/AuthorResponse"
},
"created_at": {
"type": "integer",
"format": "int64"
},
"deleted": {
"type": "boolean"
},
"document_id": {
"$ref": "#/components/schemas/Id"
},
"edited": {
"type": "boolean"
},
"id": {
"$ref": "#/components/schemas/Id"
},
"mentions": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Id"
}
},
"message_url": {
"type": "string"
},
"parts": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PartResponse"
}
},
"thread": {
"oneOf": [
{
"type": "null"
},
{
"$ref": "#/components/schemas/ThreadSummary"
}
]
},
"thread_id": {
"oneOf": [
{
"type": "null"
},
{
"$ref": "#/components/schemas/Id"
}
]
},
"thread_url": {
"type": [
"string",
"null"
]
},
"updated_at": {
"type": "integer",
"format": "int64"
},
"version": {
"type": "integer",
"format": "int64",
"minimum": 0
}
}
}MoveDocumentRequestRelated models: Id
{
"type": "object",
"required": [
"operation_id",
"expected_structure_version"
],
"properties": {
"expected_structure_version": {
"$ref": "#/components/schemas/Id"
},
"operation_id": {
"$ref": "#/components/schemas/Id"
},
"parent_document_id": {
"oneOf": [
{
"type": "null"
},
{
"$ref": "#/components/schemas/Id"
}
]
}
},
"additionalProperties": false
}NotificationReadRequestRelated models: Id
{
"type": "object",
"required": [
"operation_id",
"expected_revision"
],
"properties": {
"expected_revision": {
"type": "integer",
"format": "int64",
"minimum": 0
},
"operation_id": {
"$ref": "#/components/schemas/Id"
}
},
"additionalProperties": false
}NotificationResponse{
"type": "object",
"required": [
"id",
"document_id",
"reasons",
"read",
"revision",
"deleted",
"created_at",
"updated_at",
"read_url",
"message_url"
],
"properties": {
"created_at": {
"type": "integer",
"format": "int64"
},
"deleted": {
"type": "boolean"
},
"document_id": {
"$ref": "#/components/schemas/Id"
},
"id": {
"$ref": "#/components/schemas/Id"
},
"message_id": {
"oneOf": [
{
"type": "null"
},
{
"$ref": "#/components/schemas/Id"
}
]
},
"message_url": {
"type": "string"
},
"read": {
"type": "boolean"
},
"read_url": {
"type": "string"
},
"reasons": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Reason"
}
},
"revision": {
"type": "integer",
"format": "int64",
"minimum": 0
},
"task_activity_id": {
"oneOf": [
{
"type": "null"
},
{
"$ref": "#/components/schemas/Id"
}
]
},
"thread_id": {
"oneOf": [
{
"type": "null"
},
{
"$ref": "#/components/schemas/Id"
}
]
},
"updated_at": {
"type": "integer",
"format": "int64"
}
}
}OriginResponseRelated models: Id
{
"oneOf": [
{
"type": "object",
"required": [
"account_id",
"kind"
],
"properties": {
"account_id": {
"$ref": "#/components/schemas/Id"
},
"kind": {
"type": "string",
"enum": [
"personal"
]
}
}
},
{
"type": "object",
"required": [
"space_id",
"kind"
],
"properties": {
"kind": {
"type": "string",
"enum": [
"space"
]
},
"space_id": {
"$ref": "#/components/schemas/Id"
}
}
}
]
}OutlineItemRelated models: Selection
{
"type": "object",
"required": [
"position",
"id",
"level",
"text",
"text_truncated",
"range"
],
"properties": {
"id": {
"type": "string"
},
"level": {
"type": "integer",
"format": "int32",
"minimum": 0
},
"position": {
"type": "integer",
"format": "int64",
"minimum": 0
},
"range": {
"$ref": "#/components/schemas/Selection"
},
"text": {
"type": "string"
},
"text_truncated": {
"type": "boolean"
}
}
}PageContentRelated models: PageSummary
{
"allOf": [
{
"$ref": "#/components/schemas/PageSummary"
},
{
"type": "object",
"required": [
"markdown"
],
"properties": {
"markdown": {
"type": "string"
}
}
}
]
}PageHistoryResponseRelated models: Paged_PageRevisionSummary, Id, HistoryLimits, HistoryPolicy
{
"allOf": [
{
"$ref": "#/components/schemas/Paged_PageRevisionSummary"
},
{
"type": "object",
"required": [
"current_revision_id",
"history_policy"
],
"properties": {
"current_revision_id": {
"$ref": "#/components/schemas/Id"
},
"history_limits": {
"oneOf": [
{
"type": "null"
},
{
"$ref": "#/components/schemas/HistoryLimits"
}
]
},
"history_policy": {
"$ref": "#/components/schemas/HistoryPolicy"
}
}
}
]
}PageKeyRequestRelated models: Id
{
"type": "object",
"required": [
"operation_id",
"expected_metadata_revision"
],
"properties": {
"expected_metadata_revision": {
"type": "integer",
"format": "int64",
"minimum": 0
},
"key": {
"type": [
"string",
"null"
]
},
"operation_id": {
"$ref": "#/components/schemas/Id"
}
},
"additionalProperties": false
}PageLifecycleRequestRelated models: Id
{
"type": "object",
"required": [
"operation_id",
"expected_metadata_revision"
],
"properties": {
"expected_metadata_revision": {
"type": "integer",
"format": "int64",
"minimum": 0
},
"key": {
"type": [
"string",
"null"
],
"description": "Restore may supply a replacement key; omitted/null retains the original key."
},
"operation_id": {
"$ref": "#/components/schemas/Id"
}
},
"additionalProperties": false
}PageReceiptRelated models: Id
{
"type": "object",
"required": [
"operation_id",
"document_id",
"page_id",
"revision_id",
"metadata_revision",
"effect",
"snapshot_hash"
],
"properties": {
"document_id": {
"$ref": "#/components/schemas/Id"
},
"effect": {
"type": "string"
},
"metadata_revision": {
"type": "integer",
"format": "int64",
"minimum": 0
},
"operation_id": {
"$ref": "#/components/schemas/Id"
},
"page_id": {
"$ref": "#/components/schemas/Id"
},
"revision_id": {
"$ref": "#/components/schemas/Id"
},
"snapshot_hash": {
"type": "string"
}
}
}PageResponseRelated models: PageContent, RenderedMarkdown
{
"allOf": [
{
"$ref": "#/components/schemas/PageContent"
},
{
"type": "object",
"required": [
"rendered"
],
"properties": {
"rendered": {
"$ref": "#/components/schemas/RenderedMarkdown"
}
}
}
]
}PageRevisionContent{
"type": "object",
"required": [
"id",
"document_id",
"page_id",
"title",
"markdown",
"snapshot_hash",
"created_by",
"created_at",
"document_url",
"page_url",
"revision_url"
],
"properties": {
"created_at": {
"type": "integer",
"format": "int64"
},
"created_by": {
"$ref": "#/components/schemas/ActorId"
},
"document_id": {
"$ref": "#/components/schemas/Id"
},
"document_url": {
"type": "string"
},
"id": {
"$ref": "#/components/schemas/Id"
},
"markdown": {
"type": "string"
},
"page_id": {
"$ref": "#/components/schemas/Id"
},
"page_url": {
"type": "string"
},
"revision_url": {
"type": "string"
},
"snapshot_hash": {
"type": "string"
},
"title": {
"type": "string"
}
}
}PageRevisionResponseRelated models: PageRevisionContent, RenderedMarkdown
{
"allOf": [
{
"$ref": "#/components/schemas/PageRevisionContent"
},
{
"type": "object",
"required": [
"rendered"
],
"properties": {
"rendered": {
"$ref": "#/components/schemas/RenderedMarkdown"
}
}
}
]
}PageRevisionSummary{
"type": "object",
"required": [
"id",
"title",
"snapshot_hash",
"created_by",
"created_at",
"revision_url"
],
"properties": {
"created_at": {
"type": "integer",
"format": "int64"
},
"created_by": {
"$ref": "#/components/schemas/ActorId"
},
"id": {
"$ref": "#/components/schemas/Id"
},
"revision_url": {
"type": "string"
},
"snapshot_hash": {
"type": "string"
},
"title": {
"type": "string"
}
}
}PageSummaryRelated models: Id, HistoryLimits, HistoryPolicy
{
"type": "object",
"required": [
"id",
"document_id",
"title",
"current_revision_id",
"metadata_revision",
"created_at",
"updated_at",
"my_role",
"history_policy",
"document_url",
"page_url",
"revision_url"
],
"properties": {
"created_at": {
"type": "integer",
"format": "int64"
},
"current_revision_id": {
"$ref": "#/components/schemas/Id"
},
"document_id": {
"$ref": "#/components/schemas/Id"
},
"document_url": {
"type": "string"
},
"history_limits": {
"oneOf": [
{
"type": "null"
},
{
"$ref": "#/components/schemas/HistoryLimits"
}
]
},
"history_policy": {
"$ref": "#/components/schemas/HistoryPolicy"
},
"id": {
"$ref": "#/components/schemas/Id"
},
"key": {
"type": [
"string",
"null"
]
},
"metadata_revision": {
"type": "integer",
"format": "int64",
"minimum": 0
},
"my_role": {
"type": "string"
},
"page_url": {
"type": "string"
},
"revision_url": {
"type": "string"
},
"title": {
"type": "string"
},
"trashed_at": {
"type": [
"integer",
"null"
],
"format": "int64"
},
"updated_at": {
"type": "integer",
"format": "int64"
}
}
}Paged_AgentConnectionResponseRelated models: Id, ConnectionStatus
{
"type": "object",
"required": [
"items",
"page_index",
"page_size",
"total_pages",
"total_items"
],
"properties": {
"items": {
"type": "array",
"items": {
"type": "object",
"required": [
"id",
"client_name",
"authorized_at",
"expires_at",
"status"
],
"properties": {
"authorized_at": {
"type": "integer",
"format": "int64"
},
"client_name": {
"type": "string"
},
"expires_at": {
"type": "integer",
"format": "int64"
},
"id": {
"$ref": "#/components/schemas/Id"
},
"last_used_at": {
"type": [
"integer",
"null"
],
"format": "int64"
},
"revoked_at": {
"type": [
"integer",
"null"
],
"format": "int64"
},
"status": {
"$ref": "#/components/schemas/ConnectionStatus"
}
}
}
},
"page_index": {
"type": "integer",
"format": "int64",
"minimum": 0
},
"page_size": {
"type": "integer",
"format": "int64",
"minimum": 0
},
"total_items": {
"type": "integer",
"format": "int64",
"minimum": 0
},
"total_pages": {
"type": "integer",
"format": "int64",
"minimum": 0
}
}
}Paged_AttachmentReferenceRelated models: ResourceMetadata, AttachmentSource
{
"type": "object",
"required": [
"items",
"page_index",
"page_size",
"total_pages",
"total_items"
],
"properties": {
"items": {
"type": "array",
"items": {
"type": "object",
"required": [
"resource",
"source"
],
"properties": {
"resource": {
"$ref": "#/components/schemas/ResourceMetadata"
},
"source": {
"$ref": "#/components/schemas/AttachmentSource"
}
}
}
},
"page_index": {
"type": "integer",
"format": "int64",
"minimum": 0
},
"page_size": {
"type": "integer",
"format": "int64",
"minimum": 0
},
"total_items": {
"type": "integer",
"format": "int64",
"minimum": 0
},
"total_pages": {
"type": "integer",
"format": "int64",
"minimum": 0
}
}
}Paged_CollaboratorResponseRelated models: Id, AccessRole, AccessSourceResponse, ActorId
{
"type": "object",
"required": [
"items",
"page_index",
"page_size",
"total_pages",
"total_items"
],
"properties": {
"items": {
"type": "array",
"items": {
"type": "object",
"required": [
"role",
"joined_at",
"effective_role",
"sources"
],
"properties": {
"account_id": {
"oneOf": [
{
"type": "null"
},
{
"$ref": "#/components/schemas/Id"
}
]
},
"avatar_url": {
"type": [
"string",
"null"
]
},
"display_name": {
"type": [
"string",
"null"
]
},
"effective_role": {
"$ref": "#/components/schemas/AccessRole"
},
"joined_at": {
"type": "integer",
"format": "int64"
},
"role": {
"$ref": "#/components/schemas/AccessRole"
},
"sources": {
"type": "array",
"items": {
"$ref": "#/components/schemas/AccessSourceResponse"
}
},
"subject": {
"oneOf": [
{
"type": "null"
},
{
"$ref": "#/components/schemas/ActorId"
}
]
}
}
}
},
"page_index": {
"type": "integer",
"format": "int64",
"minimum": 0
},
"page_size": {
"type": "integer",
"format": "int64",
"minimum": 0
},
"total_items": {
"type": "integer",
"format": "int64",
"minimum": 0
},
"total_pages": {
"type": "integer",
"format": "int64",
"minimum": 0
}
}
}Paged_DocumentLinkSummary{
"type": "object",
"required": [
"items",
"page_index",
"page_size",
"total_pages",
"total_items"
],
"properties": {
"items": {
"type": "array",
"items": {
"type": "object",
"required": [
"id",
"title",
"current_revision_id",
"document_url",
"updated_at",
"link_types"
],
"properties": {
"current_revision_id": {
"$ref": "#/components/schemas/Id"
},
"document_url": {
"type": "string"
},
"id": {
"$ref": "#/components/schemas/Id"
},
"link_types": {
"type": "array",
"items": {
"$ref": "#/components/schemas/LinkType"
}
},
"title": {
"type": "string"
},
"updated_at": {
"type": "integer",
"format": "int64",
"minimum": 0
}
}
}
},
"page_index": {
"type": "integer",
"format": "int64",
"minimum": 0
},
"page_size": {
"type": "integer",
"format": "int64",
"minimum": 0
},
"total_items": {
"type": "integer",
"format": "int64",
"minimum": 0
},
"total_pages": {
"type": "integer",
"format": "int64",
"minimum": 0
}
}
}Paged_DocumentSummaryRelated models: ActorId, Id, OriginResponse
{
"type": "object",
"required": [
"items",
"page_index",
"page_size",
"total_pages",
"total_items"
],
"properties": {
"items": {
"type": "array",
"items": {
"type": "object",
"required": [
"id",
"origin",
"created_by",
"current_revision_id",
"title",
"created_at",
"updated_at",
"can_pin",
"readers_30d",
"my_role",
"document_url",
"revision_url"
],
"properties": {
"agent_document": {
"type": [
"boolean",
"null"
],
"description": "Present only for ordinary documents with an Agent-purpose association record."
},
"can_pin": {
"type": "boolean",
"description": "Current personal holder or Space administrator; direct grants do not confer pin authority."
},
"created_at": {
"type": "integer",
"format": "int64"
},
"created_by": {
"$ref": "#/components/schemas/ActorId"
},
"current_revision_id": {
"$ref": "#/components/schemas/Id"
},
"document_url": {
"type": "string"
},
"extension": {
"type": [
"string",
"null"
],
"description": "Explicit immutable document type. Null uses Markdown."
},
"favorited_at": {
"type": [
"integer",
"null"
],
"format": "int64",
"description": "This account's current favorite timestamp, in Unix epoch milliseconds."
},
"id": {
"$ref": "#/components/schemas/Id"
},
"last_viewed_at": {
"type": [
"integer",
"null"
],
"format": "int64",
"description": "This account's last explicitly recorded opening, in Unix epoch milliseconds."
},
"my_role": {
"type": "string",
"description": "Maximum current role. Creator provenance is not an authorization source."
},
"origin": {
"$ref": "#/components/schemas/OriginResponse"
},
"pinned_at": {
"type": [
"integer",
"null"
],
"format": "int64",
"description": "Origin-owned pin time: personal holding or shared Space, in Unix epoch milliseconds."
},
"readers_30d": {
"type": "integer",
"format": "int64",
"description": "Distinct accounts that explicitly recorded an opening during the past 30 days.",
"minimum": 0
},
"response_mode": {
"type": [
"string",
"null"
],
"description": "Agent response mode projected with the collection; ordinary documents omit it."
},
"revision_url": {
"type": "string"
},
"title": {
"type": "string"
},
"updated_at": {
"type": "integer",
"format": "int64"
}
}
}
},
"page_index": {
"type": "integer",
"format": "int64",
"minimum": 0
},
"page_size": {
"type": "integer",
"format": "int64",
"minimum": 0
},
"total_items": {
"type": "integer",
"format": "int64",
"minimum": 0
},
"total_pages": {
"type": "integer",
"format": "int64",
"minimum": 0
}
}
}Paged_DocumentTreeNodeRelated models: Id
{
"type": "object",
"required": [
"items",
"page_index",
"page_size",
"total_pages",
"total_items"
],
"properties": {
"items": {
"type": "array",
"items": {
"type": "object",
"required": [
"id",
"title",
"position",
"document_url",
"current_revision_id"
],
"properties": {
"current_revision_id": {
"$ref": "#/components/schemas/Id"
},
"document_url": {
"type": "string"
},
"extension": {
"type": [
"string",
"null"
],
"description": "Explicit stored type; null uses ordinary Markdown, unknown names remain intact."
},
"id": {
"$ref": "#/components/schemas/Id"
},
"parent_document_id": {
"oneOf": [
{
"type": "null"
},
{
"$ref": "#/components/schemas/Id"
}
]
},
"position": {
"type": "integer",
"format": "int64"
},
"title": {
"type": "string"
}
}
}
},
"page_index": {
"type": "integer",
"format": "int64",
"minimum": 0
},
"page_size": {
"type": "integer",
"format": "int64",
"minimum": 0
},
"total_items": {
"type": "integer",
"format": "int64",
"minimum": 0
},
"total_pages": {
"type": "integer",
"format": "int64",
"minimum": 0
}
}
}Paged_EntryResponseRelated models: MessageResponse, ActivityResponse
{
"type": "object",
"required": [
"items",
"page_index",
"page_size",
"total_pages",
"total_items"
],
"properties": {
"items": {
"type": "array",
"items": {
"oneOf": [
{
"allOf": [
{
"$ref": "#/components/schemas/MessageResponse"
},
{
"type": "object",
"required": [
"kind"
],
"properties": {
"kind": {
"type": "string",
"enum": [
"message"
]
}
}
}
]
},
{
"allOf": [
{
"$ref": "#/components/schemas/ActivityResponse"
},
{
"type": "object",
"required": [
"kind"
],
"properties": {
"kind": {
"type": "string",
"enum": [
"activity"
]
}
}
}
]
}
]
}
},
"page_index": {
"type": "integer",
"format": "int64",
"minimum": 0
},
"page_size": {
"type": "integer",
"format": "int64",
"minimum": 0
},
"total_items": {
"type": "integer",
"format": "int64",
"minimum": 0
},
"total_pages": {
"type": "integer",
"format": "int64",
"minimum": 0
}
}
}Paged_MemberResponseRelated models: Id
{
"type": "object",
"required": [
"items",
"page_index",
"page_size",
"total_pages",
"total_items"
],
"properties": {
"items": {
"type": "array",
"items": {
"type": "object",
"required": [
"account_id",
"role",
"joined_at"
],
"properties": {
"account_id": {
"$ref": "#/components/schemas/Id"
},
"avatar_url": {
"type": [
"string",
"null"
]
},
"display_name": {
"type": [
"string",
"null"
]
},
"joined_at": {
"type": "integer",
"format": "int64"
},
"role": {
"type": "string",
"description": "editor or administrator."
}
}
}
},
"page_index": {
"type": "integer",
"format": "int64",
"minimum": 0
},
"page_size": {
"type": "integer",
"format": "int64",
"minimum": 0
},
"total_items": {
"type": "integer",
"format": "int64",
"minimum": 0
},
"total_pages": {
"type": "integer",
"format": "int64",
"minimum": 0
}
}
}Paged_MentionCandidateRelated models: Id, ResponseMode
{
"type": "object",
"required": [
"items",
"page_index",
"page_size",
"total_pages",
"total_items"
],
"properties": {
"items": {
"type": "array",
"items": {
"type": "object",
"required": [
"agent_id",
"name",
"response_mode"
],
"properties": {
"agent_id": {
"$ref": "#/components/schemas/Id"
},
"name": {
"type": "string"
},
"response_mode": {
"$ref": "#/components/schemas/ResponseMode"
}
}
}
},
"page_index": {
"type": "integer",
"format": "int64",
"minimum": 0
},
"page_size": {
"type": "integer",
"format": "int64",
"minimum": 0
},
"total_items": {
"type": "integer",
"format": "int64",
"minimum": 0
},
"total_pages": {
"type": "integer",
"format": "int64",
"minimum": 0
}
}
}Paged_MessageResponseRelated models: Id, AgentRecord, AuthorResponse, PartResponse, ThreadSummary
{
"type": "object",
"required": [
"items",
"page_index",
"page_size",
"total_pages",
"total_items"
],
"properties": {
"items": {
"type": "array",
"items": {
"type": "object",
"required": [
"id",
"document_id",
"author",
"parts",
"mentions",
"agent_mentions",
"version",
"edited",
"deleted",
"created_at",
"updated_at",
"message_url"
],
"properties": {
"agent_mentions": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Id"
}
},
"agent_record": {
"oneOf": [
{
"type": "null"
},
{
"$ref": "#/components/schemas/AgentRecord"
}
]
},
"author": {
"$ref": "#/components/schemas/AuthorResponse"
},
"created_at": {
"type": "integer",
"format": "int64"
},
"deleted": {
"type": "boolean"
},
"document_id": {
"$ref": "#/components/schemas/Id"
},
"edited": {
"type": "boolean"
},
"id": {
"$ref": "#/components/schemas/Id"
},
"mentions": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Id"
}
},
"message_url": {
"type": "string"
},
"parts": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PartResponse"
}
},
"thread": {
"oneOf": [
{
"type": "null"
},
{
"$ref": "#/components/schemas/ThreadSummary"
}
]
},
"thread_id": {
"oneOf": [
{
"type": "null"
},
{
"$ref": "#/components/schemas/Id"
}
]
},
"thread_url": {
"type": [
"string",
"null"
]
},
"updated_at": {
"type": "integer",
"format": "int64"
},
"version": {
"type": "integer",
"format": "int64",
"minimum": 0
}
}
}
},
"page_index": {
"type": "integer",
"format": "int64",
"minimum": 0
},
"page_size": {
"type": "integer",
"format": "int64",
"minimum": 0
},
"total_items": {
"type": "integer",
"format": "int64",
"minimum": 0
},
"total_pages": {
"type": "integer",
"format": "int64",
"minimum": 0
}
}
}Paged_NotificationResponse{
"type": "object",
"required": [
"items",
"page_index",
"page_size",
"total_pages",
"total_items"
],
"properties": {
"items": {
"type": "array",
"items": {
"type": "object",
"required": [
"id",
"document_id",
"reasons",
"read",
"revision",
"deleted",
"created_at",
"updated_at",
"read_url",
"message_url"
],
"properties": {
"created_at": {
"type": "integer",
"format": "int64"
},
"deleted": {
"type": "boolean"
},
"document_id": {
"$ref": "#/components/schemas/Id"
},
"id": {
"$ref": "#/components/schemas/Id"
},
"message_id": {
"oneOf": [
{
"type": "null"
},
{
"$ref": "#/components/schemas/Id"
}
]
},
"message_url": {
"type": "string"
},
"read": {
"type": "boolean"
},
"read_url": {
"type": "string"
},
"reasons": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Reason"
}
},
"revision": {
"type": "integer",
"format": "int64",
"minimum": 0
},
"task_activity_id": {
"oneOf": [
{
"type": "null"
},
{
"$ref": "#/components/schemas/Id"
}
]
},
"thread_id": {
"oneOf": [
{
"type": "null"
},
{
"$ref": "#/components/schemas/Id"
}
]
},
"updated_at": {
"type": "integer",
"format": "int64"
}
}
}
},
"page_index": {
"type": "integer",
"format": "int64",
"minimum": 0
},
"page_size": {
"type": "integer",
"format": "int64",
"minimum": 0
},
"total_items": {
"type": "integer",
"format": "int64",
"minimum": 0
},
"total_pages": {
"type": "integer",
"format": "int64",
"minimum": 0
}
}
}Paged_OutlineItemRelated models: Selection
{
"type": "object",
"required": [
"items",
"page_index",
"page_size",
"total_pages",
"total_items"
],
"properties": {
"items": {
"type": "array",
"items": {
"type": "object",
"required": [
"position",
"id",
"level",
"text",
"text_truncated",
"range"
],
"properties": {
"id": {
"type": "string"
},
"level": {
"type": "integer",
"format": "int32",
"minimum": 0
},
"position": {
"type": "integer",
"format": "int64",
"minimum": 0
},
"range": {
"$ref": "#/components/schemas/Selection"
},
"text": {
"type": "string"
},
"text_truncated": {
"type": "boolean"
}
}
}
},
"page_index": {
"type": "integer",
"format": "int64",
"minimum": 0
},
"page_size": {
"type": "integer",
"format": "int64",
"minimum": 0
},
"total_items": {
"type": "integer",
"format": "int64",
"minimum": 0
},
"total_pages": {
"type": "integer",
"format": "int64",
"minimum": 0
}
}
}Paged_PageRevisionSummary{
"type": "object",
"required": [
"items",
"page_index",
"page_size",
"total_pages",
"total_items"
],
"properties": {
"items": {
"type": "array",
"items": {
"type": "object",
"required": [
"id",
"title",
"snapshot_hash",
"created_by",
"created_at",
"revision_url"
],
"properties": {
"created_at": {
"type": "integer",
"format": "int64"
},
"created_by": {
"$ref": "#/components/schemas/ActorId"
},
"id": {
"$ref": "#/components/schemas/Id"
},
"revision_url": {
"type": "string"
},
"snapshot_hash": {
"type": "string"
},
"title": {
"type": "string"
}
}
}
},
"page_index": {
"type": "integer",
"format": "int64",
"minimum": 0
},
"page_size": {
"type": "integer",
"format": "int64",
"minimum": 0
},
"total_items": {
"type": "integer",
"format": "int64",
"minimum": 0
},
"total_pages": {
"type": "integer",
"format": "int64",
"minimum": 0
}
}
}Paged_PageSummaryRelated models: Id, HistoryLimits, HistoryPolicy
{
"type": "object",
"required": [
"items",
"page_index",
"page_size",
"total_pages",
"total_items"
],
"properties": {
"items": {
"type": "array",
"items": {
"type": "object",
"required": [
"id",
"document_id",
"title",
"current_revision_id",
"metadata_revision",
"created_at",
"updated_at",
"my_role",
"history_policy",
"document_url",
"page_url",
"revision_url"
],
"properties": {
"created_at": {
"type": "integer",
"format": "int64"
},
"current_revision_id": {
"$ref": "#/components/schemas/Id"
},
"document_id": {
"$ref": "#/components/schemas/Id"
},
"document_url": {
"type": "string"
},
"history_limits": {
"oneOf": [
{
"type": "null"
},
{
"$ref": "#/components/schemas/HistoryLimits"
}
]
},
"history_policy": {
"$ref": "#/components/schemas/HistoryPolicy"
},
"id": {
"$ref": "#/components/schemas/Id"
},
"key": {
"type": [
"string",
"null"
]
},
"metadata_revision": {
"type": "integer",
"format": "int64",
"minimum": 0
},
"my_role": {
"type": "string"
},
"page_url": {
"type": "string"
},
"revision_url": {
"type": "string"
},
"title": {
"type": "string"
},
"trashed_at": {
"type": [
"integer",
"null"
],
"format": "int64"
},
"updated_at": {
"type": "integer",
"format": "int64"
}
}
}
},
"page_index": {
"type": "integer",
"format": "int64",
"minimum": 0
},
"page_size": {
"type": "integer",
"format": "int64",
"minimum": 0
},
"total_items": {
"type": "integer",
"format": "int64",
"minimum": 0
},
"total_pages": {
"type": "integer",
"format": "int64",
"minimum": 0
}
}
}Paged_RevisionSummaryRelated models: ActorId, Id, MaintenanceProvenance
{
"type": "object",
"required": [
"items",
"page_index",
"page_size",
"total_pages",
"total_items"
],
"properties": {
"items": {
"type": "array",
"items": {
"type": "object",
"required": [
"id",
"title",
"snapshot_hash",
"created_by",
"created_at",
"revision_url"
],
"properties": {
"created_at": {
"type": "integer",
"format": "int64"
},
"created_by": {
"$ref": "#/components/schemas/ActorId"
},
"id": {
"$ref": "#/components/schemas/Id"
},
"maintenance": {
"oneOf": [
{
"type": "null"
},
{
"$ref": "#/components/schemas/MaintenanceProvenance"
}
]
},
"revision_url": {
"type": "string"
},
"snapshot_hash": {
"type": "string"
},
"title": {
"type": "string"
}
}
}
},
"page_index": {
"type": "integer",
"format": "int64",
"minimum": 0
},
"page_size": {
"type": "integer",
"format": "int64",
"minimum": 0
},
"total_items": {
"type": "integer",
"format": "int64",
"minimum": 0
},
"total_pages": {
"type": "integer",
"format": "int64",
"minimum": 0
}
}
}Paged_SearchResultRelated models: ResultBase, Id
{
"type": "object",
"required": [
"items",
"page_index",
"page_size",
"total_pages",
"total_items"
],
"properties": {
"items": {
"type": "array",
"items": {
"oneOf": [
{
"allOf": [
{
"$ref": "#/components/schemas/ResultBase"
},
{
"type": "object",
"required": [
"revision_id",
"revision_url"
],
"properties": {
"revision_id": {
"$ref": "#/components/schemas/Id"
},
"revision_url": {
"type": "string"
}
}
},
{
"type": "object",
"required": [
"kind"
],
"properties": {
"kind": {
"type": "string",
"enum": [
"document"
]
}
}
}
]
},
{
"allOf": [
{
"$ref": "#/components/schemas/ResultBase"
},
{
"type": "object",
"required": [
"page_id",
"revision_id",
"page_url",
"revision_url"
],
"properties": {
"page_id": {
"$ref": "#/components/schemas/Id"
},
"page_url": {
"type": "string"
},
"revision_id": {
"$ref": "#/components/schemas/Id"
},
"revision_url": {
"type": "string"
}
}
},
{
"type": "object",
"required": [
"kind"
],
"properties": {
"kind": {
"type": "string",
"enum": [
"page"
]
}
}
}
]
},
{
"allOf": [
{
"$ref": "#/components/schemas/ResultBase"
},
{
"type": "object",
"required": [
"message_version",
"message_url"
],
"properties": {
"message_url": {
"type": "string"
},
"message_version": {
"type": "integer",
"format": "int64",
"minimum": 0
},
"thread_id": {
"oneOf": [
{
"type": "null"
},
{
"$ref": "#/components/schemas/Id"
}
]
}
}
},
{
"type": "object",
"required": [
"kind"
],
"properties": {
"kind": {
"type": "string",
"enum": [
"message"
]
}
}
}
]
}
]
}
},
"page_index": {
"type": "integer",
"format": "int64",
"minimum": 0
},
"page_size": {
"type": "integer",
"format": "int64",
"minimum": 0
},
"total_items": {
"type": "integer",
"format": "int64",
"minimum": 0
},
"total_pages": {
"type": "integer",
"format": "int64",
"minimum": 0
}
}
}Paged_ServiceConnectionRelated models: Id
{
"type": "object",
"required": [
"items",
"page_index",
"page_size",
"total_pages",
"total_items"
],
"properties": {
"items": {
"type": "array",
"items": {
"type": "object",
"required": [
"id",
"client_name",
"authorized_by",
"authorized_at",
"last_used_at",
"expires_at",
"status"
],
"properties": {
"authorized_at": {
"type": "integer",
"format": "int64"
},
"authorized_by": {
"$ref": "#/components/schemas/Id"
},
"client_name": {
"type": "string"
},
"expires_at": {
"type": [
"integer",
"null"
],
"format": "int64"
},
"id": {
"$ref": "#/components/schemas/Id"
},
"last_used_at": {
"type": [
"integer",
"null"
],
"format": "int64"
},
"status": {
"type": "string"
}
}
}
},
"page_index": {
"type": "integer",
"format": "int64",
"minimum": 0
},
"page_size": {
"type": "integer",
"format": "int64",
"minimum": 0
},
"total_items": {
"type": "integer",
"format": "int64",
"minimum": 0
},
"total_pages": {
"type": "integer",
"format": "int64",
"minimum": 0
}
}
}Paged_SpaceResponseRelated models: Id
{
"type": "object",
"required": [
"items",
"page_index",
"page_size",
"total_pages",
"total_items"
],
"properties": {
"items": {
"type": "array",
"items": {
"type": "object",
"required": [
"id",
"name",
"description",
"created_by",
"revision",
"created_at",
"updated_at",
"my_role"
],
"properties": {
"created_at": {
"type": "integer",
"format": "int64"
},
"created_by": {
"$ref": "#/components/schemas/Id"
},
"description": {
"type": "string"
},
"id": {
"$ref": "#/components/schemas/Id"
},
"my_role": {
"type": "string",
"description": "editor or administrator; current member role in this Space only."
},
"name": {
"type": "string"
},
"overview_document_id": {
"oneOf": [
{
"type": "null"
},
{
"$ref": "#/components/schemas/Id",
"description": "A stable document identity; the reference is retained while the document is trashed."
}
]
},
"overview_document_url": {
"type": [
"string",
"null"
]
},
"revision": {
"type": "integer",
"format": "int64"
},
"updated_at": {
"type": "integer",
"format": "int64"
}
}
}
},
"page_index": {
"type": "integer",
"format": "int64",
"minimum": 0
},
"page_size": {
"type": "integer",
"format": "int64",
"minimum": 0
},
"total_items": {
"type": "integer",
"format": "int64",
"minimum": 0
},
"total_pages": {
"type": "integer",
"format": "int64",
"minimum": 0
}
}
}Paged_StateResponseRelated models: Id
{
"type": "object",
"required": [
"items",
"page_index",
"page_size",
"total_pages",
"total_items"
],
"properties": {
"items": {
"type": "array",
"items": {
"type": "object",
"required": [
"document_id",
"following",
"muted",
"revision",
"unread_messages",
"unread_mentions"
],
"properties": {
"document_id": {
"$ref": "#/components/schemas/Id"
},
"following": {
"type": "boolean"
},
"last_message_id": {
"oneOf": [
{
"type": "null"
},
{
"$ref": "#/components/schemas/Id"
}
]
},
"muted": {
"type": "boolean"
},
"read_message_id": {
"oneOf": [
{
"type": "null"
},
{
"$ref": "#/components/schemas/Id"
}
]
},
"revision": {
"type": "integer",
"format": "int64",
"minimum": 0
},
"thread_id": {
"oneOf": [
{
"type": "null"
},
{
"$ref": "#/components/schemas/Id"
}
]
},
"unread_mentions": {
"type": "integer",
"format": "int64",
"minimum": 0
},
"unread_messages": {
"type": "integer",
"format": "int64",
"minimum": 0
}
}
}
},
"page_index": {
"type": "integer",
"format": "int64",
"minimum": 0
},
"page_size": {
"type": "integer",
"format": "int64",
"minimum": 0
},
"total_items": {
"type": "integer",
"format": "int64",
"minimum": 0
},
"total_pages": {
"type": "integer",
"format": "int64",
"minimum": 0
}
}
}Paged_TaskActivityRelated models: Id, TaskActorKind, TaskActivityKind, TaskFields
{
"type": "object",
"required": [
"items",
"page_index",
"page_size",
"total_pages",
"total_items"
],
"properties": {
"items": {
"type": "array",
"items": {
"type": "object",
"required": [
"id",
"document_id",
"revision_id",
"kind",
"actor_id",
"actor_kind",
"new_fields",
"created_at"
],
"properties": {
"actor_id": {
"$ref": "#/components/schemas/Id"
},
"actor_kind": {
"$ref": "#/components/schemas/TaskActorKind"
},
"created_at": {
"type": "integer",
"format": "int64"
},
"document_id": {
"$ref": "#/components/schemas/Id"
},
"id": {
"$ref": "#/components/schemas/Id"
},
"kind": {
"$ref": "#/components/schemas/TaskActivityKind"
},
"new_fields": {
"$ref": "#/components/schemas/TaskFields"
},
"note": {
"type": [
"string",
"null"
]
},
"old_fields": {
"oneOf": [
{
"type": "null"
},
{
"$ref": "#/components/schemas/TaskFields"
}
]
},
"revision_id": {
"$ref": "#/components/schemas/Id"
}
}
}
},
"page_index": {
"type": "integer",
"format": "int64",
"minimum": 0
},
"page_size": {
"type": "integer",
"format": "int64",
"minimum": 0
},
"total_items": {
"type": "integer",
"format": "int64",
"minimum": 0
},
"total_pages": {
"type": "integer",
"format": "int64",
"minimum": 0
}
}
}Paged_TaskSummaryRelated models: TaskFields, Id, OriginResponse
{
"type": "object",
"required": [
"items",
"page_index",
"page_size",
"total_pages",
"total_items"
],
"properties": {
"items": {
"type": "array",
"items": {
"allOf": [
{
"$ref": "#/components/schemas/TaskFields"
},
{
"type": "object",
"required": [
"id",
"origin",
"title",
"current_revision_id",
"task_fields_version",
"description_version",
"created_at",
"updated_at",
"document_url",
"revision_url"
],
"properties": {
"created_at": {
"type": "integer",
"format": "int64"
},
"current_revision_id": {
"$ref": "#/components/schemas/Id"
},
"description_version": {
"$ref": "#/components/schemas/Id"
},
"document_url": {
"type": "string"
},
"id": {
"$ref": "#/components/schemas/Id"
},
"origin": {
"$ref": "#/components/schemas/OriginResponse"
},
"revision_url": {
"type": "string"
},
"task_fields_version": {
"$ref": "#/components/schemas/Id"
},
"title": {
"type": "string"
},
"updated_at": {
"type": "integer",
"format": "int64"
}
}
}
]
}
},
"page_index": {
"type": "integer",
"format": "int64",
"minimum": 0
},
"page_size": {
"type": "integer",
"format": "int64",
"minimum": 0
},
"total_items": {
"type": "integer",
"format": "int64",
"minimum": 0
},
"total_pages": {
"type": "integer",
"format": "int64",
"minimum": 0
}
}
}Paged_TrashSummaryRelated models: Id, OriginResponse, LifecycleState
{
"type": "object",
"required": [
"items",
"page_index",
"page_size",
"total_pages",
"total_items"
],
"properties": {
"items": {
"type": "array",
"items": {
"type": "object",
"required": [
"document_id",
"origin",
"title",
"current_revision_id",
"lifecycle_revision",
"state",
"trashed_at",
"trashed_by",
"created_at",
"updated_at",
"management_url",
"document_url"
],
"properties": {
"created_at": {
"type": "integer",
"format": "int64"
},
"current_revision_id": {
"$ref": "#/components/schemas/Id"
},
"document_id": {
"$ref": "#/components/schemas/Id"
},
"document_url": {
"type": "string"
},
"lifecycle_revision": {
"type": "integer",
"format": "int64",
"minimum": 0
},
"management_url": {
"type": "string"
},
"origin": {
"$ref": "#/components/schemas/OriginResponse"
},
"state": {
"$ref": "#/components/schemas/LifecycleState"
},
"title": {
"type": "string"
},
"trashed_at": {
"type": "integer",
"format": "int64"
},
"trashed_by": {
"$ref": "#/components/schemas/Id"
},
"updated_at": {
"type": "integer",
"format": "int64"
}
}
}
},
"page_index": {
"type": "integer",
"format": "int64",
"minimum": 0
},
"page_size": {
"type": "integer",
"format": "int64",
"minimum": 0
},
"total_items": {
"type": "integer",
"format": "int64",
"minimum": 0
},
"total_pages": {
"type": "integer",
"format": "int64",
"minimum": 0
}
}
}PartPersisted ordered content. The quote snapshot is the verified Markdown at publication time.
{
"oneOf": [
{
"type": "object",
"required": [
"id",
"markdown",
"kind"
],
"properties": {
"id": {
"$ref": "#/components/schemas/Id"
},
"kind": {
"type": "string",
"enum": [
"markdown"
]
},
"markdown": {
"type": "string"
}
}
},
{
"type": "object",
"required": [
"id",
"resource_id",
"alt",
"kind"
],
"properties": {
"alt": {
"type": "string"
},
"id": {
"$ref": "#/components/schemas/Id"
},
"kind": {
"type": "string",
"enum": [
"image"
]
},
"resource_id": {
"$ref": "#/components/schemas/Id"
}
}
},
{
"type": "object",
"required": [
"id",
"source",
"snapshot",
"kind"
],
"properties": {
"id": {
"$ref": "#/components/schemas/Id"
},
"kind": {
"type": "string",
"enum": [
"quote"
]
},
"snapshot": {
"type": "string"
},
"source": {
"$ref": "#/components/schemas/Source"
}
}
},
{
"type": "object",
"required": [
"id",
"revision_id",
"kind"
],
"properties": {
"id": {
"$ref": "#/components/schemas/Id"
},
"kind": {
"type": "string",
"enum": [
"revision_link"
]
},
"revision_id": {
"$ref": "#/components/schemas/Id"
}
}
}
],
"description": "Persisted ordered content. The quote snapshot is the verified Markdown at publication time."
}PartResponseRelated models: Part
{
"allOf": [
{
"$ref": "#/components/schemas/Part"
},
{
"type": "object",
"properties": {
"source_status": {
"type": [
"string",
"null"
]
},
"source_url": {
"type": [
"string",
"null"
]
}
}
}
]
}PersonalDocumentTreeRelated models: Id, Paged_DocumentTreeNode
{
"type": "object",
"required": [
"account_id",
"structure_version",
"documents"
],
"properties": {
"account_id": {
"$ref": "#/components/schemas/Id"
},
"documents": {
"$ref": "#/components/schemas/Paged_DocumentTreeNode"
},
"structure_version": {
"$ref": "#/components/schemas/Id"
}
}
}PinReceiptA minimal original result; it does not grant current document access.
Related models: Id
{
"type": "object",
"description": "A minimal original result; it does not grant current document access.",
"required": [
"operation_id",
"document_id",
"pinned",
"pin_revision",
"effect"
],
"properties": {
"document_id": {
"$ref": "#/components/schemas/Id"
},
"effect": {
"type": "string"
},
"operation_id": {
"$ref": "#/components/schemas/Id"
},
"pin_revision": {
"type": "integer",
"format": "int64",
"minimum": 0
},
"pinned": {
"type": "boolean"
},
"pinned_at": {
"type": [
"integer",
"null"
],
"format": "int64"
}
},
"additionalProperties": false
}PinRequestRelated models: Id
{
"type": "object",
"required": [
"operation_id",
"pinned"
],
"properties": {
"operation_id": {
"$ref": "#/components/schemas/Id"
},
"pinned": {
"type": "boolean"
}
},
"additionalProperties": false
}PinResponseRelated models: Id
{
"type": "object",
"required": [
"document_id",
"pinned",
"can_pin"
],
"properties": {
"can_pin": {
"type": "boolean"
},
"document_id": {
"$ref": "#/components/schemas/Id"
},
"pinned": {
"type": "boolean"
},
"pinned_at": {
"type": [
"integer",
"null"
],
"format": "int64"
}
}
}PlanChange{
"type": "object",
"required": [
"id",
"target",
"action",
"description"
],
"properties": {
"action": {
"type": "string"
},
"description": {
"type": "string"
},
"id": {
"$ref": "#/components/schemas/Id"
},
"target": {
"$ref": "#/components/schemas/Target"
}
},
"additionalProperties": false
}PlanReadRelated models: Control, CreatedDocument, Decision, Id, Execution, PlanSnapshot
{
"type": "object",
"required": [
"plan_id",
"document_id",
"root_message_id",
"snapshot",
"superseded_by_plan_id",
"current_decision",
"current_qualification",
"created_documents",
"control",
"execution"
],
"properties": {
"control": {
"$ref": "#/components/schemas/Control"
},
"created_documents": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CreatedDocument"
}
},
"current_decision": {
"oneOf": [
{
"type": "null"
},
{
"$ref": "#/components/schemas/Decision"
}
]
},
"current_qualification": {
"description": "External qualification submission is reserved for a later implementation."
},
"document_id": {
"$ref": "#/components/schemas/Id"
},
"execution": {
"$ref": "#/components/schemas/Execution"
},
"plan_id": {
"$ref": "#/components/schemas/Id"
},
"root_message_id": {
"$ref": "#/components/schemas/Id"
},
"snapshot": {
"$ref": "#/components/schemas/PlanSnapshot"
},
"superseded_by_plan_id": {
"oneOf": [
{
"type": "null"
},
{
"$ref": "#/components/schemas/Id"
}
]
}
}
}PlanReceiptRelated models: Id
{
"type": "object",
"required": [
"operation_id",
"plan_id",
"message_url"
],
"properties": {
"message_url": {
"type": "string"
},
"operation_id": {
"$ref": "#/components/schemas/Id"
},
"plan_id": {
"$ref": "#/components/schemas/Id"
}
}
}PlanRequestRelated models: PlanChange, Id
{
"type": "object",
"required": [
"operation_id",
"root_message_id",
"expected_control_revision",
"markdown",
"executor_agent_ids",
"changes",
"replaces_plan_id"
],
"properties": {
"changes": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PlanChange"
}
},
"executor_agent_ids": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Id"
}
},
"expected_control_revision": {
"type": "string"
},
"markdown": {
"type": "string"
},
"operation_id": {
"$ref": "#/components/schemas/Id"
},
"replaces_plan_id": {
"oneOf": [
{
"type": "null"
},
{
"$ref": "#/components/schemas/Id"
}
]
},
"root_message_id": {
"$ref": "#/components/schemas/Id"
}
},
"additionalProperties": false
}PlanSnapshotRelated models: ActorId, PlanChange, Id
{
"type": "object",
"required": [
"author",
"created_at",
"markdown",
"executor_agent_ids",
"changes",
"replaces_plan_id"
],
"properties": {
"author": {
"$ref": "#/components/schemas/ActorId"
},
"changes": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PlanChange"
}
},
"created_at": {
"type": "integer",
"format": "int64"
},
"executor_agent_ids": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Id"
}
},
"markdown": {
"type": "string"
},
"replaces_plan_id": {
"oneOf": [
{
"type": "null"
},
{
"$ref": "#/components/schemas/Id"
}
]
}
}
}PreferencesRequestRelated models: Id
{
"type": "object",
"required": [
"operation_id",
"expected_revision"
],
"properties": {
"expected_revision": {
"type": "integer",
"format": "int64",
"minimum": 0
},
"following": {
"type": [
"boolean",
"null"
]
},
"muted": {
"type": [
"boolean",
"null"
]
},
"operation_id": {
"$ref": "#/components/schemas/Id"
}
},
"additionalProperties": false
}ProtocolControlReceiptRelated models: Id, ControlState
{
"type": "object",
"required": [
"operation_id",
"document_id",
"root_message_id",
"revision",
"state",
"message_url"
],
"properties": {
"document_id": {
"$ref": "#/components/schemas/Id"
},
"message_url": {
"type": [
"string",
"null"
]
},
"operation_id": {
"$ref": "#/components/schemas/Id"
},
"revision": {
"type": "string"
},
"root_message_id": {
"$ref": "#/components/schemas/Id"
},
"state": {
"$ref": "#/components/schemas/ControlState"
}
}
}ProtocolOperationRelated models: PlanReceipt, DecisionReceipt, ProtocolControlReceipt, FeedbackReceipt
{
"oneOf": [
{
"type": "object",
"required": [
"receipt",
"kind"
],
"properties": {
"kind": {
"type": "string",
"enum": [
"plan"
]
},
"receipt": {
"$ref": "#/components/schemas/PlanReceipt"
}
}
},
{
"type": "object",
"required": [
"receipt",
"kind"
],
"properties": {
"kind": {
"type": "string",
"enum": [
"decision"
]
},
"receipt": {
"$ref": "#/components/schemas/DecisionReceipt"
}
}
},
{
"type": "object",
"required": [
"receipt",
"kind"
],
"properties": {
"kind": {
"type": "string",
"enum": [
"control"
]
},
"receipt": {
"$ref": "#/components/schemas/ProtocolControlReceipt"
}
}
},
{
"type": "object",
"required": [
"receipt",
"kind"
],
"properties": {
"kind": {
"type": "string",
"enum": [
"feedback"
]
},
"receipt": {
"$ref": "#/components/schemas/FeedbackReceipt"
}
}
}
]
}ProtocolOperationResponseRelated models: AgentConfigurationReceipt, PlanReceipt, DecisionReceipt, ProtocolControlReceipt, FeedbackReceipt
{
"oneOf": [
{
"type": "object",
"required": [
"receipt",
"kind"
],
"properties": {
"kind": {
"type": "string",
"enum": [
"configuration"
]
},
"receipt": {
"$ref": "#/components/schemas/AgentConfigurationReceipt"
}
}
},
{
"type": "object",
"required": [
"receipt",
"kind"
],
"properties": {
"kind": {
"type": "string",
"enum": [
"plan"
]
},
"receipt": {
"$ref": "#/components/schemas/PlanReceipt"
}
}
},
{
"type": "object",
"required": [
"receipt",
"kind"
],
"properties": {
"kind": {
"type": "string",
"enum": [
"decision"
]
},
"receipt": {
"$ref": "#/components/schemas/DecisionReceipt"
}
}
},
{
"type": "object",
"required": [
"receipt",
"kind"
],
"properties": {
"kind": {
"type": "string",
"enum": [
"control"
]
},
"receipt": {
"$ref": "#/components/schemas/ProtocolControlReceipt"
}
}
},
{
"type": "object",
"required": [
"receipt",
"kind"
],
"properties": {
"kind": {
"type": "string",
"enum": [
"feedback"
]
},
"receipt": {
"$ref": "#/components/schemas/FeedbackReceipt"
}
}
}
]
}ReadRequestRelated models: Id
{
"type": "object",
"required": [
"operation_id",
"message_id"
],
"properties": {
"message_id": {
"$ref": "#/components/schemas/Id"
},
"operation_id": {
"$ref": "#/components/schemas/Id"
}
},
"additionalProperties": false
}ReadyResponse{
"type": "object",
"required": [
"status"
],
"properties": {
"status": {
"type": "string"
}
}
}Reason{
"type": "string",
"enum": [
"mentioned",
"thread_reply",
"task_assignment"
]
}ReceiptMinimal original result; it grants no permission to retrieve current message content.
Related models: Id
{
"type": "object",
"description": "Minimal original result; it grants no permission to retrieve current message content.",
"required": [
"operation_id",
"document_id",
"message_id",
"version",
"effect",
"snapshot_hash"
],
"properties": {
"document_id": {
"$ref": "#/components/schemas/Id"
},
"effect": {
"type": "string"
},
"message_id": {
"$ref": "#/components/schemas/Id"
},
"operation_id": {
"$ref": "#/components/schemas/Id"
},
"snapshot_hash": {
"type": "string"
},
"thread_id": {
"oneOf": [
{
"type": "null"
},
{
"$ref": "#/components/schemas/Id"
}
]
},
"version": {
"type": "integer",
"format": "int64",
"minimum": 0
}
}
}ReceiptResponseRelated models: Id, MemberRole
{
"type": "object",
"required": [
"operation_id",
"space_id",
"revision",
"effect"
],
"properties": {
"effect": {
"type": "string"
},
"operation_id": {
"$ref": "#/components/schemas/Id"
},
"revision": {
"type": "integer",
"format": "int64"
},
"role": {
"oneOf": [
{
"type": "null"
},
{
"$ref": "#/components/schemas/MemberRole"
}
]
},
"space_id": {
"$ref": "#/components/schemas/Id"
},
"target_account_id": {
"oneOf": [
{
"type": "null"
},
{
"$ref": "#/components/schemas/Id"
}
]
}
}
}RelatedDocumentReceiptRelated models: Id
{
"type": "object",
"required": [
"operation_id",
"document_id",
"related_document_id"
],
"properties": {
"document_id": {
"$ref": "#/components/schemas/Id"
},
"operation_id": {
"$ref": "#/components/schemas/Id"
},
"related_document_id": {
"$ref": "#/components/schemas/Id"
}
}
}RemoveAgentGrantRequestRelated models: Id
{
"type": "object",
"required": [
"operation_id",
"expected_revision"
],
"properties": {
"expected_revision": {
"type": "integer",
"format": "int64"
},
"operation_id": {
"$ref": "#/components/schemas/Id"
}
},
"additionalProperties": false
}RemoveCollaboratorRequestRelated models: Id
{
"type": "object",
"required": [
"operation_id",
"expected_revision"
],
"properties": {
"expected_revision": {
"type": "integer",
"format": "int64"
},
"operation_id": {
"$ref": "#/components/schemas/Id"
}
},
"additionalProperties": false
}RenderedMarkdownRelated models: Heading
{
"type": "object",
"required": [
"html",
"toc"
],
"properties": {
"html": {
"type": "string"
},
"toc": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Heading"
}
}
}
}ResolveAccountRequest{
"type": "object",
"required": [
"email"
],
"properties": {
"email": {
"type": "string",
"description": "A complete verified email address, never a display-name or prefix search."
}
},
"additionalProperties": false
}ResolvedAccountResponseRelated models: Id
{
"type": "object",
"required": [
"id",
"matched_email"
],
"properties": {
"avatar_url": {
"type": [
"string",
"null"
]
},
"display_name": {
"type": [
"string",
"null"
]
},
"id": {
"$ref": "#/components/schemas/Id"
},
"matched_email": {
"type": "string",
"description": "Echoes the requested email instead of exposing other email addresses."
}
}
}ResourceMetadataRelated models: Id
{
"type": "object",
"required": [
"resource_id",
"filename",
"state",
"sha256",
"byte_size",
"content_type",
"content_url"
],
"properties": {
"byte_size": {
"type": "integer",
"format": "int64"
},
"content_type": {
"type": "string"
},
"content_url": {
"type": "string"
},
"document_id": {
"oneOf": [
{
"type": "null"
},
{
"$ref": "#/components/schemas/Id"
}
]
},
"filename": {
"type": "string"
},
"resource_id": {
"$ref": "#/components/schemas/Id"
},
"sha256": {
"type": "string"
},
"state": {
"type": "string"
}
}
}ResponseMode{
"type": "string",
"enum": [
"mention",
"automatic"
]
}RestoreTaskDescriptionRequestRelated models: Id
{
"type": "object",
"required": [
"operation_id",
"source_revision_id",
"expected_description_version"
],
"properties": {
"expected_description_version": {
"$ref": "#/components/schemas/Id"
},
"operation_id": {
"$ref": "#/components/schemas/Id"
},
"source_revision_id": {
"$ref": "#/components/schemas/Id"
}
},
"additionalProperties": false
}RestoreTaskSourceRequestRelated models: Id
{
"type": "object",
"required": [
"operation_id",
"source_revision_id",
"expected_revision_id"
],
"properties": {
"expected_revision_id": {
"$ref": "#/components/schemas/Id"
},
"operation_id": {
"$ref": "#/components/schemas/Id"
},
"source_revision_id": {
"$ref": "#/components/schemas/Id"
}
},
"additionalProperties": false
}ResultBase{
"type": "object",
"required": [
"id",
"document_id",
"title",
"created_at",
"updated_at",
"document_url",
"excerpt"
],
"properties": {
"created_at": {
"type": "integer",
"format": "int64",
"minimum": 0
},
"document_id": {
"$ref": "#/components/schemas/Id"
},
"document_url": {
"type": "string"
},
"excerpt": {
"$ref": "#/components/schemas/Excerpt"
},
"id": {
"$ref": "#/components/schemas/Id"
},
"title": {
"type": "string"
},
"updated_at": {
"type": "integer",
"format": "int64",
"minimum": 0
}
}
}RevisionContentRelated models: ActorId, Id, MaintenanceProvenance
{
"type": "object",
"required": [
"id",
"document_id",
"title",
"markdown",
"snapshot_hash",
"created_by",
"created_at",
"document_url",
"revision_url"
],
"properties": {
"created_at": {
"type": "integer",
"format": "int64"
},
"created_by": {
"$ref": "#/components/schemas/ActorId"
},
"document_id": {
"$ref": "#/components/schemas/Id"
},
"document_url": {
"type": "string"
},
"extension": {
"type": [
"string",
"null"
],
"description": "Explicit immutable document type. Null uses Markdown."
},
"id": {
"$ref": "#/components/schemas/Id"
},
"maintenance": {
"oneOf": [
{
"type": "null"
},
{
"$ref": "#/components/schemas/MaintenanceProvenance"
}
]
},
"markdown": {
"type": "string"
},
"revision_url": {
"type": "string"
},
"snapshot_hash": {
"type": "string"
},
"title": {
"type": "string"
}
}
}RevisionDiffResponseRelated models: Id, IncompleteReason
{
"type": "object",
"required": [
"document_id",
"from_revision_id",
"to_revision_id",
"title_before",
"title_after",
"has_changes",
"complete",
"incomplete_reason",
"markdown_diff"
],
"properties": {
"complete": {
"type": "boolean"
},
"document_id": {
"$ref": "#/components/schemas/Id"
},
"from_revision_id": {
"$ref": "#/components/schemas/Id"
},
"has_changes": {
"type": "boolean"
},
"incomplete_reason": {
"oneOf": [
{
"type": "null"
},
{
"$ref": "#/components/schemas/IncompleteReason"
}
]
},
"markdown_diff": {
"type": [
"string",
"null"
]
},
"title_after": {
"type": "string"
},
"title_before": {
"type": "string"
},
"to_revision_id": {
"$ref": "#/components/schemas/Id"
}
}
}RevisionHistoryResponseRelated models: Paged_RevisionSummary, Id
{
"allOf": [
{
"$ref": "#/components/schemas/Paged_RevisionSummary"
},
{
"type": "object",
"required": [
"current_revision_id"
],
"properties": {
"current_revision_id": {
"$ref": "#/components/schemas/Id"
}
}
}
]
}RevisionRequestRelated models: Id
{
"type": "object",
"required": [
"operation_id",
"expected_revision"
],
"properties": {
"expected_revision": {
"type": "integer",
"format": "int64"
},
"operation_id": {
"$ref": "#/components/schemas/Id"
}
},
"additionalProperties": false
}RevisionResponseRelated models: RevisionContent, RenderedMarkdown
{
"allOf": [
{
"$ref": "#/components/schemas/RevisionContent"
},
{
"type": "object",
"required": [
"rendered"
],
"properties": {
"rendered": {
"$ref": "#/components/schemas/RenderedMarkdown"
}
}
}
]
}RevisionSummaryRelated models: ActorId, Id, MaintenanceProvenance
{
"type": "object",
"required": [
"id",
"title",
"snapshot_hash",
"created_by",
"created_at",
"revision_url"
],
"properties": {
"created_at": {
"type": "integer",
"format": "int64"
},
"created_by": {
"$ref": "#/components/schemas/ActorId"
},
"id": {
"$ref": "#/components/schemas/Id"
},
"maintenance": {
"oneOf": [
{
"type": "null"
},
{
"$ref": "#/components/schemas/MaintenanceProvenance"
}
]
},
"revision_url": {
"type": "string"
},
"snapshot_hash": {
"type": "string"
},
"title": {
"type": "string"
}
}
}RevokeConnectionsRequest{
"type": "object",
"required": [
"expected_generation"
],
"properties": {
"expected_generation": {
"type": "string",
"description": "Use the generation returned by the reviewed connection list."
}
},
"additionalProperties": false
}SaveDocumentRequestRelated models: AgentContext, Id
{
"type": "object",
"required": [
"operation_id",
"expected_revision_id",
"title",
"markdown"
],
"properties": {
"agent_context": {
"oneOf": [
{
"type": "null"
},
{
"$ref": "#/components/schemas/AgentContext"
}
]
},
"expected_revision_id": {
"$ref": "#/components/schemas/Id"
},
"markdown": {
"type": "string"
},
"operation_id": {
"$ref": "#/components/schemas/Id"
},
"title": {
"type": "string"
}
},
"additionalProperties": false
}SavePageRequestRelated models: Id
{
"type": "object",
"required": [
"operation_id",
"expected_revision_id",
"title",
"markdown"
],
"properties": {
"expected_revision_id": {
"$ref": "#/components/schemas/Id"
},
"markdown": {
"type": "string"
},
"operation_id": {
"$ref": "#/components/schemas/Id"
},
"title": {
"type": "string"
}
},
"additionalProperties": false
}ScopeRelated models: Id
{
"oneOf": [
{
"type": "object",
"required": [
"owner_account_id",
"kind"
],
"properties": {
"kind": {
"type": "string",
"enum": [
"personal"
]
},
"owner_account_id": {
"$ref": "#/components/schemas/Id"
}
}
},
{
"type": "object",
"required": [
"space_id",
"kind"
],
"properties": {
"kind": {
"type": "string",
"enum": [
"space"
]
},
"space_id": {
"$ref": "#/components/schemas/Id"
}
}
}
]
}SearchRequestRelated models: Id, Kind, SearchScope
{
"type": "object",
"required": [
"terms"
],
"properties": {
"document_id": {
"oneOf": [
{
"type": "null"
},
{
"$ref": "#/components/schemas/Id",
"description": "Required for document scope; otherwise intersects the selected mine or Space scope."
}
]
},
"kinds": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Kind"
},
"maxItems": 3,
"minItems": 1
},
"order_by": {
"type": "array",
"items": {
"type": "string"
}
},
"page_index": {
"type": "integer",
"format": "int64",
"default": 0,
"maximum": 9007199254740991,
"minimum": 0
},
"page_size": {
"type": "integer",
"format": "int64",
"default": 50,
"maximum": 100,
"minimum": 0
},
"scope": {
"$ref": "#/components/schemas/SearchScope",
"description": "Omitted: infer space from non-null `space_id`, otherwise mine. Document requires `document_id` and no `space_id`. Explicit null is invalid."
},
"space_id": {
"oneOf": [
{
"type": "null"
},
{
"$ref": "#/components/schemas/Id"
}
]
},
"terms": {
"type": "array",
"items": {
"type": "string"
},
"description": "AND of 1-16 literal strings. Each 1-256 UTF-8 bytes, total at most 2048 bytes; no NUL.",
"maxItems": 16,
"minItems": 1
}
},
"additionalProperties": false
}SearchResultRelated models: ResultBase, Id
{
"oneOf": [
{
"allOf": [
{
"$ref": "#/components/schemas/ResultBase"
},
{
"type": "object",
"required": [
"revision_id",
"revision_url"
],
"properties": {
"revision_id": {
"$ref": "#/components/schemas/Id"
},
"revision_url": {
"type": "string"
}
}
},
{
"type": "object",
"required": [
"kind"
],
"properties": {
"kind": {
"type": "string",
"enum": [
"document"
]
}
}
}
]
},
{
"allOf": [
{
"$ref": "#/components/schemas/ResultBase"
},
{
"type": "object",
"required": [
"page_id",
"revision_id",
"page_url",
"revision_url"
],
"properties": {
"page_id": {
"$ref": "#/components/schemas/Id"
},
"page_url": {
"type": "string"
},
"revision_id": {
"$ref": "#/components/schemas/Id"
},
"revision_url": {
"type": "string"
}
}
},
{
"type": "object",
"required": [
"kind"
],
"properties": {
"kind": {
"type": "string",
"enum": [
"page"
]
}
}
}
]
},
{
"allOf": [
{
"$ref": "#/components/schemas/ResultBase"
},
{
"type": "object",
"required": [
"message_version",
"message_url"
],
"properties": {
"message_url": {
"type": "string"
},
"message_version": {
"type": "integer",
"format": "int64",
"minimum": 0
},
"thread_id": {
"oneOf": [
{
"type": "null"
},
{
"$ref": "#/components/schemas/Id"
}
]
}
}
},
{
"type": "object",
"required": [
"kind"
],
"properties": {
"kind": {
"type": "string",
"enum": [
"message"
]
}
}
}
]
}
]
}SearchScope{
"type": "string",
"enum": [
"mine",
"space",
"document"
]
}SelectionA half-open UTF-8 byte range in the source Markdown, checked against source bytes by workflows.
{
"type": "object",
"description": "A half-open UTF-8 byte range in the source Markdown, checked against source bytes by workflows.",
"required": [
"start",
"end"
],
"properties": {
"end": {
"type": "integer",
"format": "int64",
"minimum": 0
},
"start": {
"type": "integer",
"format": "int64",
"minimum": 0
}
},
"additionalProperties": false
}SendRequest{
"type": "object",
"required": [
"operation_id",
"parts"
],
"properties": {
"agent_mentions": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Id"
}
},
"mentions": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Id"
}
},
"operation_id": {
"$ref": "#/components/schemas/Id"
},
"parts": {
"type": "array",
"items": {
"$ref": "#/components/schemas/InputPart"
}
},
"reply_to": {
"oneOf": [
{
"type": "null"
},
{
"$ref": "#/components/schemas/Id"
}
]
}
},
"additionalProperties": false
}ServiceConnectionRelated models: Id
{
"type": "object",
"required": [
"id",
"client_name",
"authorized_by",
"authorized_at",
"last_used_at",
"expires_at",
"status"
],
"properties": {
"authorized_at": {
"type": "integer",
"format": "int64"
},
"authorized_by": {
"$ref": "#/components/schemas/Id"
},
"client_name": {
"type": "string"
},
"expires_at": {
"type": [
"integer",
"null"
],
"format": "int64"
},
"id": {
"$ref": "#/components/schemas/Id"
},
"last_used_at": {
"type": [
"integer",
"null"
],
"format": "int64"
},
"status": {
"type": "string"
}
}
}ServiceLoginPollResponseRelated models: AgentLoginActor, Id, LoginStatus
{
"type": "object",
"required": [
"status",
"actor",
"connection_id",
"expires_at"
],
"properties": {
"actor": {
"oneOf": [
{
"type": "null"
},
{
"$ref": "#/components/schemas/AgentLoginActor"
}
]
},
"connection_id": {
"oneOf": [
{
"type": "null"
},
{
"$ref": "#/components/schemas/Id"
}
]
},
"expires_at": {
"default": null
},
"status": {
"$ref": "#/components/schemas/LoginStatus"
}
}
}SessionResponseRelated models: Id
{
"type": "object",
"required": [
"id",
"expires_at"
],
"properties": {
"expires_at": {
"type": "integer",
"format": "int64",
"description": "Epoch seconds of the persisted Dee session expiry, established at login."
},
"id": {
"$ref": "#/components/schemas/Id"
}
}
}SetCollaboratorRequestRelated models: Id, AccessRole
{
"type": "object",
"required": [
"operation_id",
"expected_revision",
"role"
],
"properties": {
"expected_revision": {
"type": "integer",
"format": "int64"
},
"operation_id": {
"$ref": "#/components/schemas/Id"
},
"role": {
"$ref": "#/components/schemas/AccessRole"
}
},
"additionalProperties": false
}SetRoleRequestRelated models: Id, MemberRole
{
"type": "object",
"required": [
"operation_id",
"expected_revision",
"role"
],
"properties": {
"expected_revision": {
"type": "integer",
"format": "int64"
},
"operation_id": {
"$ref": "#/components/schemas/Id"
},
"role": {
"$ref": "#/components/schemas/MemberRole"
}
},
"additionalProperties": false
}SetSharingRequestRelated models: Id, AccessRole
{
"type": "object",
"required": [
"operation_id",
"expected_revision",
"enabled",
"role"
],
"properties": {
"enabled": {
"type": "boolean"
},
"expected_revision": {
"type": "integer",
"format": "int64"
},
"operation_id": {
"$ref": "#/components/schemas/Id"
},
"role": {
"$ref": "#/components/schemas/AccessRole"
}
},
"additionalProperties": false
}SharingResponseRelated models: Id, AccessRole
{
"type": "object",
"required": [
"document_id",
"revision",
"link_enabled"
],
"properties": {
"document_id": {
"$ref": "#/components/schemas/Id"
},
"link_enabled": {
"type": "boolean"
},
"link_role": {
"oneOf": [
{
"type": "null"
},
{
"$ref": "#/components/schemas/AccessRole"
}
]
},
"revision": {
"type": "integer",
"format": "int64",
"description": "Access revision, independent of the main-body Revision; zero before the first access write."
}
}
}SourceSource identity remains separate from a quote's retained text and the receiving Thread.
{
"oneOf": [
{
"type": "object",
"required": [
"entry_id",
"kind"
],
"properties": {
"entry_id": {
"$ref": "#/components/schemas/Id"
},
"kind": {
"type": "string",
"enum": [
"activity"
]
},
"range": {
"oneOf": [
{
"type": "null"
},
{
"$ref": "#/components/schemas/Selection"
}
]
}
}
},
{
"type": "object",
"required": [
"revision_id",
"kind"
],
"properties": {
"kind": {
"type": "string",
"enum": [
"revision"
]
},
"range": {
"oneOf": [
{
"type": "null"
},
{
"$ref": "#/components/schemas/Selection"
}
]
},
"revision_id": {
"$ref": "#/components/schemas/Id"
}
}
},
{
"type": "object",
"required": [
"page_id",
"revision_id",
"kind"
],
"properties": {
"kind": {
"type": "string",
"enum": [
"page_revision"
]
},
"page_id": {
"$ref": "#/components/schemas/Id"
},
"range": {
"oneOf": [
{
"type": "null"
},
{
"$ref": "#/components/schemas/Selection"
}
]
},
"revision_id": {
"$ref": "#/components/schemas/Id"
}
}
},
{
"type": "object",
"required": [
"message_id",
"expected_version",
"kind"
],
"properties": {
"expected_version": {
"type": "integer",
"format": "int64",
"minimum": 0
},
"kind": {
"type": "string",
"enum": [
"message"
]
},
"message_id": {
"$ref": "#/components/schemas/Id"
},
"part_id": {
"oneOf": [
{
"type": "null"
},
{
"$ref": "#/components/schemas/Id"
}
]
},
"range": {
"oneOf": [
{
"type": "null"
},
{
"$ref": "#/components/schemas/Selection"
}
]
}
}
}
],
"description": "Source identity remains separate from a quote's retained text and the receiving Thread."
}SourceBaseRelated models: Id
{
"type": "object",
"required": [
"document_id",
"revision_id",
"title",
"total_bytes",
"document_url",
"revision_url"
],
"properties": {
"document_id": {
"$ref": "#/components/schemas/Id"
},
"document_url": {
"type": "string"
},
"revision_id": {
"$ref": "#/components/schemas/Id"
},
"revision_url": {
"type": "string"
},
"title": {
"type": "string"
},
"total_bytes": {
"type": "integer",
"format": "int64",
"minimum": 0
}
}
}SourceResponseRelated models: SourceBase, Selection, Paged_OutlineItem
{
"oneOf": [
{
"allOf": [
{
"$ref": "#/components/schemas/SourceBase"
},
{
"type": "object",
"required": [
"markdown",
"range"
],
"properties": {
"markdown": {
"type": "string"
},
"next_range": {
"oneOf": [
{
"type": "null"
},
{
"$ref": "#/components/schemas/Selection"
}
]
},
"range": {
"$ref": "#/components/schemas/Selection"
}
}
},
{
"type": "object",
"required": [
"view"
],
"properties": {
"view": {
"type": "string",
"enum": [
"markdown"
]
}
}
}
]
},
{
"allOf": [
{
"$ref": "#/components/schemas/SourceBase"
},
{
"$ref": "#/components/schemas/Paged_OutlineItem"
},
{
"type": "object",
"properties": {
"preamble_range": {
"oneOf": [
{
"type": "null"
},
{
"$ref": "#/components/schemas/Selection"
}
]
}
}
},
{
"type": "object",
"required": [
"view"
],
"properties": {
"view": {
"type": "string",
"enum": [
"outline"
]
}
}
}
]
}
]
}SpaceDocumentTreeRelated models: Paged_DocumentTreeNode, Id
{
"type": "object",
"required": [
"space_id",
"structure_version",
"documents"
],
"properties": {
"documents": {
"$ref": "#/components/schemas/Paged_DocumentTreeNode"
},
"space_id": {
"$ref": "#/components/schemas/Id"
},
"structure_version": {
"$ref": "#/components/schemas/Id"
}
}
}SpaceResponseRelated models: Id
{
"type": "object",
"required": [
"id",
"name",
"description",
"created_by",
"revision",
"created_at",
"updated_at",
"my_role"
],
"properties": {
"created_at": {
"type": "integer",
"format": "int64"
},
"created_by": {
"$ref": "#/components/schemas/Id"
},
"description": {
"type": "string"
},
"id": {
"$ref": "#/components/schemas/Id"
},
"my_role": {
"type": "string",
"description": "editor or administrator; current member role in this Space only."
},
"name": {
"type": "string"
},
"overview_document_id": {
"oneOf": [
{
"type": "null"
},
{
"$ref": "#/components/schemas/Id",
"description": "A stable document identity; the reference is retained while the document is trashed."
}
]
},
"overview_document_url": {
"type": [
"string",
"null"
]
},
"revision": {
"type": "integer",
"format": "int64"
},
"updated_at": {
"type": "integer",
"format": "int64"
}
}
}StateResponseRelated models: Id
{
"type": "object",
"required": [
"document_id",
"following",
"muted",
"revision",
"unread_messages",
"unread_mentions"
],
"properties": {
"document_id": {
"$ref": "#/components/schemas/Id"
},
"following": {
"type": "boolean"
},
"last_message_id": {
"oneOf": [
{
"type": "null"
},
{
"$ref": "#/components/schemas/Id"
}
]
},
"muted": {
"type": "boolean"
},
"read_message_id": {
"oneOf": [
{
"type": "null"
},
{
"$ref": "#/components/schemas/Id"
}
]
},
"revision": {
"type": "integer",
"format": "int64",
"minimum": 0
},
"thread_id": {
"oneOf": [
{
"type": "null"
},
{
"$ref": "#/components/schemas/Id"
}
]
},
"unread_mentions": {
"type": "integer",
"format": "int64",
"minimum": 0
},
"unread_messages": {
"type": "integer",
"format": "int64",
"minimum": 0
}
}
}SummaryResponse{
"type": "object",
"required": [
"unread_notifications",
"unread_messages",
"unread_mentions",
"followed_threads"
],
"properties": {
"followed_threads": {
"type": "integer",
"format": "int64",
"minimum": 0
},
"unread_mentions": {
"type": "integer",
"format": "int64",
"minimum": 0
},
"unread_messages": {
"type": "integer",
"format": "int64",
"minimum": 0
},
"unread_notifications": {
"type": "integer",
"format": "int64",
"minimum": 0
}
}
}Target{
"oneOf": [
{
"type": "object",
"required": [
"document_id",
"kind"
],
"properties": {
"document_id": {
"$ref": "#/components/schemas/Id"
},
"kind": {
"type": "string",
"enum": [
"dee_document"
]
}
}
},
{
"type": "object",
"required": [
"origin",
"parent_document_id",
"kind"
],
"properties": {
"kind": {
"type": "string",
"enum": [
"dee_document_create"
]
},
"origin": {
"$ref": "#/components/schemas/Scope"
},
"parent_document_id": {
"oneOf": [
{
"type": "null"
},
{
"$ref": "#/components/schemas/Id"
}
]
}
}
},
{
"type": "object",
"required": [
"system",
"resource",
"display_name",
"kind"
],
"properties": {
"display_name": {
"type": "string"
},
"kind": {
"type": "string",
"enum": [
"external"
]
},
"resource": {
"type": "string"
},
"system": {
"type": "string"
}
}
}
]
}TaskActivityRelated models: Id, TaskActorKind, TaskActivityKind, TaskFields
{
"type": "object",
"required": [
"id",
"document_id",
"revision_id",
"kind",
"actor_id",
"actor_kind",
"new_fields",
"created_at"
],
"properties": {
"actor_id": {
"$ref": "#/components/schemas/Id"
},
"actor_kind": {
"$ref": "#/components/schemas/TaskActorKind"
},
"created_at": {
"type": "integer",
"format": "int64"
},
"document_id": {
"$ref": "#/components/schemas/Id"
},
"id": {
"$ref": "#/components/schemas/Id"
},
"kind": {
"$ref": "#/components/schemas/TaskActivityKind"
},
"new_fields": {
"$ref": "#/components/schemas/TaskFields"
},
"note": {
"type": [
"string",
"null"
]
},
"old_fields": {
"oneOf": [
{
"type": "null"
},
{
"$ref": "#/components/schemas/TaskFields"
}
]
},
"revision_id": {
"$ref": "#/components/schemas/Id"
}
}
}TaskActivityKind{
"type": "string",
"enum": [
"created",
"fields_changed"
]
}TaskActorKind{
"type": "string",
"enum": [
"user",
"agent"
]
}TaskCollectionRelated models: Paged_TaskSummary, TaskStatusCounts
{
"allOf": [
{
"$ref": "#/components/schemas/Paged_TaskSummary"
},
{
"type": "object",
"required": [
"status_counts"
],
"properties": {
"status_counts": {
"$ref": "#/components/schemas/TaskStatusCounts"
}
}
}
]
}TaskCollectionRequestRelated models: Id, TaskCollectionScope, TaskStatus
{
"type": "object",
"properties": {
"assignee_account_id": {
"oneOf": [
{
"type": "null"
},
{
"$ref": "#/components/schemas/Id"
}
]
},
"due_date_from": {
"type": [
"string",
"null"
],
"description": "Inclusive positive-year YYYY-MM-DD lower bound, using Task's calendar rules."
},
"due_date_to": {
"type": [
"string",
"null"
],
"description": "Inclusive positive-year YYYY-MM-DD upper bound; must not precede `due_date_from`."
},
"order_by": {
"type": "array",
"items": {
"type": "string"
},
"description": "field.asc/desc items. Default `updated_at.desc,id.asc`; nullable dates always sort last."
},
"page_index": {
"type": "integer",
"format": "int64",
"default": 0,
"maximum": 9007199254740991,
"minimum": 0
},
"page_size": {
"type": "integer",
"format": "int64",
"default": 50,
"maximum": 100,
"minimum": 0
},
"scope": {
"$ref": "#/components/schemas/TaskCollectionScope",
"description": "Personal holding by default; `assigned_to_me` spans all current human read sources."
},
"space_id": {
"oneOf": [
{
"type": "null"
},
{
"$ref": "#/components/schemas/Id",
"description": "Required only for space scope, whose current membership is checked independently."
}
]
},
"statuses": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TaskStatus"
},
"description": "Omitted: unfinished for `assigned_to_me`, all five states otherwise. Explicit null/[] is invalid.",
"minItems": 1
},
"terms": {
"type": "array",
"items": {
"type": "string"
},
"description": "Literal AND over title and free description. Default [] browses the collection.",
"maxItems": 16
},
"unassigned": {
"type": "boolean",
"description": "Match unassigned Tasks; mutually exclusive with a non-null `assignee_account_id`."
},
"without_due_date": {
"type": "boolean",
"description": "Match no date; mutually exclusive with either date bound."
}
},
"additionalProperties": false
}TaskCollectionScope{
"type": "string",
"enum": [
"personal",
"space",
"assigned_to_me"
]
}TaskDescriptionRequestRelated models: Id
{
"type": "object",
"required": [
"operation_id",
"expected_description_version",
"title",
"description"
],
"properties": {
"description": {
"type": "string"
},
"expected_description_version": {
"$ref": "#/components/schemas/Id"
},
"operation_id": {
"$ref": "#/components/schemas/Id"
},
"title": {
"type": "string"
}
},
"additionalProperties": false
}TaskDetailRelated models: TaskFields, TaskActivity, Id
{
"allOf": [
{
"$ref": "#/components/schemas/TaskFields"
},
{
"type": "object",
"required": [
"document_id",
"title",
"markdown",
"description",
"document_revision_id",
"task_fields_version",
"description_version",
"assignee_can_edit",
"activities",
"activities_truncated"
],
"properties": {
"activities": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TaskActivity"
},
"description": "At most fifty newest committed activities, ordered by `created_at` descending and ID ascending."
},
"activities_truncated": {
"type": "boolean"
},
"assignee_can_edit": {
"type": "boolean",
"description": "False when unassigned or the retained assignee no longer holds effective edit permission."
},
"description": {
"type": "string"
},
"description_version": {
"$ref": "#/components/schemas/Id"
},
"document_id": {
"$ref": "#/components/schemas/Id"
},
"document_revision_id": {
"$ref": "#/components/schemas/Id"
},
"markdown": {
"type": "string"
},
"task_fields_version": {
"$ref": "#/components/schemas/Id"
},
"title": {
"type": "string"
}
}
}
]
}TaskFieldsRelated models: Id, TaskStatus
{
"type": "object",
"required": [
"status"
],
"properties": {
"assignee_account_id": {
"oneOf": [
{
"type": "null"
},
{
"$ref": "#/components/schemas/Id"
}
]
},
"due_date": {
"type": [
"string",
"null"
]
},
"status": {
"$ref": "#/components/schemas/TaskStatus"
}
},
"additionalProperties": false
}TaskFieldsRequestRelated models: Id, TaskStatus
{
"type": "object",
"required": [
"operation_id",
"expected_task_fields_version"
],
"properties": {
"assignee_account_id": {
"oneOf": [
{
"type": "null"
},
{
"$ref": "#/components/schemas/Id"
}
]
},
"due_date": {
"type": [
"string",
"null"
]
},
"expected_task_fields_version": {
"$ref": "#/components/schemas/Id"
},
"operation_id": {
"$ref": "#/components/schemas/Id"
},
"status": {
"oneOf": [
{
"type": "null"
},
{
"$ref": "#/components/schemas/TaskStatus"
}
]
}
},
"additionalProperties": false
}TaskReceiptRelated models: Id
{
"type": "object",
"required": [
"operation_id",
"document_id",
"revision_id",
"snapshot_hash",
"effect",
"task_fields_version",
"description_version",
"note_published"
],
"properties": {
"activity_id": {
"oneOf": [
{
"type": "null"
},
{
"$ref": "#/components/schemas/Id"
}
]
},
"description_version": {
"$ref": "#/components/schemas/Id"
},
"document_id": {
"$ref": "#/components/schemas/Id"
},
"effect": {
"type": "string"
},
"note_published": {
"type": "boolean"
},
"operation_id": {
"$ref": "#/components/schemas/Id"
},
"revision_id": {
"$ref": "#/components/schemas/Id"
},
"snapshot_hash": {
"type": "string"
},
"task_fields_version": {
"$ref": "#/components/schemas/Id"
}
}
}TaskStatus{
"type": "string",
"enum": [
"todo",
"progress",
"review",
"done",
"cancelled"
]
}TaskStatusCounts{
"type": "object",
"required": [
"todo",
"progress",
"review",
"done",
"cancelled"
],
"properties": {
"cancelled": {
"type": "integer",
"format": "int64",
"minimum": 0
},
"done": {
"type": "integer",
"format": "int64",
"minimum": 0
},
"progress": {
"type": "integer",
"format": "int64",
"minimum": 0
},
"review": {
"type": "integer",
"format": "int64",
"minimum": 0
},
"todo": {
"type": "integer",
"format": "int64",
"minimum": 0
}
}
}TaskSummaryRelated models: TaskFields, Id, OriginResponse
{
"allOf": [
{
"$ref": "#/components/schemas/TaskFields"
},
{
"type": "object",
"required": [
"id",
"origin",
"title",
"current_revision_id",
"task_fields_version",
"description_version",
"created_at",
"updated_at",
"document_url",
"revision_url"
],
"properties": {
"created_at": {
"type": "integer",
"format": "int64"
},
"current_revision_id": {
"$ref": "#/components/schemas/Id"
},
"description_version": {
"$ref": "#/components/schemas/Id"
},
"document_url": {
"type": "string"
},
"id": {
"$ref": "#/components/schemas/Id"
},
"origin": {
"$ref": "#/components/schemas/OriginResponse"
},
"revision_url": {
"type": "string"
},
"task_fields_version": {
"$ref": "#/components/schemas/Id"
},
"title": {
"type": "string"
},
"updated_at": {
"type": "integer",
"format": "int64"
}
}
}
]
}ThreadResponseRelated models: Id, MessageResponse
{
"type": "object",
"required": [
"id",
"document_id",
"root",
"reply_count"
],
"properties": {
"document_id": {
"$ref": "#/components/schemas/Id"
},
"id": {
"$ref": "#/components/schemas/Id"
},
"last_reply_at": {
"type": [
"integer",
"null"
],
"format": "int64"
},
"reply_count": {
"type": "integer",
"format": "int64",
"minimum": 0
},
"root": {
"$ref": "#/components/schemas/MessageResponse"
}
}
}ThreadSummaryRelated models: Id
{
"type": "object",
"required": [
"id",
"reply_count"
],
"properties": {
"id": {
"$ref": "#/components/schemas/Id"
},
"last_reply_at": {
"type": [
"integer",
"null"
],
"format": "int64"
},
"reply_count": {
"type": "integer",
"format": "int64",
"minimum": 0
}
}
}TrashSummaryRelated models: Id, OriginResponse, LifecycleState
{
"type": "object",
"required": [
"document_id",
"origin",
"title",
"current_revision_id",
"lifecycle_revision",
"state",
"trashed_at",
"trashed_by",
"created_at",
"updated_at",
"management_url",
"document_url"
],
"properties": {
"created_at": {
"type": "integer",
"format": "int64"
},
"current_revision_id": {
"$ref": "#/components/schemas/Id"
},
"document_id": {
"$ref": "#/components/schemas/Id"
},
"document_url": {
"type": "string"
},
"lifecycle_revision": {
"type": "integer",
"format": "int64",
"minimum": 0
},
"management_url": {
"type": "string"
},
"origin": {
"$ref": "#/components/schemas/OriginResponse"
},
"state": {
"$ref": "#/components/schemas/LifecycleState"
},
"title": {
"type": "string"
},
"trashed_at": {
"type": "integer",
"format": "int64"
},
"trashed_by": {
"$ref": "#/components/schemas/Id"
},
"updated_at": {
"type": "integer",
"format": "int64"
}
}
}TreeMoveReceiptRelated models: Id
{
"type": "object",
"required": [
"operation_id",
"document_id",
"position",
"structure_version",
"effect"
],
"properties": {
"account_id": {
"oneOf": [
{
"type": "null"
},
{
"$ref": "#/components/schemas/Id"
}
]
},
"document_id": {
"$ref": "#/components/schemas/Id"
},
"effect": {
"type": "string"
},
"operation_id": {
"$ref": "#/components/schemas/Id"
},
"parent_document_id": {
"oneOf": [
{
"type": "null"
},
{
"$ref": "#/components/schemas/Id"
}
]
},
"position": {
"type": "integer",
"format": "int64"
},
"space_id": {
"oneOf": [
{
"type": "null"
},
{
"$ref": "#/components/schemas/Id"
}
]
},
"structure_version": {
"$ref": "#/components/schemas/Id"
}
}
}UpdateRequestRelated models: Id
{
"type": "object",
"required": [
"operation_id",
"expected_revision",
"name",
"description"
],
"properties": {
"description": {
"type": "string"
},
"expected_revision": {
"type": "integer",
"format": "int64"
},
"name": {
"type": "string"
},
"operation_id": {
"$ref": "#/components/schemas/Id"
},
"overview_document_id": {
"oneOf": [
{
"type": "null"
},
{
"$ref": "#/components/schemas/Id",
"description": "Omit to preserve the current overview, send null to clear, or a document ID to replace it."
}
]
}
},
"additionalProperties": false
}UploadReceiptRelated models: Id
{
"type": "object",
"required": [
"operation_id",
"resource_id",
"state",
"sha256",
"byte_size",
"content_type",
"content_url"
],
"properties": {
"byte_size": {
"type": "integer",
"format": "int64"
},
"content_type": {
"type": "string"
},
"content_url": {
"type": "string"
},
"operation_id": {
"$ref": "#/components/schemas/Id"
},
"resource_id": {
"$ref": "#/components/schemas/Id"
},
"sha256": {
"type": "string"
},
"state": {
"type": "string"
}
}
}VersionResponse{
"type": "object",
"required": [
"version",
"git_sha"
],
"properties": {
"git_sha": {
"type": "string"
},
"version": {
"type": "string"
}
}
}WorkAction{
"type": "string",
"enum": [
"stop",
"restart"
]
}McpRequest{
"type": "object",
"required": [
"jsonrpc",
"method"
],
"properties": {
"jsonrpc": {
"type": "string",
"const": "2.0"
},
"id": {
"oneOf": [
{
"type": "string"
},
{
"type": "integer"
}
],
"description": "Omit for a notification. Null IDs are not accepted."
},
"method": {
"type": "string",
"description": "initialize, ping, tools/list, tools/call, or a notification method."
},
"params": {
"type": "object",
"description": "Method-specific fields. initialize requires protocolVersion, capabilities, and clientInfo; tools/call requires name and an arguments object."
}
},
"additionalProperties": true
}Authorize a connection, send a request, and check the saved result in Dee.
Make your first request