Create therapy session
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
- application/json
Request Body required
Therapy session creation request
- providerUserId string required
Provider user id.
- clientUserId string
Id of the client user that the provider wants to have a session with. Provider must have access to the client user.
- clientPronouns string
Possible values: [
MasculineHim,FeminineHer,NeutralThem]Pronouns of the client user. Used when clientUserId is not defined. Cannot be used together with clientUserId.
- noteTemplateIds string[] required
List of note template ids for notes generation for the session.
input object required
Input data for the session. Either a recording url or text note.
- oneOf
- MOD1
- MOD2
recording object
recordingUrls uri[] requiredURLs to the session recording files. If more than one file is provided, they are concatenated.
recordingContent string requiredPossible values: [
DictatedNotes,Recording]Type of the recorded content, DictatedNotes or Recording.
text object
Text note input for the session.
text string requiredProvider's text notes from the session.
- oneOf
- 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.
- 200
- 400
- 401
- 403
OK
- application/json
- Schema
- Example (from schema)
Schema
- sessionId string
Id of session.
{
"sessionId": "string"
}
Invalid input. For example when provided user ids do not exist or requested session type is not known.
Invalid API Key
API Key cannot access provider or client user.