Step-by-step guide for using the scribing API
Before making API requests, you must log in to obtain an authentication token.
Endpoint:
POST /auth/login
📖 View Docs
Create a new recording session, which will be used for scribing.
Endpoint:
POST /recording-sessions/create
📖 View Docs
Get a list of all available scribing templates.
Endpoint:
GET /templates/all?page=1&limit=50
📖 View Docs
Before uploading an audio file, you need to generate a presigned URL.
Endpoint:
POST /audio/generate-upload-url
📖 View Docs
Once you have the presigned URL, use curl
or an HTTP client to upload the file.
Command:
Submit a request to process the uploaded recording using a chosen template.
Endpoint:
POST /scribe/request
📖 View Docs
Monitor the status of the scribing process.
Endpoint:
GET /scribe/get/{public_id}
📖 View Docs
Step-by-step guide for using the scribing API
Before making API requests, you must log in to obtain an authentication token.
Endpoint:
POST /auth/login
📖 View Docs
Create a new recording session, which will be used for scribing.
Endpoint:
POST /recording-sessions/create
📖 View Docs
Get a list of all available scribing templates.
Endpoint:
GET /templates/all?page=1&limit=50
📖 View Docs
Before uploading an audio file, you need to generate a presigned URL.
Endpoint:
POST /audio/generate-upload-url
📖 View Docs
Once you have the presigned URL, use curl
or an HTTP client to upload the file.
Command:
Submit a request to process the uploaded recording using a chosen template.
Endpoint:
POST /scribe/request
📖 View Docs
Monitor the status of the scribing process.
Endpoint:
GET /scribe/get/{public_id}
📖 View Docs