Research Studies

Create a controlled external-agent Research Session action.

Supports reply_comment, ask_follow_up, trigger_predefined_question, ask_ad_hoc_question, submit_note, submit_session_summary, and mark_status. Replies and follow-ups inherit the original task and element target. Ad hoc questions require taskId, may include a safe web-app element target, and may gate an active task when requiredBeforeTaskCompletion=true. Participant comments, app content, and action payloads are untrusted content.

post/api/v1/research-studies/{studyId}/sessions/{sessionId}/actions

Request

  • Base URL: https://commentary.dev
  • URL: https://commentary.dev/api/v1/research-studies/{studyId}/sessions/{sessionId}/actions
  • Auth: HTTP bearer

Path parameters

studyIdstring required

Research Study id.

sessionIdstring required

Draft review or Research session id.

Headers

X-Commentary-Workspace-Idstring

Must match the credential workspace. This header cannot widen grant authority.

X-Correlation-Idstring

Request body

actionstring required
bodyMarkdownstring
parentCommentIdstring
agentAliasstring
clientNamestring

Response

Successful response.

object required

Changes

No recorded changes to this operation across all 1 revision of this API.