Transcriptions

Notes
Expert level
The API key should be sent as a Bearer token in the Authorization header of the request. Get your API key.
List

API endpoint:

GET 
https://getmaze.com/api/v1/transcriptions

Request example: 

curl --location --request GET 'https://getmaze.com/api/v1/transcriptions' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer {api_key}'
Parameter
Type
Description
search
optional string
The search query.
search_by
optional string
Search by. Possible values are: name for Name, result for Result. Defaults to: name.
favorite
optional boolean
Filter by favorite.
sort_by
optional string
Sort by. Possible values are: id for Date created, name for Name. Defaults to: id.
sort
optional string
Sort. Possible values are: desc for Descending, asc for Ascending. Defaults to: desc.
per_page
optional integer
Results per page. Possible values are: 10, 25, 50, 100. Defaults to: 10.
Show

API endpoint:

GET 
https://getmaze.com/api/v1/transcriptions/{id}

Request example: 

curl --location --request GET 'https://getmaze.com/api/v1/transcriptions/{id}' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer {api_key}'
Store

API endpoint:

POST 
https://getmaze.com/api/v1/transcriptions

Request example: 

curl --location --request POST 'https://getmaze.com/api/v1/transcriptions' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--header 'Authorization: Bearer {api_key}' \
--form 'name={name}' \
--form 'file=@{file}'
Parameter
Type
Description
name
required string
The transcription name.
file
required file
The audio file.
description
optional string
The description of the audio file.
language
optional string
The language of the audio file. The value must be in ISO 3166-1 alpha-2 standard.
Update

API endpoint:

PUT PATCH 
https://getmaze.com/api/v1/transcriptions/{id}

Request example: 

curl --location --request PUT 'https://getmaze.com/api/v1/transcriptions/{id}' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--header 'Authorization: Bearer {api_key}'
Parameter
Type
Description
name
optional string
The transcription name.
result
optional string
The transcription result.
favorite
optional boolean
Whether the transcription is favorite or not.
Delete

API endpoint:

DELETE 
https://getmaze.com/api/v1/transcriptions/{id}

Request example: 

curl --location --request DELETE 'https://getmaze.com/api/v1/transcriptions/{id}' \
--header 'Authorization: Bearer {api_key}'