Skip to content
LogoLogo

Discuss

Membership-private persistent conversation with the shared Search Agent.

Capture exact private evidence passages

POST/api/v1/workspaces/{workspace_id}/evidence-collections

Membership-private native work capability. Current Workspace and resource permissions are checked on every request. Responses use Cache-Control: no-store. Requires a browser session and CSRF. Reuse Idempotency-Key only for the same request. Before retrying an uncertain write, resolve its operation receipt. Evidence collections are private, partial investigations. Hydration is required before reuse; references do not authorize shared publication. Changed, unavailable and excluded sources return no text. No inference occurs.

Path Parameters

workspace_idRequired
string <uuid>
Example0198ac5e-f9b7-7000-8000-000000000001

Header Parameters

X-CSRF-TokenRequired
string·min 43·max 43

Session-bound CSRF token. It must exactly match the __Host-assign_csrf cookie sent with the request.

Idempotency-KeyRequired
string·min 16·max 200

Opaque client-generated key for safely retrying this operation.

Request Body

application/json
sourcesRequired
object[]·min 1·max 32

Responses

Replace the exclusion set in one investigation version

POST/api/v1/workspaces/{workspace_id}/evidence-collections/exclusions

Membership-private native work capability. Current Workspace and resource permissions are checked on every request. Responses use Cache-Control: no-store. Requires a browser session and CSRF. Reuse Idempotency-Key only for the same request. Before retrying an uncertain write, resolve its operation receipt. Evidence collections are private, partial investigations. Hydration is required before reuse; references do not authorize shared publication. Changed, unavailable and excluded sources return no text. No inference occurs.

Path Parameters

workspace_idRequired
string <uuid>
Example0198ac5e-f9b7-7000-8000-000000000001

Header Parameters

X-CSRF-TokenRequired
string·min 43·max 43

Session-bound CSRF token. It must exactly match the __Host-assign_csrf cookie sent with the request.

Idempotency-KeyRequired
string·min 16·max 200

Opaque client-generated key for safely retrying this operation.

Request Body

application/json
idRequired
string <uuid>
expected_versionRequired
integer <int64>·min 1
excluded_idsRequired
string <uuid>[]·min 0·max 32

Responses

Read an exact private evidence collection

GET/api/v1/workspaces/{workspace_id}/evidence-collections/{id}

Membership-private native work capability. Current Workspace and resource permissions are checked on every request. Responses use Cache-Control: no-store. Exact versions never refresh or replace selected targets implicitly. Evidence collections are private, partial investigations. Hydration is required before reuse; references do not authorize shared publication. Changed, unavailable and excluded sources return no text. No inference occurs.

Path Parameters

workspace_idRequired
string <uuid>
Example0198ac5e-f9b7-7000-8000-000000000001
idRequired
string <uuid>
Example0198ac5e-f9b7-7000-8000-000000000001

Query Parameters

versionRequired
integer·min 1

Responses

Read up to twenty currently authorized exact passages

GET/api/v1/workspaces/{workspace_id}/evidence-collections/{id}/hydrate

Membership-private native work capability. Current Workspace and resource permissions are checked on every request. Responses use Cache-Control: no-store. Exact versions never refresh or replace selected targets implicitly. Evidence collections are private, partial investigations. Hydration is required before reuse; references do not authorize shared publication. Changed, unavailable and excluded sources return no text. No inference occurs.

Path Parameters

workspace_idRequired
string <uuid>
Example0198ac5e-f9b7-7000-8000-000000000001
idRequired
string <uuid>
Example0198ac5e-f9b7-7000-8000-000000000001

Query Parameters

versionRequired
integer·min 1
offset
integer·min 0·max 31·default 0
limit
integer·min 1·max 20·default 20

Use a smaller page to consume exact passages within a bounded context.

Responses

Resolve the current membership's Discuss access state

GET/api/v1/workspaces/{workspace_id}/discuss/availability

Returns a server-owned feature decision before the client loads private history. Plan labels are presentation metadata; clients must branch on access and reason.

Path Parameters

workspace_idRequired
string <uuid>
Example0198ac5e-f9b7-7000-8000-000000000001

Header Parameters

X-Assign-Realtime-Baseline
string

Upcoming browser-session canonical read. Set to '1' to capture the authorized response and a signed Workspace replay cursor in one snapshot. Apply every required retained read before acknowledging a socket checkpoint. Failed or incomplete reads return no cursor.

Values
1

Responses

List the current membership's private Discuss messages

GET/api/v1/workspaces/{workspace_id}/discuss/messages

Path Parameters

workspace_idRequired
string <uuid>
Example0198ac5e-f9b7-7000-8000-000000000001

Query Parameters

before
integer <int64>·min 1
limit
integer·min 1·max 100·default 50

Responses

Queue one private message for the Discuss supervisor

POST/api/v1/workspaces/{workspace_id}/discuss/messages

Persists the user message and pending assistant turn, then returns without waiting for inference. The same supervisor runtime, native MCP tools and streamed event projection used by POST /discuss/turns complete the turn. Reuse the same Idempotency-Key to retrieve the existing turn without starting another run.

Path Parameters

workspace_idRequired
string <uuid>
Example0198ac5e-f9b7-7000-8000-000000000001

Header Parameters

X-CSRF-TokenRequired
string·min 43·max 43

Session-bound CSRF token. It must exactly match the __Host-assign_csrf cookie sent with the request.

Idempotency-KeyRequired
string·min 16·max 200

Opaque client-generated key for safely retrying this operation.

Request Body

application/json
contentRequired
string·min 1·max 8000
parts
object[]·max 20
context
object

Responses

Resolve a native reference with current Workspace permissions

POST/api/v1/workspaces/{workspace_id}/discuss/references/resolve

Path Parameters

workspace_idRequired
string <uuid>
Example0198ac5e-f9b7-7000-8000-000000000001

Header Parameters

X-CSRF-TokenRequired
string·min 43·max 43

Session-bound CSRF token. It must exactly match the __Host-assign_csrf cookie sent with the request.

Request Body

application/json
kindRequired
string
Values
usertaskdocumentprojectagent
idRequired
string·min 1·max 200

Canonical ID or a Workspace-local editor link locator.

Responses

Reserve a private file in Workspace storage

POST/api/v1/workspaces/{workspace_id}/discuss/uploads

Path Parameters

workspace_idRequired
string <uuid>
Example0198ac5e-f9b7-7000-8000-000000000001

Header Parameters

X-CSRF-TokenRequired
string·min 43·max 43

Session-bound CSRF token. It must exactly match the __Host-assign_csrf cookie sent with the request.

Request Body

application/json
filenameRequired
string·min 1·max 255
content_lengthRequired
integer <int64>·min 1·max 10485760
sha256Required
string

Responses

Verify and complete a private upload

POST/api/v1/workspaces/{workspace_id}/discuss/uploads/{upload_id}/complete

Path Parameters

workspace_idRequired
string <uuid>
Example0198ac5e-f9b7-7000-8000-000000000001
upload_idRequired
string <uuid>
Example0198ac5e-f9b7-7000-8000-000000000001

Header Parameters

X-CSRF-TokenRequired
string·min 43·max 43

Session-bound CSRF token. It must exactly match the __Host-assign_csrf cookie sent with the request.

Request Body

application/json
sha256
string

Lowercase hexadecimal SHA-256 digest.

Responses

Cancel a private upload reservation

DELETE/api/v1/workspaces/{workspace_id}/discuss/uploads/{upload_id}

Path Parameters

workspace_idRequired
string <uuid>
Example0198ac5e-f9b7-7000-8000-000000000001
upload_idRequired
string <uuid>
Example0198ac5e-f9b7-7000-8000-000000000001

Header Parameters

X-CSRF-TokenRequired
string·min 43·max 43

Session-bound CSRF token. It must exactly match the __Host-assign_csrf cookie sent with the request.

Responses

Read private file metadata

GET/api/v1/workspaces/{workspace_id}/discuss/files/{file_id}

Path Parameters

workspace_idRequired
string <uuid>
Example0198ac5e-f9b7-7000-8000-000000000001
file_idRequired
string <uuid>
Example0198ac5e-f9b7-7000-8000-000000000001

Responses

Delete a private file and release its storage

DELETE/api/v1/workspaces/{workspace_id}/discuss/files/{file_id}

Path Parameters

workspace_idRequired
string <uuid>
Example0198ac5e-f9b7-7000-8000-000000000001
file_idRequired
string <uuid>
Example0198ac5e-f9b7-7000-8000-000000000001

Header Parameters

X-CSRF-TokenRequired
string·min 43·max 43

Session-bound CSRF token. It must exactly match the __Host-assign_csrf cookie sent with the request.

Responses

Authorize a private file download

POST/api/v1/workspaces/{workspace_id}/discuss/files/{file_id}/download

Path Parameters

workspace_idRequired
string <uuid>
Example0198ac5e-f9b7-7000-8000-000000000001
file_idRequired
string <uuid>
Example0198ac5e-f9b7-7000-8000-000000000001

Header Parameters

X-CSRF-TokenRequired
string·min 43·max 43

Session-bound CSRF token. It must exactly match the __Host-assign_csrf cookie sent with the request.

Responses

Authorize a private file preview

POST/api/v1/workspaces/{workspace_id}/discuss/files/{file_id}/preview

Path Parameters

workspace_idRequired
string <uuid>
Example0198ac5e-f9b7-7000-8000-000000000001
file_idRequired
string <uuid>
Example0198ac5e-f9b7-7000-8000-000000000001

Header Parameters

X-CSRF-TokenRequired
string·min 43·max 43

Session-bound CSRF token. It must exactly match the __Host-assign_csrf cookie sent with the request.

Responses

Persist a private turn for server-owned generation

POST/api/v1/workspaces/{workspace_id}/discuss/turns

Admits the turn immediately and orders its response behind any active foreground run. Standalone greetings receive a source-independent reply after authorization. Greetings containing a substantive question or resource references use normal evidence retrieval.

Path Parameters

workspace_idRequired
string <uuid>
Example0198ac5e-f9b7-7000-8000-000000000001

Header Parameters

X-CSRF-TokenRequired
string·min 43·max 43

Session-bound CSRF token. It must exactly match the __Host-assign_csrf cookie sent with the request.

Idempotency-KeyRequired
string·min 16·max 200

Opaque client-generated key for safely retrying this operation.

Request Body

application/json
contentRequired
string·max 8000
parts
object[]·max 4

Optional per-turn metadata only: task_selection with selection_id (Core freezes result_set_id/version), turn_preferences with locale and IANA timezone, evidence_collection with exact id/version, or search_result with query and result_version from the first 20 unfiltered work results. At most one of each. Evidence collection pins require current private ownership and the latest version; stale pins return revision_conflict before admission. Identical acknowledged retries recover the historical handle without granting current source authority. Core repeats and reauthorizes that lexical query before Send; a changed version returns revision_conflict without admitting a turn. Search metadata grants no action authority or exhaustive coverage. Other part types or fields are rejected.

entity_references
object[]·max 5

attachment_ids
string <uuid>[]·max 5

Clean files in the caller's private stream; at most 20 MiB combined. Empty content requires at least one file.

context
object

Responses

Create a private GPT Live WebRTC session

POST/api/v1/workspaces/{workspace_id}/discuss/voice/sessions

Exchanges a browser WebRTC offer for a server-configured GPT Live answer. The OpenAI API key remains on the private Knowledge service. Assign selects the model, disables provider storage, supplies bounded private Discuss history, and configures client delegation back into canonical Discuss. The client must wait for session.started before treating voice as ready.

Path Parameters

workspace_idRequired
string <uuid>
Example0198ac5e-f9b7-7000-8000-000000000001

Header Parameters

X-CSRF-TokenRequired
string·min 43·max 43

Session-bound CSRF token. It must exactly match the __Host-assign_csrf cookie sent with the request.

Request Body

application/json
sdpRequired
string·min 1·max 65536

Browser WebRTC SDP offer after ICE gathering completes.

locale
string·min 2·max 35

Optional BCP 47 locale hint.

spoken_response_mode
string·default full

Account playback policy for generated voice output.

Values
offconfirmationsfull
confirmation_level
string·default standard

Account safety preference for how readily Voice asks before actions.

Values
standardconfirm_more

Responses

Replay up to 100 ordered private message changes

GET/api/v1/workspaces/{workspace_id}/discuss/events

Path Parameters

workspace_idRequired
string <uuid>
Example0198ac5e-f9b7-7000-8000-000000000001

Query Parameters

after
integer <int64>·min 0·default 0

Responses

Resolve one exact private message

GET/api/v1/workspaces/{workspace_id}/discuss/messages/{message_id}

Path Parameters

workspace_idRequired
string <uuid>
Example0198ac5e-f9b7-7000-8000-000000000001
message_idRequired
string <uuid>
Example0198ac5e-f9b7-7000-8000-000000000001

Responses

List safe activity for one private Discuss response

GET/api/v1/workspaces/{workspace_id}/discuss/messages/{message_id}/run-events

Returns a bounded run-local sequence containing only user-visible lifecycle events and sanitized tool activity. Raw tool arguments/results, prompts, credentials, internal events and hidden reasoning are never returned. Current Workspace membership is rechecked on every request.

Path Parameters

workspace_idRequired
string <uuid>
Example0198ac5e-f9b7-7000-8000-000000000001
message_idRequired
string <uuid>
Example0198ac5e-f9b7-7000-8000-000000000001

Query Parameters

after
integer <int64>·min 0·default 0
limit
integer·min 1·max 100·default 100

Responses

Request an exact stop for a queued or running response

POST/api/v1/workspaces/{workspace_id}/discuss/messages/{message_id}/cancel

Queued work becomes cancelled immediately. Running work first reports cancel_requested; its terminal message and run state are reconciled after execution has stopped. A completed action and its receipt are never described as rolled back.

Path Parameters

workspace_idRequired
string <uuid>
Example0198ac5e-f9b7-7000-8000-000000000001
message_idRequired
string <uuid>
Example0198ac5e-f9b7-7000-8000-000000000001

Header Parameters

X-CSRF-TokenRequired
string·min 43·max 43

Session-bound CSRF token. It must exactly match the __Host-assign_csrf cookie sent with the request.

Responses

List private specialist work linked to Discuss

GET/api/v1/workspaces/{workspace_id}/discuss/specialist-runs

Returns bounded projections from canonical Agent and hosted work-session journals. Provider transcripts, prompts, leases and internal execution state are excluded.

Path Parameters

workspace_idRequired
string <uuid>
Example0198ac5e-f9b7-7000-8000-000000000001

Query Parameters

limit
integer·min 1·max 50·default 20

Header Parameters

X-Assign-Realtime-Baseline
string

Upcoming browser-session canonical read. Set to '1' to capture the authorized response and a signed Workspace replay cursor in one snapshot. Apply every required retained read before acknowledging a socket checkpoint. Failed or incomplete reads return no cursor.

Values
1

Responses

Get one private Discuss specialist run

GET/api/v1/workspaces/{workspace_id}/discuss/specialist-runs/{specialist_run_id}

Path Parameters

workspace_idRequired
string <uuid>
Example0198ac5e-f9b7-7000-8000-000000000001
specialist_run_idRequired
string <uuid>
Example0198ac5e-f9b7-7000-8000-000000000001

Header Parameters

X-Assign-Realtime-Baseline
string

Upcoming browser-session canonical read. Set to '1' to capture the authorized response and a signed Workspace replay cursor in one snapshot. Apply every required retained read before acknowledging a socket checkpoint. Failed or incomplete reads return no cursor.

Values
1

Responses

Request cooperative cancellation of specialist work

POST/api/v1/workspaces/{workspace_id}/discuss/specialist-runs/{specialist_run_id}/cancel

Routes cancellation through the bound canonical Agent or work-session journal. A terminal completion may still win a concurrent stop request.

Path Parameters

workspace_idRequired
string <uuid>
Example0198ac5e-f9b7-7000-8000-000000000001
specialist_run_idRequired
string <uuid>
Example0198ac5e-f9b7-7000-8000-000000000001

Header Parameters

X-CSRF-TokenRequired
string·min 43·max 43

Session-bound CSRF token. It must exactly match the __Host-assign_csrf cookie sent with the request.

Responses

Resolve one AG-UI specialist interrupt

POST/api/v1/workspaces/{workspace_id}/discuss/specialist-runs/{specialist_run_id}/resume

Resolves the current canonical work-session clarification or approval. Core reloads the interaction kind and request digest; client metadata cannot widen or replace them. Exact resolved-answer replays are idempotent at the work-session journal.

Path Parameters

workspace_idRequired
string <uuid>
Example0198ac5e-f9b7-7000-8000-000000000001
specialist_run_idRequired
string <uuid>
Example0198ac5e-f9b7-7000-8000-000000000001

Header Parameters

X-CSRF-TokenRequired
string·min 43·max 43

Session-bound CSRF token. It must exactly match the __Host-assign_csrf cookie sent with the request.

Request Body

application/json
interruptIdRequired
string <uuid>

Opaque Assign-owned UUIDv7 identifier. Clients must not derive meaning from it.

Example0198ac5e-f9b7-7000-8000-000000000001
statusRequired
string
Values
resolved
payloadRequired
object

Responses

Resolve one version-fenced private clarification or approval

POST/api/v1/workspaces/{workspace_id}/discuss/interactions/{interaction_id}/decision

The first valid decision wins. Expired interactions or interactions whose bound message revision changed become stale and cannot resume work.

Path Parameters

workspace_idRequired
string <uuid>
Example0198ac5e-f9b7-7000-8000-000000000001
interaction_idRequired
string <uuid>
Example0198ac5e-f9b7-7000-8000-000000000001

Header Parameters

X-CSRF-TokenRequired
string·min 43·max 43

Session-bound CSRF token. It must exactly match the __Host-assign_csrf cookie sent with the request.

Idempotency-KeyRequired
string·min 16·max 200

Opaque client-generated key for safely retrying this operation.

Request Body

application/json
proposal
object

Explicitly review this exact current version of the same ChangeSet bound to the approval. Core atomically updates the binding and admits the continuation; editing alone never approves. Omit for existing unchanged approvals and clarifications.

expected_revisionRequired
integer <int64>·min 1
decisionRequired
string·min 1·max 4000

Responses

Search the current membership's private Discuss history

GET/api/v1/workspaces/{workspace_id}/discuss/messages/search

Path Parameters

workspace_idRequired
string <uuid>
Example0198ac5e-f9b7-7000-8000-000000000001

Query Parameters

qRequired
string·min 2·max 200

Responses

Advance the current membership's Discuss read position

POST/api/v1/workspaces/{workspace_id}/discuss/read-state

Path Parameters

workspace_idRequired
string <uuid>
Example0198ac5e-f9b7-7000-8000-000000000001

Header Parameters

X-CSRF-TokenRequired
string·min 43·max 43

Session-bound CSRF token. It must exactly match the __Host-assign_csrf cookie sent with the request.

Request Body

application/json
through_sequenceRequired
integer <int64>·min 0

Responses

Read private Discuss schedule, ceremony, delivery, and wording preferences

GET/api/v1/workspaces/{workspace_id}/discuss/preferences

Path Parameters

workspace_idRequired
string <uuid>
Example0198ac5e-f9b7-7000-8000-000000000001

Responses

Replace private Discuss preferences at an exact revision

PATCH/api/v1/workspaces/{workspace_id}/discuss/preferences

Path Parameters

workspace_idRequired
string <uuid>
Example0198ac5e-f9b7-7000-8000-000000000001

Header Parameters

X-CSRF-TokenRequired
string·min 43·max 43

Session-bound CSRF token. It must exactly match the __Host-assign_csrf cookie sent with the request.

Request Body

application/json
timezoneRequired
string·min 1·max 100

IANA timezone used only by this Workspace membership's Discuss schedule.

timezone_inherited
boolean

When true, timezone tracks the Account timezone and is returned as the resolved effective value.

workday_startRequired
string
workday_endRequired
string
workweekRequired
integer[]·min 1·max 7
start_day_enabledRequired
boolean
end_day_enabledRequired
boolean
end_week_enabledRequired
boolean
push_enabledRequired
boolean

Conservative master opt-in; existing notification/device policies still apply.

personalityRequired
string
Values
concisefriendlyprofessionalgrumpy
revisionRequired
integer <int64>·min 1

Responses

List the current membership's private work reminders

GET/api/v1/workspaces/{workspace_id}/discuss/reminders

Path Parameters

workspace_idRequired
string <uuid>
Example0198ac5e-f9b7-7000-8000-000000000001

Responses

Create an explicitly confirmed private work reminder

POST/api/v1/workspaces/{workspace_id}/discuss/reminders

Path Parameters

workspace_idRequired
string <uuid>
Example0198ac5e-f9b7-7000-8000-000000000001

Header Parameters

X-CSRF-TokenRequired
string·min 43·max 43

Session-bound CSRF token. It must exactly match the __Host-assign_csrf cookie sent with the request.

Request Body

application/json
titleRequired
string·min 1·max 500
note
string·max 4000·default
subject
object
due_atRequired
string <date-time>
timezoneRequired
string·min 1·max 100

Responses

Complete, cancel, or snooze one private reminder

PATCH/api/v1/workspaces/{workspace_id}/discuss/reminders/{reminder_id}

Path Parameters

workspace_idRequired
string <uuid>
Example0198ac5e-f9b7-7000-8000-000000000001
reminder_idRequired
string <uuid>
Example0198ac5e-f9b7-7000-8000-000000000001

Header Parameters

X-CSRF-TokenRequired
string·min 43·max 43

Session-bound CSRF token. It must exactly match the __Host-assign_csrf cookie sent with the request.

Request Body

application/json
stateRequired
string
Values
scheduledcompletedsnoozedcancelled
due_at
string <date-time>

Required for snooze and ignored otherwise.

revisionRequired
integer <int64>·min 1

Responses