Skip to main content
POST
/
scribe
/
request
Request Scribe
curl --request POST \
  --url https://scribe-api.puppilot.co/scribe/request \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'X-API-Version: <x-api-version>' \
  --data '
{
  "recording_session_public_id": "<string>",
  "template_public_id": "<string>"
}
'
{
  "public_id": "<string>",
  "message": "<string>"
}

​
Overview

Request scribing for a recording session using a specific template. You’ll need the public_id from your recording session and the public_id of the chosen template.

​
Request Body

  • recording_session_public_id (string) - The ID of the recording session.
  • template_public_id (string) - The ID of the template to use.

​
Example Request

{
    "recording_session_public_id": "<string>",
    "template_public_id": "<string>"
}

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
​
recording_session_public_id
string
required
​
template_public_id
string
required

Response

200 - application/json

Scribing request created successfully.

​
public_id
string
​
message
string