Transkriptionen

Notizen
Expertenlevel
Der API-Schlüssel sollte als Bearer-Token im Autorisierungsheader der Anfrage gesendet werden. Erhalten Sie Ihren API-Schlüssel.
Liste

API-Endpunkt:

GET 
https://ai.roccomedia.de/api/v1/transcriptions

Beispielanfrage: 

curl --location --request GET 'https://ai.roccomedia.de/api/v1/transcriptions' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer {api_key}'
Parameter
Typ
Beschreibung
search
optional string
Die Suchanfrage.
search_by
optional string
Suche nach. Mögliche Werte sind: name für Name, result für Ergebnis. Standardwert: name.
favorite
optional boolean
Nach Favoriten filtern.
sort_by
optional string
Sortieren nach. Mögliche Werte sind: id für Erstellungsdatum, name für Name. Standardwert: id.
sort
optional string
Sortieren. Mögliche Werte sind: desc für Absteigend, asc für Aufsteigend. Standardwert: desc.
per_page
optional integer
Ergebnisse pro Seite. Mögliche Werte sind: 10, 25, 50, 100. Standardwert: 10.
Anzeigen

API-Endpunkt:

GET 
https://ai.roccomedia.de/api/v1/transcriptions/{id}

Beispielanfrage: 

curl --location --request GET 'https://ai.roccomedia.de/api/v1/transcriptions/{id}' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer {api_key}'
Speichern

API-Endpunkt:

POST 
https://ai.roccomedia.de/api/v1/transcriptions

Beispielanfrage: 

curl --location --request POST 'https://ai.roccomedia.de/api/v1/transcriptions' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--header 'Authorization: Bearer {api_key}' \
--form 'name={name}' \
--form 'file=@{file}'
Parameter
Typ
Beschreibung
name
erforderlich string
The transcription name.
file
erforderlich 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.
Aktualisieren

API-Endpunkt:

PUT PATCH 
https://ai.roccomedia.de/api/v1/transcriptions/{id}

Beispielanfrage: 

curl --location --request PUT 'https://ai.roccomedia.de/api/v1/transcriptions/{id}' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--header 'Authorization: Bearer {api_key}'
Parameter
Typ
Beschreibung
name
optional string
The transcription name.
result
optional string
The transcription result.
favorite
optional boolean
Whether the transcription is favorite or not.
Löschen

API-Endpunkt:

DELETE 
https://ai.roccomedia.de/api/v1/transcriptions/{id}

Beispielanfrage: 

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