Note

Reset Paragraph Contents (Dev Only)

Resets one content kind across every paragraph in a note atomically. This endpoint is available only when content editing is enabled in the environment. It is being tested in dev and is not available in production. Requires note:write and permission to edit the note.

original resets plain and speaker-attributed transcripts, including speaker assignments. It preserves translations and paragraph summaries. translated resets only translations. summary resets only paragraph summaries. Note summaries and documents are separate resources and remain unchanged.

Read GET /v1/external/notes/{noteGuid}/paragraphs from the same dev base URL, https://api.tiro-ooo.dev. Production reads omit editState. Copy editState.etag and check editState.canResetByKind for the selected kind. The availability map applies to the entire note, even though it appears on each paragraph. Previous Undo history ends for the reset content. Other content and its Undo history remain available. Original reset also prevents Undo of affected earlier speaker changes. If any target cannot be reset, no paragraph content is changed.

The existing single-paragraph reset keeps its three-field behavior. This operation does not change that endpoint's contract.

post/v1/external/notes/{noteGuid}/paragraphs:reset

Request

  • Base URL: https://api.tiro-ooo.dev
  • URL: https://api.tiro-ooo.dev/v1/external/notes/{noteGuid}/paragraphs:reset
  • Auth: HTTP bearer

Path parameters

noteGuidstring required

GUID of the note whose paragraphs are reset.

Request body

kind'original' | 'translated' | 'summary' required

Content kind to reset across every paragraph.

etagstring required

Exact editState.etag from the latest paragraph read response.

Example request

{
  "kind": "original",
  "etag": "value-from-read-response"
}

Response

Reset completed. Returns the new etag with undoAvailable and canReset set to false for this command target. Read the paragraphs again for updated content and availability for other actions.

etagstring required

Opaque token for the updated content state. Never derive or increment this value.

undoAvailableboolean required

Whether Undo is available for the command target. False after reset.

canResetboolean required

Whether reset is available for the command target. False after reset.

Changes

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