Creates new processing session from a transcript.

application/json

Request Body

ownerUserId string required
The owner user's internal Upheal UUID (returned from user creation or GET endpoints). Partner external IDs (partnerUserId) are not supported.
speakerNames object required
Dictionary of all participants and their first names. Needs to include mapping for the ownerUserId.
property name* string
speakerPronouns object
Dictionary of all participants and their pronouns. If participant pronoun is unknown, then it's omitted from the dictionary. Otherwise it can have value "MasculineHim" (standing for He/Him/His), "FeminineHer" (She/Her/Hers) and "NeutralThem" (They/Them/Theirs). Specifying participant's pronoun improves AI insights accuracy.
property name* string
speakerGenders object
Deprecated - replaced by speakerPronouns.
property name* string
transcript object required
Transcript of the recorded session. Value becomes available during session processing.
utterances object[]
List of all utterances.
Array [
text string required
Text of the utterance.
start integer required
Relative start time in milliseconds of this utterance in the recording.
end integer required
Relative end time in milliseconds of this utterance in the recording.
speaker string required
Speaker of the utterance. Speakers are labeled with letters, starting with 'A'.
words object[] required
List of words in the utterance.
Array [
text string required
text of the single word
start integer required
Relative start time [ms] of this word occurrence in the recording
end integer required
Relative end time [ms] of this word occurrence in the recording
]
]
speakerMapping object
Mapping of speakers (present in utterances) to user identifiers. One user identifier can be assigned to multiple speakers.
property name* string
language string
Possible values: [en, es, de, it, pt, fr, hi, zh]
Language used in the conversation. Set standard two-letter ISO-639-1 language code. Allowed values - ["en", "es", "de", "it", "pt", "fr", "hi", "zh"]. English (en) will be used if not set.
sessionType SessionType
Possible values: [Intake, Standard, Soap, Dap, Girp, Birp, Mse, Emdr, PsychiatricSoap, PsychiatricIntake, GpSoap, Bps, HeadwaySoap]
Default value: Standard
Type of the session.
participantsType ParticipantsType
Possible values: [Individual, Couple, DictatedNotes]
Default value: Individual
Type of the participants.
externalTreatmentPlan string
Possible values: <= 100000 characters
Optional Markdown treatment plan for the client, used as additional context when Upheal generates the AI note. When provided, the note will reference the plan's goals, objectives, and interventions where they're relevant to what was discussed in the session (supporting Golden Thread documentation).

Send the plan in whatever Markdown structure your system already produces — no specific format is required.

Upheal does not store the plan. It applies only to the processing session it's sent with, so include it on each create call where you want it used.

Maximum length: 100,000 characters.

Responses

Session was initiated and processing started.

application/json

Schema
Example (from schema)

Schema

processingId string required

{
  "processingId": "string"
}

Creates new processing session from a transcript.​

Creates new processing session from a transcript.