openapi: 3.0.0 info: title: Corti API version: 2.0.0 servers: - url: https://api.{environment}.corti.app/v2/ variables: environment: default: eu enum: - us - eu paths: /interactions/: get: operationId: interactions_list responses: '200': description: '' content: application/json: schema: $ref: '#/components/schemas/InteractionsListResponse' '403': description: RFC9457 content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '504': description: RFC9457 content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' tags: - Interactions summary: List All Interactions description: Lists all existing interactions. Results can be filtered by encounter status and patient identifier. parameters: - $ref: '#/components/parameters/Tenant-Name' - name: sort in: query description: Field used to sort interactions. Default is createdAt. schema: type: string description: Field used to sort interactions. Default is createdAt. default: createdAt enum: - id - assignedUserId - patient - createdAt - endedAt - updatedAt - name: direction in: query description: 'Sorting order. Allowed values: [asc, desc]. Default is desc.' schema: $ref: '#/components/schemas/CommonSortingDirectionEnum' - name: pageSize in: query description: Number of interactions to return per page. Must be greater than 0. Default is 10. schema: type: integer format: int64 description: Number of interactions to return per page. Must be greater than 0. Default is 10. - name: index in: query description: Page number to retrieve. Starts at 1. For example, index=2 with pageSize=10 will return interactions 11–20. Must be greater than 0. Default is 1. schema: type: integer format: int64 description: Page number to retrieve. Starts at 1. For example, index=2 with pageSize=10 will return interactions 11–20. Must be greater than 0. Default is 1. - name: encounterStatus in: query description: The status of the encounter. To filter on multiple statuses, pass the same parameter again. schema: type: array description: The status of the encounter. To filter on multiple statuses, pass the same parameter again. items: $ref: '#/components/schemas/InteractionsEncounterStatusEnum' style: form explode: true - name: patient in: query description: A unique identifier for the patient. schema: type: string description: A unique identifier for the patient. post: operationId: interactions_create responses: '201': description: Returns the newly created interaction with its assigned ID and WebSocket URL for real-time data streaming. content: application/json: schema: $ref: '#/components/schemas/InteractionsCreateResponse' '400': description: RFC9457 content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '403': description: RFC9457 content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '500': description: RFC9457 content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '504': description: RFC9457 content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' tags: - Interactions summary: Create Interaction description: Creates a new interaction. parameters: - $ref: '#/components/parameters/Tenant-Name' requestBody: content: application/json: schema: $ref: '#/components/schemas/InteractionsCreateRequest' required: true /interactions/{id}: get: operationId: interactions_get responses: '200': description: Returns the requested interaction with all associated details. content: application/json: schema: $ref: '#/components/schemas/InteractionsGetResponse' '403': description: RFC9457 content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '504': description: RFC9457 content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' tags: - Interactions summary: Get Existing Interaction description: Retrieves a previously recorded interaction by its unique identifier (interaction ID). parameters: - $ref: '#/components/parameters/Tenant-Name' - $ref: '#/components/parameters/CommonInteractionId' patch: operationId: interactions_update responses: '200': description: A request body containing the fields to update within the interaction. content: application/json: schema: $ref: '#/components/schemas/InteractionsGetResponse' '403': description: RFC9457 content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '504': description: RFC9457 content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' tags: - Interactions summary: Update Interaction description: Modifies an existing interaction by updating specific fields without overwriting the entire record. parameters: - $ref: '#/components/parameters/Tenant-Name' - $ref: '#/components/parameters/CommonInteractionId' requestBody: content: application/json: schema: $ref: '#/components/schemas/InteractionsUpdateRequest' required: true delete: operationId: interactions_delete responses: '204': description: The interaction was successfully deleted. No response body is returned. '403': description: RFC9457 content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '504': description: RFC9457 content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' tags: - Interactions summary: Delete Interaction description: Deletes an existing interaction. parameters: - $ref: '#/components/parameters/Tenant-Name' - $ref: '#/components/parameters/CommonInteractionId' /interactions/{id}/recordings/: get: operationId: recordings_list responses: '200': description: Returns a list of recording IDs for the interaction. content: application/json: schema: $ref: '#/components/schemas/RecordingsListResponse' '400': description: RFC9457 content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '403': description: RFC9457 content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '500': description: RFC9457 content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '504': description: RFC9457 content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' tags: - Recordings summary: List Recordings description: Retrieve a list of recordings for a given interaction. parameters: - $ref: '#/components/parameters/Tenant-Name' - $ref: '#/components/parameters/CommonInteractionId' post: operationId: recordings_upload responses: '201': description: Returns the recording ID in the response. content: application/json: schema: $ref: '#/components/schemas/RecordingsCreateResponse' '400': description: RFC9457 content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '403': description: RFC9457 content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '500': description: RFC9457 content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '504': description: RFC9457 content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' tags: - Recordings summary: Upload Recording description: Upload a recording for a given interaction. There is a maximum limit of 60 minutes in length and 150MB in size for recordings. parameters: - $ref: '#/components/parameters/Tenant-Name' - $ref: '#/components/parameters/CommonInteractionId' requestBody: content: application/octet-stream: schema: type: string format: binary description: Recording title: Recording required: true /interactions/{id}/recordings/{recordingId}: get: operationId: recordings_get responses: '200': description: Binary content of the recording file. content: text/plain: schema: type: string format: binary '400': description: RFC9457 content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '403': description: RFC9457 content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '404': description: RFC9457 content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '500': description: RFC9457 content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '504': description: RFC9457 content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' tags: - Recordings summary: Get Recording description: Retrieve a specific recording for a given interaction. parameters: - $ref: '#/components/parameters/Tenant-Name' - $ref: '#/components/parameters/CommonInteractionId' - $ref: '#/components/parameters/CommonRecordingId' delete: operationId: recordings_delete responses: '204': description: '' '403': description: RFC9457 content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '404': description: RFC9457 content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '500': description: RFC9457 content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '504': description: RFC9457 content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' tags: - Recordings summary: Delete Recording description: Delete a specific recording for a given interaction. parameters: - $ref: '#/components/parameters/Tenant-Name' - $ref: '#/components/parameters/CommonInteractionId' - $ref: '#/components/parameters/CommonRecordingId' /interactions/{id}/transcripts/: get: operationId: transcripts_list responses: '200': description: Returns a list of transcripts associated with the interaction. content: application/json: schema: $ref: '#/components/schemas/TranscriptsListResponse' '400': description: RFC9457 content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '401': description: RFC9457 content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '403': description: RFC9457 content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '500': description: RFC9457 content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '504': description: RFC9457 content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' tags: - Transcripts summary: List Transcripts description: Retrieves a list of transcripts for a given interaction. parameters: - $ref: '#/components/parameters/Tenant-Name' - $ref: '#/components/parameters/CommonInteractionId' - name: full in: query description: Display full transcripts in listing schema: type: boolean description: Display full transcripts in listing post: operationId: transcripts_create responses: '201': description: Returns the generated transcript, including participant roles and timestamps for each utterance. content: application/json: schema: $ref: '#/components/schemas/TranscriptsResponse' '400': description: RFC9457 content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '401': description: RFC9457 content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '403': description: RFC9457 content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '500': description: RFC9457 content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '504': description: RFC9457 content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' tags: - Transcripts summary: Create Transcript description: Create a transcript from an audio file attached, via `/recordings` endpoint, to the interaction.
Each interaction may have more than one audio file and transcript associated with it. While audio files up to 60min in total duration, or 150MB in total size, may be attached to an interaction, synchronous processing is only supported for audio files less than ~2min in duration.

If an audio file takes longer to transcribe than the 25sec synchronous processing timeout, then it will continue to process asynchronously. In this scenario, an empty transcript will be returned with a location header that can be used to retrieve the final transcript.

The client can poll the Get Transcript endpoint (`GET /interactions/{id}/transcripts/{transcriptId}/status`) for transcript status changes:
- `200 OK` with status `processing`, `completed`, or `failed`
- `404 Not Found` if the `interactionId` or `transcriptId` are invalid

The completed transcript can be retrieved via the Get Transcript endpoint (`GET /interactions/{id}/transcripts/{transcriptId}/`). parameters: - $ref: '#/components/parameters/Tenant-Name' - $ref: '#/components/parameters/CommonInteractionId' requestBody: content: application/json: schema: $ref: '#/components/schemas/TranscriptsCreateRequest' required: true /interactions/{id}/transcripts/{transcriptId}: get: operationId: transcripts_get responses: '200': description: '' content: application/json: schema: $ref: '#/components/schemas/TranscriptsResponse' '400': description: RFC9457 content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '401': description: RFC9457 content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '403': description: RFC9457 content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '500': description: RFC9457 content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '504': description: RFC9457 content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' tags: - Transcripts summary: Get Transcript description: Retrieve a transcript from a specific interaction.
Each interaction may have more than one transcript associated with it. Use the List Transcript request (`GET /interactions/{id}/transcripts/`) to see all transcriptIds available for the interaction.

The client can poll this Get Transcript endpoint (`GET /interactions/{id}/transcripts/{transcriptId}/status`) for transcript status changes:
- `200 OK` with status `processing`, `completed`, or `failed`
- `404 Not Found` if the `interactionId` or `transcriptId` are invalid

Status of `completed` indicates the transcript is finalized. If the transcript is retrieved while status is `processing`, then it will be incomplete. parameters: - $ref: '#/components/parameters/Tenant-Name' - $ref: '#/components/parameters/CommonInteractionId' - $ref: '#/components/parameters/CommonTranscriptId' delete: operationId: transcripts_delete responses: '204': description: '' '400': description: RFC9457 content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '401': description: RFC9457 content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '403': description: RFC9457 content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '500': description: RFC9457 content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '504': description: RFC9457 content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' tags: - Transcripts summary: Delete Transcript description: Deletes a specific transcript associated with an interaction. parameters: - $ref: '#/components/parameters/Tenant-Name' - $ref: '#/components/parameters/CommonInteractionId' - $ref: '#/components/parameters/CommonTranscriptId' /factgroups/: get: operationId: facts_fact_groups_list responses: '200': description: Returns a list of available fact groups, used to categorize facts associated with an interaction. content: application/json: schema: $ref: '#/components/schemas/FactsFactGroupsListResponse' '500': description: RFC9457 content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' tags: - Facts summary: List Fact Groups description: Returns a list of available fact groups, used to categorize facts associated with an interaction. parameters: - $ref: '#/components/parameters/Tenant-Name' /interactions/{id}/facts/: get: operationId: facts_list responses: '200': description: Returns a list of facts associated with the specified interaction. content: application/json: schema: $ref: '#/components/schemas/FactsListResponse' '504': description: RFC9457 content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' tags: - Facts summary: List Facts description: Retrieves a list of facts for a given interaction. parameters: - $ref: '#/components/parameters/Tenant-Name' - $ref: '#/components/parameters/CommonInteractionId' post: operationId: facts_create responses: '200': description: Returns the created facts, including their unique identifiers and associated metadata. content: application/json: schema: $ref: '#/components/schemas/FactsCreateResponse' '504': description: RFC9457 content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' tags: - Facts summary: Add Facts description: Adds new facts to an interaction. parameters: - $ref: '#/components/parameters/Tenant-Name' - $ref: '#/components/parameters/CommonInteractionId' requestBody: content: application/json: schema: $ref: '#/components/schemas/FactsCreateRequest' required: true patch: operationId: facts_batch_update responses: '200': description: Returns the list of successfully updated facts. content: application/json: schema: $ref: '#/components/schemas/FactsBatchUpdateResponse' '504': description: RFC9457 content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' tags: - Facts summary: Update Facts description: Updates multiple facts associated with an interaction. parameters: - $ref: '#/components/parameters/Tenant-Name' - $ref: '#/components/parameters/CommonInteractionId' requestBody: content: application/json: schema: $ref: '#/components/schemas/FactsBatchUpdateRequest' required: true /interactions/{id}/facts/{factId}: patch: operationId: facts_update responses: '200': description: Returns the updated fact, including updated fields. content: application/json: schema: $ref: '#/components/schemas/FactsUpdateResponse' '504': description: RFC9457 content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' tags: - Facts summary: Update Fact description: Updates an existing fact associated with a specific interaction. parameters: - $ref: '#/components/parameters/Tenant-Name' - $ref: '#/components/parameters/CommonInteractionId' - name: factId in: path description: The unique identifier of the fact to update. Must be a valid UUID. required: true schema: type: string format: uuid $ref: '#/components/schemas/UUID' description: The unique identifier of the fact to update. Must be a valid UUID. requestBody: content: application/json: schema: $ref: '#/components/schemas/FactsUpdateRequest' required: true /interactions/{id}/documents/: get: operationId: documents_list responses: '200': description: ' ' content: application/json: schema: $ref: '#/components/schemas/DocumentsListResponse' '400': description: RFC9457 content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '403': description: RFC9457 content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '500': description: RFC9457 content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '504': description: RFC9457 content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' tags: - Documents summary: List Documents description: List Documents parameters: - $ref: '#/components/parameters/Tenant-Name' - $ref: '#/components/parameters/CommonInteractionId' post: operationId: documents_create responses: '201': description: ' ' headers: X-Corti-Retention-Policy: description: | Present and set to `acknowledged` if the request included `X-Corti-Retention-Policy: none`. schema: type: string enum: - acknowledged content: application/json: schema: $ref: '#/components/schemas/DocumentsGetResponse' '400': description: RFC9457 content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '403': description: RFC9457 content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '500': description: RFC9457 content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '504': description: RFC9457 content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' tags: - Documents summary: Generate Document description: Generate Document. parameters: - $ref: '#/components/parameters/Tenant-Name' - $ref: '#/components/parameters/CommonInteractionId' - $ref: '#/components/parameters/X-Corti-Retention-Policy' requestBody: content: application/json: schema: $ref: '#/components/schemas/DocumentsCreateRequest' required: true x-codeSamples: - lang: text label: from Facts source: |- curl --request POST \ --url https://api.{environment}.corti.app/v2/interactions/{id}/documents \ --header 'Content-Type: application/json' \ --data '{ "context": [ { "type": "facts", "data": [ { "text": "", "group": "other", "source": "core" } ] } ], "templateKey": "", "name": "", "outputLanguage": "" }' - lang: text label: from Transcript source: |- curl --request POST \ --url https://api.{environment}.corti.app/v2/interactions/{id}/documents \ --header 'Content-Type: application/json' \ --data '{ "context": [ { "type": "transcript", "data": { "channel": 1, "end": 129, "participant": 123, "start": 20, "text": "" } } ], "templateKey": "", "name": "", "outputLanguage": "" }' - lang: text label: assemble Template source: |- curl --request POST \ --url https://api.{environment}.corti.app/v2/interactions/{id}/documents \ --header 'Content-Type: application/json' \ --data '{ "context": [ { "type": "string", "data": "" } ], "templateKey": "", "template": { "sectionKeys": [ "" ], "name": "", "outputLanguage": "" }' - lang: text label: from string source: |- curl --request POST \ --url https://api.{environment}.corti.app/v2/interactions/{id}/documents \ --header 'Content-Type: application/json' \ --data '{ "context": [ { "type": "string", "data": "" } ], "templateKey": "", "name": "", "outputLanguage": "" }' /interactions/{id}/documents/{documentId}: get: operationId: documents_get responses: '200': description: ' ' content: application/json: schema: $ref: '#/components/schemas/DocumentsGetResponse' '400': description: RFC9457 content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '403': description: RFC9457 content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '500': description: RFC9457 content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '504': description: RFC9457 content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' tags: - Documents summary: Get Document description: Get Document. parameters: - $ref: '#/components/parameters/Tenant-Name' - $ref: '#/components/parameters/CommonInteractionId' - name: documentId in: path description: The document ID representing the context for the request. Must be a valid UUID. required: true schema: format: uuid $ref: '#/components/schemas/UUID' type: string description: The document ID representing the context for the request. Must be a valid UUID. patch: operationId: documents_update responses: '200': description: ' ' content: application/json: schema: $ref: '#/components/schemas/DocumentsGetResponse' '400': description: RFC9457 content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '403': description: RFC9457 content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '500': description: RFC9457 content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '504': description: RFC9457 content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' tags: - Documents summary: Update Document parameters: - $ref: '#/components/parameters/Tenant-Name' - $ref: '#/components/parameters/CommonInteractionId' - name: documentId in: path description: The document ID representing the context for the request. Must be a valid UUID. required: true schema: format: uuid $ref: '#/components/schemas/UUID' type: string description: The document ID representing the context for the request. Must be a valid UUID. requestBody: content: application/json: schema: $ref: '#/components/schemas/DocumentsUpdateRequest' required: true delete: operationId: documents_delete responses: '204': description: '' '403': description: RFC9457 content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '404': description: RFC9457 content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '500': description: RFC9457 content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '504': description: RFC9457 content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' tags: - Documents summary: Delete Document parameters: - $ref: '#/components/parameters/Tenant-Name' - $ref: '#/components/parameters/CommonInteractionId' - name: documentId in: path description: The document ID representing the context for the request. Must be a valid UUID. required: true schema: format: uuid $ref: '#/components/schemas/UUID' type: string description: The document ID representing the context for the request. Must be a valid UUID. /templateSections/: get: operationId: templates_section_list responses: '200': description: List of Template Sections content: application/json: schema: $ref: '#/components/schemas/TemplatesSectionListResponse' '401': description: RFC9457 content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '500': description: RFC9457 content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' tags: - Templates summary: List Template Sections description: Retrieves a list of template sections with optional filters for organization and language. parameters: - $ref: '#/components/parameters/Tenant-Name' - name: org in: query description: Filter template sections by organization. schema: type: array description: Filter template sections by organization. items: type: string style: form explode: true - name: lang in: query description: Filter template sections by language. schema: type: array description: Filter template sections by language. items: type: string style: form explode: true /templates/: get: operationId: templates_list responses: '200': description: List of Templates content: application/json: schema: $ref: '#/components/schemas/TemplatesListResponse' '401': description: RFC9457 content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '500': description: RFC9457 content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' tags: - Templates summary: List Templates description: Retrieves a list of templates with optional filters for organization, language, and status. parameters: - $ref: '#/components/parameters/Tenant-Name' - name: org in: query description: Filter templates by organization. schema: type: array description: Filter templates by organization. items: type: string style: form explode: true - name: lang in: query description: Filter templates by language. schema: type: array description: Filter templates by language. items: type: string style: form explode: true - name: status in: query description: Filter templates by their status. schema: type: array description: Filter templates by their status. items: type: string style: form explode: true /templates/{key}: get: operationId: templates_get responses: '200': description: Template by key content: application/json: schema: $ref: '#/components/schemas/TemplatesItem' '401': description: RFC9457 content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '500': description: RFC9457 content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' tags: - Templates summary: Get Template description: Retrieves template by key. parameters: - $ref: '#/components/parameters/Tenant-Name' - name: key in: path description: The key of the template required: true schema: type: string description: The key of the template /interactions/{id}/codes/: get: responses: '200': description: List of associated codes. content: application/json: schema: $ref: '#/components/schemas/ResponseCodesList' '400': description: RFC9457 content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '403': description: RFC9457 content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '500': description: RFC9457 content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '504': description: RFC9457 content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' tags: - Codes summary: List Codes description: '`Limited Access - Contact us for more information`

List predicted codes within the context of an interaction.
This endpoint is only accessible within specific customer tenants. It is not available in the public API.

For stateless code prediction based on input text string or documentId, please refer to the [Predict Codes](/api-reference/codes/predict-codes) API, or [contact us](https://help.corti.app) for more information.' parameters: - $ref: '#/components/parameters/Tenant-Name' - $ref: '#/components/parameters/CommonInteractionId' post: responses: '200': description: List of predicted codes. content: application/json: schema: $ref: '#/components/schemas/ResponseCodesList' '400': description: RFC9457 content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '403': description: RFC9457 content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '500': description: RFC9457 content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '502': description: RFC9457 content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '504': description: RFC9457 content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' tags: - Codes summary: Generate Codes description: '`Limited Access - Contact us for more information`

Generate codes within the context of an interaction.
This endpoint is only accessible within specific customer tenants. It is not available in the public API.

For stateless code prediction based on input text string or documentId, please refer to the [Predict Codes](/api-reference/codes/predict-codes) API, or [contact us](https://help.corti.app) for more information.' parameters: - $ref: '#/components/parameters/Tenant-Name' - $ref: '#/components/parameters/CommonInteractionId' requestBody: content: application/json: schema: $ref: '#/components/schemas/RequestCodesPredict' required: true put: responses: '200': description: Updated list of selected codes. content: application/json: schema: $ref: '#/components/schemas/ResponseCodesList' '400': description: RFC9457 content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '403': description: RFC9457 content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '500': description: RFC9457 content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '504': description: RFC9457 content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' tags: - Codes summary: Select Codes description: '`Limited Access - Contact us for more information`

Select predicted codes within the context of an interaction.
This endpoint is only accessible within specific customer tenants. It is not available in the public API.

For stateless code prediction based on input text string or documentId, please refer to the [Predict Codes](/api-reference/codes/predict-codes) API, or [contact us](https://help.corti.app) for more information.' parameters: - $ref: '#/components/parameters/Tenant-Name' - $ref: '#/components/parameters/CommonInteractionId' requestBody: content: application/json: schema: $ref: '#/components/schemas/RequestCodesUpdate' required: true /tools/coding/: post: operationId: tools_codes_generate responses: '200': description: List of predicted codes and candidate codes per system defined in the request, including evidence supporting the code prediction. content: application/json: schema: $ref: '#/components/schemas/CodesGeneralResponse' examples: success: summary: Example response with preselected codes and candidates value: codes: - system: icd10cm code: R1030 display: Lower abdominal pain, unspecified evidences: - contextIndex: 0 text: "Example text mentioning lower abdominal pain" candidates: - system: icd10cm code: R509 display: Fever, unspecified evidences: - contextIndex: 1 text: "Example text mentioning fever" '400': description: RFC9457 content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '403': description: RFC9457 content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '500': description: RFC9457 content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '502': description: RFC9457 content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '504': description: RFC9457 content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' tags: - Codes summary: Predict Codes description: 'Predict medical codes from provided context.
This is a stateless endpoint, designed to predict ICD-10-CM, ICD-10-PCS, and CPT codes based on input text string or documentId.

More than one code system may be defined in a single request, and the maximum number of codes to return per system can also be defined.

Code prediction requests have two possible values for context:
- `text`: One set of code prediction results will be returned based on all input text defined.
- `documentId`: Code prediction will be based on that defined document only.

The response includes two sets of results:
- `Codes`: Highest confidence bundle of codes, as selected by the code prediction model
- `Candidates`: Full list of candidate codes as predicted by the model, rank sorted by model confidence with maximum possible value of 50.

All predicted code results are based on input context defined in the request only (not other external data or assets associated with an interaction).' parameters: - $ref: '#/components/parameters/Tenant-Name' requestBody: content: application/json: schema: $ref: '#/components/schemas/CodesGeneralPredictRequest' examples: basic: summary: Predict ICD-10-CM and CPT from text value: system: [ "icd10cm", "cpt" ] context: - type: "text" text: "Short arm splint applied in ED for pain control." maxCandidates: 5 required: true /private/v2/align/: post: responses: '200': description: Alignment results with percentage and optionally aligned segments. content: application/json: schema: $ref: '#/components/schemas/ResponseAlign' '400': description: Bad Request - The request was malformed or missing required parameters. content: application/json: schema: $ref: '#/components/schemas/NoContent' '401': description: Unauthorized - Authentication failed or user is not authorized. content: application/json: schema: $ref: '#/components/schemas/NoContent' '500': description: Internal Server Error - An error occurred on the server. content: application/json: schema: $ref: '#/components/schemas/NoContent' '504': description: RFC9457 content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' tags: - Alignment (limited access) summary: Alignment Model description: '`Limited Access - Contact us for more information`
Compares two reference texts, a ''source'' document and a ''target'' document, and returns a percentage alignment, optionally including aligned segments.' parameters: - $ref: '#/components/parameters/Tenant-Name' requestBody: content: application/json: schema: $ref: '#/components/schemas/RequestAlign' required: true /private/v2/interactions/{id}/classification/binary/: post: responses: '200': description: ' ' content: application/json: schema: $ref: '#/components/schemas/ResponseClassificationCreate' '504': description: RFC9457 content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' tags: - Classification (limited access) summary: Classify Binary description: '`Limited Access - Contact us for more information`
This endpoint is used for binary classification tasks: comparing two resources, where a boolean output is expected.' parameters: - $ref: '#/components/parameters/Tenant-Name' - name: id in: path description: The interaction ID representing the context for the request. Must be a valid UUID. required: true schema: type: string description: The interaction ID representing the context for the request. Must be a valid UUID. requestBody: content: application/json: schema: $ref: '#/components/schemas/RequestClassificationCreate' required: true /private/v2/interactions/{id}/query/: post: responses: '200': description: SSE streaming response with results from multiple tools. The initial response includes a thread ID for continuing the conversation. (`text/event-stream`) content: application/json: schema: $ref: '#/components/schemas/ResponseQuery' '400': description: Bad Request - The request was malformed or missing required parameters. content: application/json: schema: $ref: '#/components/schemas/NoContent' '401': description: Unauthorized - Authentication failed or user is not authorized. content: application/json: schema: $ref: '#/components/schemas/NoContent' '500': description: Internal Server Error - An error occurred on the server. content: application/json: schema: $ref: '#/components/schemas/NoContent' '504': description: RFC9457 content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' tags: - Contextual (limited access) summary: Chat description: '`Limited Access - Contact us for more information`
Allows users to ask questions or make queries in the context of a specific interaction. This endpoint supports Server-Sent Events (SSE) for real-time updates and responses. The thread ID, which is returned with the initial query, allows users to ask follow-up questions or refine their queries. This endpoint is designed to facilitate dynamic and context-aware conversations, making it suitable for applications such as chatbots, virtual assistants, research tools and workflow augmentation.' parameters: - $ref: '#/components/parameters/Tenant-Name' - $ref: '#/components/parameters/CommonInteractionId' - name: threadId in: query description: The thread ID representing the context for the request. Must be a valid UUID. schema: type: string description: The thread ID representing the context for the request. Must be a valid UUID. requestBody: content: application/json: schema: $ref: '#/components/schemas/RequestQuery' required: true /private/v2/tools/guidelines/: post: responses: '200': description: Returns a summary and a list of relevant sources. content: application/json: schema: $ref: '#/components/schemas/ResponseGuidelines' '504': description: RFC9457 content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' tags: - Contextual (limited access) summary: Retrieval description: '`Limited Access - Contact us for more information`
Access and unlock knowledge bases and guidelines tools queries, documents, or interactions. This endpoint is designed to facilitate the retrieval of relevant information from various sources, enabling users to access and utilize knowledge bases and guidelines effectively. The response includes a summary and a list of relevant sources, providing users with a comprehensive overview of the retrieved information.' parameters: - $ref: '#/components/parameters/Tenant-Name' requestBody: content: application/json: schema: $ref: '#/components/schemas/RequestGuidelines' required: true /tools/question-prompts/: post: responses: '200': description: Returns an array of suggested questions. content: application/json: schema: $ref: '#/components/schemas/ResponseQuestionPrompts' '504': description: RFC9457 content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' tags: - Contextual (limited access) summary: Predictive Prompt description: '`Limited Access - Contact us for more information`
Provides a list of suggested questions based on a query and/or interaction context.' parameters: - $ref: '#/components/parameters/Tenant-Name' requestBody: content: application/json: schema: $ref: '#/components/schemas/RequestQuestionPrompts' required: true /tools/mentions/: post: responses: '200': description: Returns an array of mentions found in the reference texts. content: application/json: schema: $ref: '#/components/schemas/ResponseMention' '504': description: RFC9457 content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' tags: - Explainability (limited access) summary: Explainability Model description: '`Limited Access - Contact us for more information`
Finds mentions of defined content within a set of reference texts.' parameters: - $ref: '#/components/parameters/Tenant-Name' requestBody: content: application/json: schema: $ref: '#/components/schemas/RequestMention' required: true /tools/extract-facts: post: operationId: facts_extract description: Extract facts from provided text, without storing them. parameters: - $ref: '#/components/parameters/Tenant-Name' requestBody: content: application/json: schema: $ref: '#/components/schemas/FactsExtractRequest' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/FactsExtractResponse' description: Returns the extracted facts. '504': content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' description: RFC9457 summary: Extract Facts tags: - Facts components: schemas: AdditionalCode: type: object properties: subsetName: type: string description: Category or subset of the additional code example: orsakskoder code: type: string description: The additional code example: W0231 description: type: string description: Description of the additional code state: type: object description: State of the additional code $ref: '#/components/schemas/CodesState' AlignedSegment: type: object properties: targetSegment: type: object $ref: '#/components/schemas/TargetSegment' sourceReference: type: array items: type: object properties: text: type: string description: The content of the matching segment in the source document. range: type: array description: Start and end indices of the segment in the source document. items: type: integer alignmentPercentage: type: number description: Alignment percentage between the target and source segment. ClassificationResult: type: object properties: prediction: type: string CodesContext: type: object required: - type - data properties: type: $ref: '#/components/schemas/CodesContextTypeEnum' data: type: string metadata: type: string CodesContextTypeEnum: type: string enum: - string - documentId CommonCodingSystemEnum: type: string enum: - icd10cm - icd10pcs - cpt CodesState: type: object properties: isSelected: type: boolean description: Indicates whether the code is selected source: description: Source of the predicted code $ref: '#/components/schemas/CommonSourceEnum' CommonHeaders: type: object required: - Tenant-Name properties: Tenant-Name: type: string description: Identifies a distinct entity within Corti's multi-tenant system. Ensures correct routing and authentication of the request. example: base DocumentsContext: oneOf: - title: Facts $ref: '#/components/schemas/DocumentsContextWithFacts' - title: Transcript $ref: '#/components/schemas/DocumentsContextWithTranscript' - title: String $ref: '#/components/schemas/DocumentsContextWithString' DocumentsContextWithFacts: type: object required: - type - data properties: type: type: string enum: - facts description: 'The type of context data that will be used in the request: `Facts`, `Transcript`, or `String`.' data: type: array description: An array of facts. items: $ref: '#/components/schemas/FactsContext' DocumentsContextWithTranscript: type: object required: - type - data properties: type: type: string enum: - transcript description: 'The type of context data that will be used in the request: `Facts`, `Transcript`, or `String`.' data: type: object description: Transcript object can accept the full transcript in one string, or individual transcript segments. $ref: '#/components/schemas/CommonTranscriptRequest' DocumentsContextWithString: type: object required: - type - data properties: type: type: string enum: - string description: 'The type of context data that will be used in the request: `Facts`, `Transcript`, or `String`.' data: type: string description: 'String data can include any text to be reasoned over for document generation: Transcript text, facts, or other narrative information.' DocumentsSection: type: object required: - key - name - text - sort - createdAt - updatedAt properties: key: type: string description: Document section key name: type: string description: Name or heading of the document section within the generated document text: type: string description: Contents of the document section within the generated document sort: type: integer description: Order of the document section within the generated document createdAt: type: string format: date-time description: The original timestamp when the document section was created. updatedAt: type: string format: date-time description: The timestamp when the document section was last updated. DocumentsTemplate: oneOf: - $ref: '#/components/schemas/DocumentsTemplateWithSectionKeys' DocumentsTemplateWithSectionKeys: type: object required: - sectionKeys properties: sectionKeys: type: array description: An array of section keys. items: type: string documentName: type: string description: The name of the document. additionalInstructions: type: string description: Any additional instructions to be considered during document generation. InteractionsEncounterCreateRequest: type: object required: - identifier - status - type properties: identifier: type: string description: A unique identifier for the encounter, essential for tracking and referencing specific patient interactions. status: description: Indicates the current state of the encounter, crucial for understanding the progression and current state of care. $ref: '#/components/schemas/InteractionsEncounterStatusEnum' type: description: The specific type of encounter, providing context about the nature and setting of the patient interaction. $ref: '#/components/schemas/InteractionsEncounterTypeEnum' period: type: object description: The time period during which the encounter takes place. $ref: '#/components/schemas/InteractionsEncounterPeriod' title: type: string description: A readable name for the interaction nullable: true InteractionsEncounterUpdateRequest: type: object properties: identifier: type: string description: A unique identifier for the encounter, essential for tracking and referencing specific patient interactions. status: description: Indicates the current state of the encounter, crucial for understanding the progression and current state of care. $ref: '#/components/schemas/InteractionsEncounterStatusEnum' type: description: The specific type of encounter, providing context about the nature and setting of the patient interaction. $ref: '#/components/schemas/InteractionsEncounterTypeEnum' period: type: object description: The time period during which the encounter takes place. $ref: '#/components/schemas/InteractionsEncounterPeriod' title: type: string description: A readable name for the interaction nullable: true InteractionsEncounterResponse: type: object required: - identifier - status - type - period properties: identifier: type: string description: A unique identifier for the encounter, essential for tracking and referencing specific patient interactions. status: description: Indicates the current state of the encounter, crucial for understanding the progression and current state of care. $ref: '#/components/schemas/InteractionsEncounterStatusEnum' type: description: The specific type of encounter, providing context about the nature and setting of the patient interaction. $ref: '#/components/schemas/InteractionsEncounterTypeEnum' period: type: object description: The time period during which the encounter takes place. $ref: '#/components/schemas/InteractionsEncounterPeriod' title: type: string description: A readable name for the interaction nullable: true InteractionsEncounterPeriod: type: object required: - startedAt properties: startedAt: type: string format: date-time description: The start date/time of the encounter. (UTC) endedAt: type: string format: date-time description: The end date/time of the encounter. (UTC) nullable: true ErrorResponse: type: object required: - type properties: requestid: type: string type: type: string status: type: integer title: type: string details: type: string instance: type: string FactsContext: type: object required: - text - source properties: text: type: string description: The text of the fact. group: type: string description: The group to which the fact belongs. example: Others source: description: The source of the fact. 'USER' refers to facts provided by the user, while 'SYSTEM' refers to system-generated facts (e.g., EHR). $ref: '#/components/schemas/CommonSourceEnum' FactsFactGroupsItem: type: object properties: id: type: string format: uuid items: {} $ref: '#/components/schemas/UUID' key: type: string translations: type: array items: type: object properties: id: type: integer languages_id: type: string name: type: string FactGroupTranslationFiltered: type: object properties: id: type: integer languages_id: type: string name: type: string MentionData: type: object properties: range: type: array description: Character range for document type. items: type: integer time: type: array description: Time range in seconds for transcript type. items: type: integer snippet: type: string description: Text snippet for the mention. documentId: type: string format: uuid description: The document ID if applicable. items: {} $ref: '#/components/schemas/UUID' utteranceId: type: string format: uuid description: The utterance ID if applicable. items: {} $ref: '#/components/schemas/UUID' timestamp: type: string format: date-time description: The timestamp for transcript mentions. NoContent: type: object InteractionsPatient: type: object required: - identifier properties: identifier: type: string description: FHIR reference to patient identifier. name: type: string description: FHIR reference to Text representation of the full name. nullable: true gender: description: FHIR reference to patient gender. $ref: '#/components/schemas/InteractionsGenderEnum' nullable: true birthDate: type: string format: date-time description: FHIR reference to patient birth date. nullable: true pronouns: type: string description: FHIR reference to patient extension Individual Pronouns. nullable: true QueryData: type: object properties: summary: type: string description: For guidelines, a summary of the response. sources: type: array items: type: object properties: favicon: type: string description: The favicon URL of the source. title: type: string description: The title of the source. url: type: string description: The URL of the source. type: type: string description: The type of the source (e.g., PDF, Web). description: type: string description: A brief description of the source. mentions: type: array items: type: object properties: type: type: string description: The type of mention (e.g., transcript, document). data: type: object $ref: '#/components/schemas/MentionData' response: type: string description: General chat response in markdown format. rewrittenText: type: string description: For document rewrites, the rewritten text in markdown format. queries: type: array description: Related or follow-up queries. items: type: string QueryMention: type: object properties: type: type: string description: The type of mention (e.g., transcript, document). data: type: object $ref: '#/components/schemas/MentionData' QuerySource: type: object properties: favicon: type: string description: The favicon URL of the source. title: type: string description: The title of the source. url: type: string description: The URL of the source. type: type: string description: The type of the source (e.g., PDF, Web). description: type: string description: A brief description of the source. RequestAlign: type: object required: - sourceDocument - targetDocument properties: sourceDocument: type: string description: The content of the source document. targetDocument: type: string description: The content of the target document. compareSegments: type: boolean description: Indicates if segments from the source should be compared with the target. example: false RequestClassificationCreate: type: object properties: inputs: type: array items: type: string taskId: type: string format: uuid items: {} $ref: '#/components/schemas/UUID' RequestCodeUpdate: type: object properties: code: type: string description: The medical code to update example: W0231 additionalCodes: type: array description: List of additional codes items: type: string RequestCodesPredict: type: object required: - modelName - context properties: modelName: type: string description: The model name used for code predictions example: '"geography_modelName (Latest)" | "geography_modelName_version"' context: type: object description: Context object containing type and data $ref: '#/components/schemas/CodesContext' existingCodes: type: array description: List of pre-selected codes before interaction items: type: string RequestCodesUpdate: type: object properties: finalCodes: type: array description: List of final codes items: type: object properties: code: type: string description: The medical code to update example: W0231 additionalCodes: type: array description: List of additional codes items: type: string DocumentsCreateRequest: oneOf: - title: Static Template description: 'Standard method for document generation: Use template key to generate document based on pre-defined template.' $ref: '#/components/schemas/DocumentsCreateRequestWithTemplateKey' - title: Dynamic Template description: 'Advanced method for document generation: Define sectionKeys in the request to build a template dynamically. See a detailed example [here](/templates/documents-advanced#assemble-a-template-with-extra-instructions).' $ref: '#/components/schemas/DocumentsCreateRequestWithTemplate' DocumentsCreateRequestWithTemplateKey: type: object required: - context - templateKey - outputLanguage properties: context: type: array description: An array of context objects. Currently accepts exactly one context object to be used as input for document generation. items: $ref: '#/components/schemas/DocumentsContext' templateKey: type: string description: The key of the template that informs on what kind of document is to be generated. name: type: string description: An optional name for the document. outputLanguage: type: string description: The language in which the document will be generated. Check [languages page](/about/languages) for more. disableGuardrails: type: boolean description: Set to true to disable guardrails during document generation, default is false. DocumentsCreateRequestWithTemplate: type: object required: - context - template - outputLanguage properties: context: type: array description: An array of context objects. Currently accepts exactly one context object to be used as input for document generation. items: $ref: '#/components/schemas/DocumentsContext' template: type: object description: Template details if the template should be generated during the request. $ref: '#/components/schemas/DocumentsTemplate' name: type: string description: An optional name for the document. outputLanguage: type: string description: The language in which the document will be generated. Check [languages page](/about/languages) for more. disableGuardrails: type: boolean description: Set to true to disable guardrails during document generation, default is false. DocumentsSectionInput: type: object required: - key properties: key: type: string name: type: string text: type: string sort: type: integer DocumentsUpdateRequest: type: object properties: name: type: string description: An optional name for the document. sections: type: array items: $ref: '#/components/schemas/DocumentsSectionInput' CodesGeneralPredictRequest: type: object required: - system - context properties: system: type: array description: List of coding systems for prediction uniqueItems: true minItems: 1 maxItems: 3 items: $ref: '#/components/schemas/CommonCodingSystemEnum' example: - icd10cm - cpt context: type: array description: Select either `text` or `documentId` as input context to the model for code prediction. Evidence indices in the response map to this array. items: $ref: '#/components/schemas/CommonAIContext' maxCandidates: type: integer minimum: 1 maximum: 50 description: Maximum number of code candidates to include in the response (per system). CommonDocumentIDContext: type: object title: DocumentID required: - type - documentId properties: type: type: string enum: - documentId description: > The type of context, always "documentId" in this context. documentId: type: string description: A referenced document ID to be used as input to the model. CommonTextContext: type: object title: Text required: - type - text properties: type: type: string enum: - text description: > The type of context, always "text" in this context. text: type: string description: > A text string to be used as input to the model. CommonAIContext: oneOf: - $ref: '#/components/schemas/CommonTextContext' - $ref: '#/components/schemas/CommonDocumentIDContext' FactsCreateInput: type: object required: - text - group properties: text: type: string description: The text content of the fact. group: type: string description: The key identifying the group to which the fact belongs. example: other source: description: The origin of the fact, such as 'USER' or 'SYSTEM'. $ref: '#/components/schemas/CommonSourceEnum' FactsUpdateRequest: type: object properties: text: type: string description: The updated text of the fact. group: type: string description: The updated group key for the fact. example: other source: description: The updated origin of the fact. Set to 'USER' to indicate a change by an end-user. $ref: '#/components/schemas/CommonSourceEnum' isDiscarded: type: boolean description: Set this to true if discarded by an end-user, then filter out from the document generation request. FactsCreateRequest: type: object required: - facts properties: facts: type: array description: A list of facts to be created. items: $ref: '#/components/schemas/FactsCreateInput' FactsBatchUpdateRequest: type: object required: - facts properties: facts: type: array description: A list of facts to be updated. items: $ref: '#/components/schemas/FactsBatchUpdateInput' FactsBatchUpdateInput: type: object required: - factId properties: factId: type: string format: uuid description: The unique identifier of the fact to be updated. items: {} $ref: '#/components/schemas/UUID' isDiscarded: type: boolean description: Set this to true for facts discarded by an end-user, then filter those out from the document generation request. text: type: string description: The updated text content of the fact. group: type: string description: The updated group key for the fact. example: other RequestGuidelines: type: object required: - query - context - sourceIds properties: query: type: string description: The text-based query from the user. context: type: array description: An array of contexts, such as documents or relevant segments. items: type: string sourceIds: type: array format: uuid description: An array of source IDs to narrow down the search. items: $ref: '#/components/schemas/UUID' InteractionsCreateRequest: type: object required: - encounter properties: assignedUserId: type: string format: uuid description: A unique identifier for the medical professional responsible for this interaction. If nulled, automatically set to a uuid. items: {} $ref: '#/components/schemas/UUID' encounter: type: object description: Details about the encounter. $ref: '#/components/schemas/InteractionsEncounterCreateRequest' patient: type: object description: Optional patient details. $ref: '#/components/schemas/InteractionsPatient' InteractionsUpdateRequest: type: object properties: assignedUserId: type: string format: uuid description: The unique identifier of the medical professional responsible for this interaction. If nulled, automatically set to a uuid. items: {} $ref: '#/components/schemas/UUID' encounter: type: object description: Details of the encounter being updated. $ref: '#/components/schemas/InteractionsEncounterUpdateRequest' patient: type: object description: Patient-related updates. $ref: '#/components/schemas/InteractionsPatient' RequestMention: type: object required: - query - referenceTexts properties: query: type: string description: The text-based query from the user. referenceTexts: type: array description: An array of reference texts where the mentions will be searched. items: type: string TranscriptsParticipant: type: object required: - channel - role properties: channel: type: integer description: The audio channel to associate with a participant role. role: description: The role of the participant (e.g., 'doctor', 'patient', use 'multiple' for single channel). $ref: '#/components/schemas/TranscriptsParticipantRoleEnum' RequestQuery: type: object required: - query properties: query: type: string description: The text-based query from the user. example: What are the key points from the latest guidelines? queryContext: type: string description: A specific document or focus context for the query. example: doc123 focusContexts: type: array description: A list of additional focus contexts or documents. items: type: string example: - doc456 - doc789 RequestQuestionPrompts: type: object required: - context properties: context: type: array description: The context in which the query is being made. items: type: string query: type: string description: The query for which the questions are being generated (optional). RequestTranscriptAnonymize: type: object properties: inputLanguage: type: string transcript: type: array items: type: object properties: value: type: string role: type: string TranscriptsCreateRequest: type: object required: - recordingId - primaryLanguage properties: recordingId: type: string format: uuid description: The unique identifier for the recording. items: {} $ref: '#/components/schemas/UUID' primaryLanguage: type: string example: en description: The primary spoken language of the recording. Check https://docs.corti.ai/about/languages for more. isDictation: type: boolean description: Indicates whether spoken dictation commands should be converted to punctuation (e.g., 'comma' → ','). isMultichannel: type: boolean description: If true, each audio channel is transcribed separately. diarize: type: boolean description: If true, separates speakers within an audio channel returning incrementing ids for transcript segments. participants: type: array description: 'An array of participants, each specifying a role and an assigned audio channel in the recording. Leave empty when shouldDiarize: true' items: $ref: '#/components/schemas/TranscriptsParticipant' ResponseAlign: type: object properties: alignmentPercentage: type: number description: Alignment percentage between the source and target documents. alignedSegments: type: array items: type: object properties: targetSegment: type: object $ref: '#/components/schemas/TargetSegment' sourceReference: type: array items: type: object properties: text: type: string description: The content of the matching segment in the source document. range: type: array description: Start and end indices of the segment in the source document. items: type: integer alignmentPercentage: type: number description: Alignment percentage between the target and source segment. TemplatesSectionListResponse: type: object required: - data properties: data: type: array description: List of filtered template sections items: $ref: '#/components/schemas/TemplatesSection' TemplatesListResponse: type: object required: - data properties: data: type: array description: List of filtered templates items: $ref: '#/components/schemas/TemplatesItem' ResponseClassificationCreate: type: object properties: result: type: object $ref: '#/components/schemas/ClassificationResult' ResponseCodesList: type: object properties: codes: type: array description: List of medical codes items: type: object properties: system: type: string description: The coding system used example: ICD-10 code: type: string description: The medical code example: T933 description: type: string description: Description of the medical code state: type: object description: State of the code $ref: '#/components/schemas/CodesState' additionalCodes: type: array description: List of additional codes items: type: object properties: subsetName: type: string description: Category or subset of the additional code example: orsakskoder code: type: string description: The additional code example: W0231 description: type: string description: Description of the additional code state: type: object description: State of the additional code $ref: '#/components/schemas/CodesState' usageInfo: type: object $ref: '#/components/schemas/CommonUsageInfo' ResponseCodesRead: type: object properties: system: type: string description: The coding system used example: ICD-10 code: type: string description: The medical code example: T933 description: type: string description: Description of the medical code state: type: object description: State of the code $ref: '#/components/schemas/CodesState' additionalCodes: type: array description: List of additional codes items: type: object properties: subsetName: type: string description: Category or subset of the additional code example: orsakskoder code: type: string description: The additional code example: W0231 description: type: string description: Description of the additional code state: type: object description: State of the additional code $ref: '#/components/schemas/CodesState' DocumentsListResponse: type: object required: - data properties: data: type: array items: $ref: '#/components/schemas/DocumentsGetResponse' DocumentsGetResponse: type: object required: - id - name - templateRef - isStream - sections - createdAt - updatedAt - outputLanguage - usageInfo properties: id: type: string format: uuid description: Unique ID of the generated document $ref: '#/components/schemas/UUID' name: type: string description: Name of the generated document templateRef: type: string description: Reference for the used template isStream: type: boolean sections: type: array description: Individual document sections items: $ref: '#/components/schemas/DocumentsSection' createdAt: type: string format: date-time description: The original timestamp when the document was created. updatedAt: type: string format: date-time description: The timestamp when the document was last updated. outputLanguage: type: string description: The language in which the document will be generated. Check https://docs.corti.ai/about/languages for more. usageInfo: type: object $ref: '#/components/schemas/CommonUsageInfo' FactsListItem: type: object properties: id: type: string format: uuid description: The unique identifier of the fact. items: {} $ref: '#/components/schemas/UUID' text: type: string description: The text content of the fact. group: type: string description: The key identifying the group to which the fact belongs. example: other groupId: type: string format: uuid description: The unique identifier of the group to which the fact belongs. items: {} $ref: '#/components/schemas/UUID' isDiscarded: type: boolean description: Indicates whether the fact has been marked as discarded by an end-user. source: description: The origin of the fact. $ref: '#/components/schemas/CommonSourceEnum' createdAt: type: string format: date-time description: The timestamp when the fact was created. updatedAt: type: string format: date-time description: The timestamp when the fact was last updated. evidence: type: array items: $ref: '#/components/schemas/FactsEvidence' FactsCreateItem: type: object properties: id: type: string format: uuid description: The unique identifier of the newly created fact. items: {} $ref: '#/components/schemas/UUID' text: type: string description: The textual content of the created fact. group: type: string description: The group key categorizing the fact. example: other groupId: type: string format: uuid description: The unique identifier of the group to which the fact belongs. items: {} $ref: '#/components/schemas/UUID' source: description: The origin of the fact, such as 'USER' or 'SYSTEM'. $ref: '#/components/schemas/CommonSourceEnum' isDiscarded: type: boolean description: Indicates whether the fact has been marked as discarded by an end-user. updatedAt: type: string format: date-time description: The timestamp when the fact was last updated. FactsEvidence: type: object properties: type: type: string description: The category of evidence. reference: type: string description: A reference that supports the fact. quote: type: string description: A direct excerpt or phrase extracted from the reference source that justifies the fact. FactsFactGroupsListResponse: type: object required: - data properties: data: type: array items: $ref: '#/components/schemas/FactsFactGroupsItem' FactsUpdateResponse: type: object required: - id - text - group - groupId - source - isDiscarded - createdAt - updatedAt properties: id: type: string format: uuid description: The unique identifier of the fact. items: {} $ref: '#/components/schemas/UUID' text: type: string description: The updated text content of the fact. group: type: string description: The updated group key to which the fact belongs. example: other groupId: type: string format: uuid description: The unique identifier of the associated group. items: {} $ref: '#/components/schemas/UUID' source: description: The updated origin of the fact. $ref: '#/components/schemas/CommonSourceEnum' isDiscarded: type: boolean description: Indicates whether the fact is marked as discarded. createdAt: type: string format: date-time description: The original timestamp when the fact was created. updatedAt: type: string format: date-time description: The timestamp when the fact was last updated. FactsCreateResponse: type: object required: - facts properties: facts: type: array description: A list of successfully created facts. items: $ref: '#/components/schemas/FactsCreateItem' FactsListResponse: type: object required: - facts properties: facts: type: array description: A list of facts associated with the interaction. items: $ref: '#/components/schemas/FactsListItem' FactsBatchUpdateResponse: type: object required: - facts properties: facts: type: array description: A list of updated facts. items: $ref: '#/components/schemas/FactsBatchUpdateItem' FactsBatchUpdateItem: type: object required: - id - text - group - groupId - source - isDiscarded - createdAt - updatedAt properties: id: type: string format: uuid description: The unique identifier of the updated fact. items: {} $ref: '#/components/schemas/UUID' text: type: string description: The updated text content of the fact. group: type: string description: The updated group key to which the fact belongs. example: other groupId: type: string format: uuid description: The unique identifier of the associated group. items: {} $ref: '#/components/schemas/UUID' source: description: The updated origin of the fact. $ref: '#/components/schemas/CommonSourceEnum' isDiscarded: type: boolean description: Indicates whether the fact is marked as discarded. createdAt: type: string format: date-time description: The original timestamp when the fact was created. updatedAt: type: string format: date-time description: The timestamp when the fact was last updated. CodesGeneralResponse: type: object required: - codes - candidates properties: codes: type: array description: Highest confidence bundle of codes, preselected by the code prediction model items: $ref: '#/components/schemas/CodesGeneralReadResponse' candidates: type: array description: Full list of candidate codes as predicted by the model, rank sorted by model confidence items: $ref: '#/components/schemas/CodesGeneralReadResponse' usageInfo: type: object $ref: '#/components/schemas/CommonUsageInfo' CodesGeneralReadResponse: type: object description: Predicted or candidate code record. required: - system - code - display properties: system: description: The coding system used $ref: '#/components/schemas/CommonCodingSystemEnum' code: type: string description: The medical code example: T933 display: type: string description: Description of the medical code evidences: type: array description: The evidence for the prediction items: type: object properties: contextIndex: type: integer description: Index from the context input array text: type: string description: Part of input text CodesPredictionEvidence: type: object description: Evidence span supporting a predicted code, linked to the input context. required: - contextIndex - text properties: contextIndex: type: integer minimum: 0 description: Index from the request `context` array where this evidence was found. example: 0 text: type: string description: Extracted text snippet supporting the prediction. example: "Short arm splint applied in ED" FactsExtractRequest: properties: context: items: $ref: '#/components/schemas/CommonTextContext' type: array outputLanguage: description: The desired output language code for extracted facts. Check [languages page](/about/languages) for more. type: string type: object required: - context - outputLanguage FactsExtractResponse: properties: facts: description: List of extracted facts based on the provided input context. type: array items: required: - group - value properties: group: description: The fact group key the fact belongs to. type: string value: description: An individual, atomic fact. type: string type: object outputLanguage: description: The language locale of the output. type: string usageInfo: $ref: '#/components/schemas/CommonUsageInfo' type: object required: - facts - outputLanguage - usageInfo ResponseGuidelines: type: object properties: summary: type: string description: A summary of the response. sources: type: array items: $ref: '#/components/schemas/QuerySource' InteractionsGetResponse: type: object required: - id - assignedUserId - encounter - patient - createdAt - updatedAt - lastUpdated - websocketUrl properties: id: type: string format: uuid description: Unique identifier for the interaction. items: {} $ref: '#/components/schemas/UUID' assignedUserId: type: string format: uuid description: A unique identifier for the medical professional responsible for this interaction. If nulled, automatically set to a uuid. items: {} $ref: '#/components/schemas/UUID' encounter: type: object description: Information about the encounter, including type, status, and timing. $ref: '#/components/schemas/InteractionsEncounterResponse' patient: type: object description: Details about the patient involved in the interaction, if applicable. $ref: '#/components/schemas/InteractionsPatient' endedAt: type: string format: date-time description: The timestamp when the interaction concluded (UTC). nullable: true createdAt: type: string format: date-time description: The timestamp when the interaction was started (UTC). updatedAt: type: string format: date-time description: The timestamp when the interaction was last modified (UTC). websocketUrl: type: string description: 'WebSocket URL for streaming real-time interactions. Append a token in the format: /interactions/{interactionID}/streams?token=Bearer token-value-here' lastUpdated: type: string format: date-time description: The timestamp indicating the last recorded update for this interaction. InteractionsCreateResponse: type: object required: - interactionId - websocketUrl properties: interactionId: type: string format: uuid description: Unique identifier for the interaction. items: {} $ref: '#/components/schemas/UUID' websocketUrl: type: string description: 'WebSocket URL for streaming real-time interactions. Append a token in the format: /interactions/{interactionID}/streams?token=Bearer token-value-here' InteractionsListResponse: type: object required: - interactions properties: interactions: type: array items: $ref: '#/components/schemas/InteractionsGetResponse' ResponseMention: type: object properties: properties: type: string description: The type of mention (e.g., transcript, document). range: type: array description: Character range for document type. items: type: integer time: type: array description: Time range in seconds for transcript type. items: type: integer snippet: type: string description: Text snippet for the mention. documentId: type: string format: uuid description: The document ID if applicable. items: {} $ref: '#/components/schemas/UUID' utteranceId: type: string format: uuid description: The utterance ID if applicable. items: {} $ref: '#/components/schemas/UUID' timestamp: type: string format: date-time description: The timestamp for transcript mentions. TranscriptsMetadata: type: object properties: participantsRoles: type: array items: $ref: '#/components/schemas/TranscriptsParticipant' nullable: true ResponseParticipantCreate: type: object properties: channel: type: integer description: The audio channel associated with the participant. role: description: The role of the participant. $ref: '#/components/schemas/TranscriptsParticipantRoleEnum' ResponseQuery: type: object properties: tool: type: string description: The tool providing the response (e.g., guidelines, mentions, general_chat, etc.) data: type: object description: The response data specific to the tool. $ref: '#/components/schemas/QueryData' ResponseQuestionPrompts: type: object properties: prompts: type: array description: An array of suggested questions. items: type: string RecordingsCreateResponse: type: object required: - recordingId properties: recordingId: type: string format: uuid description: The unique identifier for the created recording. items: {} $ref: '#/components/schemas/UUID' RecordingsListResponse: type: object required: - recordings properties: recordings: type: array format: uuid description: A list of recordings for the interaction. items: $ref: '#/components/schemas/UUID' ResponseTranscriptAnonymize: type: object properties: anonymized: type: array items: $ref: '#/components/schemas/Utterance' usageInfo: type: object $ref: '#/components/schemas/CommonUsageInfo' TranscriptsResponse: type: object required: - id - metadata - transcripts - usageInfo properties: id: type: string format: uuid description: The unique identifier of the transcript. items: {} $ref: '#/components/schemas/UUID' metadata: type: object description: Additional information about the participants involved in the transcript. $ref: '#/components/schemas/TranscriptsMetadata' transcripts: type: array description: An array of transcripts. nullable: true items: $ref: '#/components/schemas/CommonTranscriptResponse' usageInfo: type: object $ref: '#/components/schemas/CommonUsageInfo' TranscriptsListResponse: type: object required: - transcripts properties: transcripts: nullable: true type: array items: $ref: '#/components/schemas/TranscriptsListItem' TranscriptsListItem: type: object required: - id - transcriptSample properties: id: type: string format: uuid description: The unique identifier of the transcript. items: {} $ref: '#/components/schemas/UUID' transcriptSample: type: string transcript: type: object $ref: '#/components/schemas/TranscriptsData' nullable: true TranscriptsData: type: object required: - metadata - transcripts properties: metadata: type: object description: Additional information about the participants involved in the transcript. $ref: '#/components/schemas/TranscriptsMetadata' transcripts: type: array description: An array of transcripts. items: $ref: '#/components/schemas/CommonTranscriptResponse' TemplatesSection: type: object required: - name - key - description - default_writing_style - section_type - translations properties: date_updated: type: string format: date-time description: The timestamp when the section was updated. nullable: true name: type: string description: Name of the section alternate_names: type: array description: Alternate names for the section items: type: string nullable: true key: type: string description: Unique key for the section description: type: string description: Description of the section default_writing_style: type: object description: Default writing style for the section $ref: '#/components/schemas/TemplatesWritingStyle' section_type: type: string description: Type of section translations: type: array description: Available translations for the section items: $ref: '#/components/schemas/TemplatesSectionTranslation' CommonSortingDirectionEnum: type: string example: desc enum: - asc - desc SourceReference: type: object properties: text: type: string description: The content of the matching segment in the source document. range: type: array description: Start and end indices of the segment in the source document. items: type: integer TargetSegment: type: object properties: text: type: string description: The content of the target document segment. range: type: array description: Start and end indices of the segment in the target document. items: type: integer TemplatesItem: type: object required: - name - description - key - status - template_sections - translations properties: date_updated: type: string format: date-time description: The timestamp when the template was updated. nullable: true name: type: string description: Name of the template description: type: string description: Description of the template key: type: string description: Unique key for the template status: type: string description: Status of the template. template_sections: type: array description: List of sections included in the template items: $ref: '#/components/schemas/TemplatesSectionSorted' translations: type: array description: Available translations for the template items: $ref: '#/components/schemas/TemplatesTranslation' TemplatesSectionSorted: type: object required: - sort - sections_id properties: sort: type: integer description: Sort order of the section within the template sections_id: type: object description: The section details $ref: '#/components/schemas/TemplatesSection' CommonTranscriptRequest: type: object required: - text properties: channel: type: integer description: The channel associated with this phrase/utterance. participant: type: integer description: The identifier of the participant. speakerId: type: integer description: Id to tag an identified speaker. Auto-increments. text: type: string description: The spoken phrase or utterance extracted from the audio. start: type: integer description: Start time in milliseconds for phrase/utterance. end: type: integer description: End time in milliseconds for phrase/utterance. CommonTranscriptResponse: type: object required: - channel - participant - speakerId - text - start - end properties: channel: type: integer description: The channel associated with this phrase/utterance. participant: type: integer description: The identifier of the participant. speakerId: type: integer description: Id to tag an identified speaker. Auto-increments. text: type: string description: The spoken phrase or utterance extracted from the audio. start: type: integer description: Start time in milliseconds for phrase/utterance. end: type: integer description: End time in milliseconds for phrase/utterance. UUID: type: string items: {} format: uuid example: f47ac10b-58cc-4372-a567-0e02b2c3d479 CommonUsageInfo: type: object description: Credits consumed for this request. required: - creditsConsumed properties: creditsConsumed: type: number Utterance: type: object properties: value: type: string role: type: string DocumentsContextType: type: string DocumentsContextTypeEnum: type: string enum: - facts - transcript - string InteractionsEncounterStatusEnum: type: string enum: - planned - in-progress - on-hold - completed - cancelled - deleted InteractionsEncounterTypeEnum: type: string enum: - first_consultation - consultation - emergency - inpatient - outpatient InteractionsGenderEnum: type: string enum: - male - female - unknown - other CommonSourceEnum: type: string enum: - core - system - user TranscriptsParticipantRoleEnum: type: string enum: - doctor - patient - multiple TemplatesWritingStyle: type: object required: - name properties: name: type: string description: Name of the writing style TemplatesSectionTranslation: type: object required: - languages_id properties: languages_id: type: string description: Language identifier name: type: string description: Localized name nullable: true description: type: string description: Localized description nullable: true TemplatesTranslation: type: object required: - languages_id properties: languages_id: type: string description: Language identifier name: type: string description: Localized name description: type: string description: Localized description DocumentationEvidence: type: object properties: evidenceId: type: string items: {} $ref: '#/components/schemas/UUID' type: type: string example: transcript quote: type: string ResponseDocumentation: type: object properties: id: type: string items: {} $ref: '#/components/schemas/UUID' text: type: string sectionTitle: type: string evidence: type: object $ref: '#/components/schemas/DocumentationEvidence' securitySchemes: AuthorizationHeader: type: http description: Input your token scheme: bearer parameters: Tenant-Name: name: Tenant-Name in: header description: Identifies a distinct entity within Corti's multi-tenant system. Ensures correct routing and authentication of the request. required: true example: base schema: type: string description: Identifies a distinct entity within Corti's multi-tenant system. Ensures correct routing and authentication of the request. example: base CommonInteractionId: name: id in: path description: The unique identifier of the interaction. Must be a valid UUID. required: true schema: $ref: '#/components/schemas/UUID' CommonRecordingId: name: recordingId in: path description: The unique identifier of the recording. Must be a valid UUID. required: true schema: $ref: '#/components/schemas/UUID' CommonTranscriptId: name: transcriptId in: path description: The unique identifier of the transcript. Must be a valid UUID. required: true schema: $ref: '#/components/schemas/UUID' X-Corti-Retention-Policy: name: X-Corti-Retention-Policy in: header description: With the optional header `X-Corti-Retention-Policy:none` the API will generate and return the document as expected, but the generated document will not be saved to the database. The response will include the header `X-Corti-Retention-Policy:acknowledged` to confirm that your retention preference was respected. If the header is omitted or set to any other value, the default retention policy will apply, and the document will be stored in the database. required: false schema: type: string enum: - none security: - AuthorizationHeader: - bearer tags: - name: Interactions - name: Facts - name: Documents - name: Codes - name: Recordings - name: Transcripts