Skip to main content

Create therapy session​

Work in Progress. Create new therapy session based on input data - either a recording uploaded to S3 or text notes. To upload a recording file to S3, you should use the /recording-url endpoint to get a pre-signed URL and PUT the file there. Couple sessions are not yet supported

Request Body required

Therapy session creation request

  • providerUserId string required

    The provider user's internal Upheal UUID (returned from user creation or GET endpoints). Partner external IDs (partnerUserId) are not supported.

  • clientUserId string

    The client user's internal Upheal UUID (returned from user creation or GET endpoints). Provider must have access to the client user. Partner external IDs (partnerUserId) are not supported.

  • clientPronouns string

    Possible values: [MasculineHim, FeminineHer, NeutralThem]

    Pronouns of the client user. Used when clientUserId is not defined. Cannot be used together with clientUserId.

  • sessionType string required

    Session type to set. Allowed values are Intake, Standard, Soap, Dap, Girp, Birp, Mse, Emdr, PsychiatricSoap, PsychiatricIntake, CoupleStandard, CoupleSoap, CoupleDap, GpSoap, Bps, HeadwaySoap.

  • input object required

    Input data for the session. Either a recording url or text note.

  • recording object
  • recordingUrls uri[] required

    URLs to the session recording files. If more than one file is provided, they are concatenated.

  • recordingContent string required

    Possible values: [DictatedNotes, Recording]

    Type of the recorded content, DictatedNotes or Recording.

  • text object

    Text note input for the session.

  • text string required

    Provider's text notes from the session.

  • date string

    Optional date and time of the session. ISO 8601 format. If not specified, current time is used.

  • partnerAppointmentId string

    Optional identifier that will be included in the web-hook payload. Can be used to correlate upheal session with partner's identifier.

  • 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 session it's sent with, so include it on each session create call where you want it used. The plan cannot be added or changed afterwards via the update session input endpoint.

    Maximum length: 100,000 characters.

Responses

OK

Schema
  • sessionId string

    Id of session.

Loading...