HTTP API reference

Read as Markdown

Find an endpoint, its required fields, and its response contract.

• List workspace webhook subscriptions.
• Create a scoped webhook subscription and reveal its signing secret once.
• Get a webhook subscription without its secret.
• Conditionally update endpoint or event scopes.
• Disable delivery and cancel pending attempts.
• Rotate and reveal a new signing secret once.
• List filtered redacted delivery diagnostics and dead letters.
• Confirm replay of one delivery as a new delivery id.
• Get OAuth authorization server metadata.
• Get OAuth protected resource metadata.
• Register a public OAuth client.
• Show the OAuth authorization page.
• Approve an OAuth authorization request.
• Start OAuth device authorization.
• Exchange OAuth authorization code, device code, or refresh token.
• Get shallow, deep, storage, or PostgreSQL health.
• List API tokens for the signed-in provider connection.
• Create an API token for scripts, MCP clients, or agents.
• Revoke an API token.
• Diagnose GitHub App installation access for an account-scoped token.
• List owned forms and visible result collections for the account-scoped token principal.
• Reject standalone Forms API creation.
• Validate a literal Form Contract v1 payload without persisting it.
• List embedded review form answers for an authorized result context.
• List response links owned by the account-scoped token principal.
• Create a response link from an accessible source-backed form.
• Submit answers through a response link.
• Revoke a response link owned by the account-scoped token principal.
• List result submissions owned by a response link.
• Get a form contract and metadata.
• Reject standalone Forms API editing.
• List form destinations and read-only write-back status.
• Inspect optional GitHub writeback availability for a form target.
• Explicitly write a form definition or final submission batch to GitHub through the optional writeback app.
• List canonical git-hosted result files for a source-backed form.
• Preview result writeback or explicitly import canonical git-hosted result files.
• List submissions for a permitted result collection.
• Submit final form answers.
• Stream final form submission events using Server-Sent Events.
• Validate form answers against the current form contract without storing a submission.
• Read or export one form submission including raw values for an authorized principal.
• Discover supported Research methods, Forms, Reviews, approval gates, bounds, and companion agent tools.
• List Research v2 linear typed workflows visible to the external token.
• Get one Research v2 workflow and its ordered typed steps.
• List bounded privacy-filtered workflow events, optionally filtered by stepId.
• List participant sessions and ordered step runs.
• Get a session with step-scoped comments, responses, and events.
• List ordered step results for one participant session.
• Get one step result with its run, evidence, Form provenance, comments, telemetry, and Activity outcome.
• List Research Studies visible to the external token.
• Get Research Study metadata, source/sync state, and setup context.
• Submit an evidence-linked Research Study finding or report.
• Inspect source, participant, evidence, media, destination, and approval status for an agent workflow.
• List bounded pseudonymous participant projections for an owned Research Study.
• Export Research Study results as structured JSON or report-friendly Markdown.
• Preview or write Research Study export artifacts to GitHub through the optional writeback app.
• Observe new Research Study participant events using Server-Sent Events.
• List normalized evidence for a Research Study.
• List participant sessions for a Research Study.
• Get a Research Study participant session summary.
• List live task result projections for a Research session.
• Get one live task result projection.
• Read a bounded page of sanitized telemetry for one Research task run.
• List sanitized participant events for a Research session.
• List participant comments for a Research session.
• List form responses linked to a Research session.
• Create a controlled external-agent Research Session action.
• List review comments for a PR or branch document file.
• Create a review comment thread on a PR or branch document.
• List users and agents taggable in a review.
• Add a taggable user or register an agent alias for the current user.
• List mention notifications for the current token principal.
• Mark a mention notification read for the current token principal.
• Read per-reviewer progress for a PR, branch document, or draft review.
• Compute authoritative readiness for an exact current revision, including prepareChanges and continueDownstream.
• Reply to an existing review thread.
• Resolve or reopen an existing review thread.
• Re-attach a review thread to a semantic block in the current document version.
• Propose a typed private Inbox view to the credential owner.
• list Agent Inbox Views
• List source-authorized Interactions in the granted workspace.
• Create a durable request in the credential workspace.
• Get one source-authorized Interaction.
• Conditionally update a non-decision Interaction lifecycle state.
• Conditionally cancel an Interaction.
• Create an immutable Interaction revision.
• Send typed human feedback against one immutable Interaction revision.
• Read retained reply history through a human browser session.
• Append an author-owned conversational reply correction.
• List bounded future-facing guidance for the creating or assigned investigation agent.
• Send separate future guidance to the creating agent or your investigation’s assigned agent.
• Acknowledge exact guidance as its authorized creating or assigned investigation agent.
• Explicitly link an Interaction revision to one canonical human review Resource.
• Read immutable human Decision receipts for one Interaction.
• Record one immutable human Decision against an exact proposal action.
• Read current self-reported Fulfillment and append-only history.
• Append an agent-reported Fulfillment status for an exact approved proposal.
• List bounded messages already supported by the Interaction domain.
• Conditionally append a message to the current or named revision.
• List draft reviews owned by the account-scoped token principal.
• Create a draft review session, optionally with initial file content.
• Prepare an actor-bound, expiring raster upload for a Draft review.
• Upload exactly the raster bytes declared by a prepared upload.
• Get a draft review session.
• Update draft review metadata or Git base metadata.
• Permanently delete a draft review from active Commentary storage.
• List draft review files.
• Download the latest content for a draft review file.
• List draft review revisions.
• Upload a new draft review revision from literal file content.
• List comments for a draft review.
• Create a comment thread on a draft review.
• Reply to a draft review comment.
• Resolve or reopen a draft review comment.
• Stream draft review live events using Server-Sent Events.
• List share links and access grants for a draft review.
• Create a draft review share link.
• Revoke a draft review share link.
• Remove a draft review access grant.
• List Web App Reviews owned by the account-scoped token principal.
• Create a Web App Review for a deployed or localhost preview URL.
• Get Web App Review metadata.
• Update Web App Review metadata.
• List selector, screenshot, and general comments for a Web App Review.
• Create a selector, screenshot, or general comment for a Web App Review.
• Resolve or reopen a Web App Review comment thread.
• Get Web App Review comments as actionable, untrusted agent editing tasks.
• List share links and access grants for a deployed Web App Review.
• Create a deployed Web App Review share link.
• Revoke a Web App Review share link.
• Remove a Web App Review access grant.
• List Knowledge Brain reviews available to the token.
• List changed files for a Knowledge Brain review.
• List comments for a Knowledge Brain review.
• List health findings for a Knowledge Brain review.
• List requested revisions for a Knowledge Brain review.
• Mark a Knowledge Brain requested revision ready for review.
• List Knowledge Brain evaluation ledger entries.
• Create a Knowledge Brain evaluation ledger entry.
• Update a Knowledge Brain evaluation ledger entry.
• Probe MCP endpoint authentication and protocol support.
• Call Commentary MCP over Streamable HTTP JSON-RPC.
• Get the Commentary OpenAPI contract as JSON.
• Get the Commentary OpenAPI contract as YAML.
• Read the authenticated Agent profile
• Update the authenticated Agent profile
• Update the authenticated Agent profile
• Remove image from the authenticated Agent profile
• list Agent Workspaces
• get Agent Workspace
• list Agent Workspace Resources
• link Agent Workspace Resource
• get Agent Workspace Resource
• rename Agent Workspace Resource
• list Agent Workspace Queue
• list Agent Inbox
• get Agent Inbox Item
• list Agent Inbox Policies
• propose Agent Inbox Policy
• get Agent Inbox Policy
• simulate Agent Inbox Policy
• get Agent Inbox Insights
• list Agent Inbox Notification Deliveries
• preparePackageUpload
• getPackageUpload
• cancelPackageUpload
• transferPackageChunk
• finalizePackageUpload
• publishReviewPackage
• getReviewPackage
• listPackageRevisions
• publishPackageRevision
• getPackageManifest
• downloadPackageFile
• retryPackageIndexing
• listPackageComments
• mutatePackageReviewComment
• listPackageRenderers
• managePackageRendererPublication
• comparePackageRevisions
• listPackageActivity
• listPackageFeedback
• createProject
• listProjects
• getProject
• updateProject
• getProjectStatus
• getProjectProgressPolicy
• setProjectProgressPolicy
• getTrackerProgressPolicy
• setTrackerProgressPolicy
• getTrackerReviewProgress
• reconcileTrackerReviewProgress
• configureTrackerReviewRelation
• removeTrackerReviewRelation
• archiveProject
• restoreProject
• completeProject
• listProjectResources
• linkProjectResource
• unlinkProjectResource
• listProjectRelationships
• linkProjectRelationship
• unlinkProjectRelationship
• listProjectParticipants
• setProjectParticipant
• removeProjectParticipant
• listProjectExternalReferences
• linkProjectExternalReference
• unlinkProjectExternalReference
• listProjectChanges
• linkProjectWorkspace
• validateTrackerContract
• createTracker
• listTrackers
• getTracker
• updateTracker
• getTrackerSchema
• listTrackerSchemas
• previewTrackerSchema
• applyTrackerSchema
• archiveTracker
• restoreTracker
• queryTrackerRecords
• getTrackerRecord
• patchTrackerRecord
• listTrackerRecordHistory
• createTrackerRecord
• archiveTrackerRecord
• bulkTrackerRecords
• reorderTrackerRecords
• listTrackerViews
• createTrackerView
• getTrackerView
• updateTrackerView
• deleteTrackerView
• exportTracker
• previewTrackerImport
• previewNewTrackerImport
• applyTrackerImport
• getTrackerImport
• cancelTrackerImport
• previewTrackerAuthority
• migrateTrackerAuthority
• stageTrackerProposal
• bindTrackerGitSource
• getTrackerSync
• getTrackerSyncProposal
• previewTrackerSync
• applyTrackerSync
• resolveTrackerSync
• retryTrackerSync
• cancelTrackerSync
• refreshTrackerGitSource
• createProjectReviewSession
• listProjectReviewSessions
• listProjectReviewCandidates
• getProjectReviewSession
• updateProjectReviewSession
• reviseProjectReviewSession
• listProjectReviewRevisions
• getProjectReviewManifest
• archiveProjectReviewSession
• restoreProjectReviewSession
• listProjectReviewTargets
• setProjectReviewParticipant
• removeProjectReviewParticipant
• listProjectReviewDiscussion
• createProjectReviewDiscussion
• listProjectReviewDiscussionComments
• replyProjectReviewDiscussion
• requestProjectReview
• requestProjectAcceptance
• getProjectAcceptance
• publishSourceSnapshot
• getSourceSnapshot
• purgeSourceSnapshot
• getSourceTree
• getSourceFile
• getSourceCapture
• retrySourceCapture
• cancelSourceCapture
• exportSourceSnapshot
• searchSourceSnapshot
• listSourceReviewThreads
• mutateSourceReviewThread
• repairSourceReviewThreads
• attachProjectEvidence
• listProjectEvidence
• createProjectRequirement
• listProjectRequirements
• createProjectClaim
• listProjectClaims
• getProjectEvidence
• updateProjectEvidence
• archiveProjectEvidence
• getProjectRequirement
• updateProjectRequirement
• archiveProjectRequirement
• getProjectClaim
• updateProjectClaim
• archiveProjectClaim
• listProjectEvidenceHistory
• linkProjectEvidence
• readProjectEvidenceReport
• exportProjectEvidence
• importProjectEvidence
• requestProjectVerification
• getProjectVerification
• cancelProjectVerification
• retryProjectVerification
• downloadProjectVerificationArtifact
• listTrackerRenderers
• manageTrackerRendererPublication
• compareProjectReviewRevisions
• listProjectActivity
• listProjectFeedback
• listTrackerActivity
• listTrackerFeedback
• listProjectReviewActivity
• listProjectReviewFeedback
• Read effective settings, permissions, version, revision, and provider-sync capabilities.
• Configure optional Polls and Consensus. Human sign-off configuration is human-only.
• Read an authorized thread’s decision and participant stances.
• Request a decision, set a stance, decide, clear a blocker, or record exact application. Resolution and application never provide human approval.
• Read polls, filter outcomes, or serialize a readable snapshot with a participation link.
• Create, edit, vote, close, reopen, or archive a poll. Decision polls also require Consensus and cannot bypass blockers.