> ## Documentation Index
> Fetch the complete documentation index at: https://docs.corti.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# document.dictationStarted

> Emitted when document dictation starts.

## Event Properties

| Field | Value |
| - | - |
| `event` | `"document.dictationStarted"` |
| `confidential` | `boolean` |
| `payload` | `object` |

<Tabs>
  <Tab title="Public Payload">
    | Field | Type | Description |
    | - | - | - |
    | `sectionKey` | `string` | Which section dictation is targeting |
    | `documentId` | `string` | Unique document identifier |
    | `documentType` | `"legacy" \| "guided"` | Document generation type |
    | `documentName` | `string` | Document name or title |
    | `outputLanguage` | `string` | Output language code (e.g., "en", "de") |
    | `templateType` | `"built-in" \| "custom" \| "schema-driven"` | Type of template used: built-in, custom, or schema-driven |
    | `templateId` | `string` | Template identifier (either ref for built-in or customTemplateId for custom) |
    | `documentLabels` | `Record<string, string>` | Key/value labels attached to the document |
    | `interactionId` | `string` | Unique interaction identifier |
    | `interactionState` | `InteractionState` | Current state of the interaction |

    #### Example

    ```json theme={null}
    {
      "event": "document.dictationStarted",
      "confidential": false,
      "payload": {
        "sectionKey": "assessment",
        "documentId": "doc_123",
        "documentType": "legacy",
        "documentName": "SOAP note",
        "outputLanguage": "en",
        "templateType": "built-in",
        "templateId": "soap",
        "documentLabels": {},
        "interactionId": "int_123",
        "interactionState": "ongoing"
      }
    }
    ```
  </Tab>

  <Tab title="Confidential Payload">
    | Field | Type | Description |
    | - | - | - |
    | `sectionKey` | `string` | Which section dictation is targeting |
    | `document` | `ExternalPatientDocument` | Complete document object with all sections and metadata |
    | `interaction` | `ExternalInteraction` | Interaction context including transcripts, documents, and facts |

    <Accordion title="document object properties">
      | Field | Type | Description |
      | - | - | - |
      | `id` | `string` | Unique document identifier |
      | `documentType` | `"legacy" \| "guided"` | Document generation type |
      | `name` | `string` | Document name or title |
      | `outputLanguage` | `string` | Output language code (e.g., "en", "de") |
      | `sections` | `Section[]` | Document sections containing the generated content |
      | `templateType` | `"built-in" \| "custom" \| "schema-driven"` | Type of template used: built-in, custom, or schema-driven |
      | `templateId` | `string` | Template identifier (either ref for built-in or customTemplateId for custom) |
      | `labels` | `Record<string, string>` | Key/value labels attached to the document |

      **Section properties:**

      | Field | Type | Description |
      | - | - | - |
      | `key` | `string` | Unique key identifying the section type |
      | `name` | `string` | Display name of the section |
      | `text` | `string` | Section content in markdown or plain text |
      | `structuredOutput` | `unknown` | Structured output for guided documents, null for legacy documents |
      | `labels` | `Record<string, string>` | Key/value labels attached to the section |
    </Accordion>

    <Accordion title="interaction object properties">
      | Field | Type | Description |
      | - | - | - |
      | `id` | `string` | Unique interaction identifier |
      | `title` | `string \| null` | Interaction title |
      | `state` | `InteractionState` | Current state of the interaction |
      | `startedAt` | `string (ISO 8601 date)` | When the interaction started (ISO 8601 date string) |
      | `transcriptCount` | `number` | Number of transcripts in the interaction |
      | `documentCount` | `number` | Number of documents in the interaction |
      | `facts` | `Fact[]` | Facts extracted during the interaction |

      **Fact properties:**

      | Field | Type | Description |
      | - | - | - |
      | `id` | `string` | Unique fact identifier |
      | `text` | `string` | Fact text content |
      | `group` | `string` | Fact group/category name |
      | `source` | `"core" \| "system" \| "user"` | Source of the fact: core (AI extracted), system, or user |
      | `isDiscarded` | `boolean` | Whether the fact has been discarded |
    </Accordion>

    #### Example

    ```json theme={null}
    {
      "event": "document.dictationStarted",
      "confidential": true,
      "payload": {
        "sectionKey": "assessment",
        "document": {
          "id": "doc_123",
          "documentType": "legacy",
          "name": "SOAP note",
          "outputLanguage": "en",
          "sections": [
            {
              "key": "hpi",
              "name": "HPI",
              "text": "...",
              "structuredOutput": null,
              "labels": {}
            }
          ],
          "templateType": "built-in",
          "templateId": "soap",
          "labels": {}
        },
        "interaction": {
          "id": "int_123",
          "title": "Visit",
          "state": "ongoing",
          "startedAt": "2024-01-01T00:00:00.000+00:00",
          "transcriptCount": 0,
          "documentCount": 0,
          "facts": []
        }
      }
    }
    ```
  </Tab>
</Tabs>


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.