Skip to main content
POST
/
recording-sessions
/
create
Create a Recording Session
curl --request POST \
  --url https://scribe-api.puppilot.co/recording-sessions/create \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'X-API-Version: <x-api-version>' \
  --data '{
  "patient_name": "<string>",
  "description": "<string>"
}'
{
  "public_id": "<string>",
  "updated_at": "<string>",
  "patient_name": "<string>",
  "description": "<string>",
  "organization_public_id": "<string>"
}

​
Overview

This endpoint creates a new recording session to be used for scribing.
The generated public_id will be required for uploading your audio file in subsequent steps.

​
Request Body

  • patient_name (string) - Name of the patient.
    Note: patient_name must match the patient’s name in the uploaded audio (if any) to ensure the record is generated only for the scheduled patient. PupPilot uses this information to avoid inclusion of unrelated pet discussions.
  • description (string, optional) - Short description of the session.
  • session_date (date, required) - The date of the session (format: YYYY-MM-DD).

​
Example Request

{
  "patient_name": "Max",
  "description": "Wellness appointment",
  "session_date": "2025-03-18"
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

​
X-API-Version
string
required

API versioning is required. Include the header X-API-Version with current version value in all requests.

Example:

"v1"

Body

application/json
​
patient_name
string
required
​
description
string
required

Response

200 - application/json

Recording session created successfully.

​
public_id
string
​
updated_at
string
​
patient_name
string
​
description
string
​
organization_public_id
string