Get Scribe Status

Retrieve the status of a scribing request.

GET /scribe/get/{public_id}

Try it

Get Scribe Status

cURL

curl --request GET \
  --url https://scribe-api.puppilot.co/scribe/get/{public_id} \
  --header 'Authorization: Bearer <token>'

200

{
  "public_id": "<string>",
  "transcript_public_id": "<string>",
  "template_public_id": "<string>",
  "status": "scribed",
  "categories_output": [],
  "rtf_output": "{\\rtf1\\ansi\\deff0 ... }"
}

Overview

Retrieve the status of a scribing request. When the request is first received it will have status requested. Once scribing is in process it will have status scribing. When scribing is complete it will have status scribed.

Path Parameter

• public_id (string) - The unique ID of the scribing request.

Authorizations

Authorization · string · header · required

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

Path Parameters

public_id · string · required

Response

200 - application/json

Scribing status retrieved.

public_id · string

transcript_public_id · string

template_public_id · string

status · enum<string>

Available options: requested, scribing, scribed

categories_output · object[]

rtf_output · string