תמלולים

הערות
רמת מומחה
מפתח ה- API צריך להישלח כמזהה מוטבע בכותרת האישור של הבקשה. קבל את מפתח ה- API שלך.
רשימה

נקודת גישה ל API:

GET 
http://tochen.supertech.co.il/api/v1/transcriptions

דוגמת בקשה: 

curl --location --request GET 'http://tochen.supertech.co.il/api/v1/transcriptions' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer {api_key}'
פרמטר
סוג
תיאור
search
אופציונאלי string
שאילתת החיפוש.
search_by
אופציונאלי string
חיפוש לפי. הערכים האפשריים הם: name עבור שם, result עבור תוצאה. Defaults to: name.
favorite
אופציונאלי boolean
סינון לפי מועדף.
sort_by
אופציונאלי string
סינון לפי. הערכים האפשריים הם: id עבור תאריך יצירה, name עבור שם. Defaults to: id.
sort
אופציונאלי string
Sort. הערכים האפשריים הם: desc עבור בסדר יורד, asc עבור בסדר עולה. Defaults to: desc.
per_page
אופציונאלי integer
תוצאות לעמוד. הערכים האפשריים הם: 10, 25, 50, 100. Defaults to: 10.
הצג

נקודת גישה ל API:

GET 
http://tochen.supertech.co.il/api/v1/transcriptions/{id}

דוגמת בקשה: 

curl --location --request GET 'http://tochen.supertech.co.il/api/v1/transcriptions/{id}' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer {api_key}'
חנות

נקודת גישה ל API:

POST 
http://tochen.supertech.co.il/api/v1/transcriptions

דוגמת בקשה: 

curl --location --request POST 'http://tochen.supertech.co.il/api/v1/transcriptions' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--header 'Authorization: Bearer {api_key}' \
--form 'name={name}' \
--form 'file=@{file}'
פרמטר
סוג
תיאור
name
חובה string
שם התמלול.
file
חובה file
קובץ האודיו.
description
אופציונאלי string
תיאור קובץ האודיו.
language
אופציונאלי string
שפת קובץ האודיו. The value must be in ISO 3166-1 alpha-2 standard.
עדכון

נקודת גישה ל API:

PUT PATCH 
http://tochen.supertech.co.il/api/v1/transcriptions/{id}

דוגמת בקשה: 

curl --location --request PUT 'http://tochen.supertech.co.il/api/v1/transcriptions/{id}' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--header 'Authorization: Bearer {api_key}'
פרמטר
סוג
תיאור
name
אופציונאלי string
שם התמלול.
result
אופציונאלי string
תוצאת התמלול.
favorite
אופציונאלי boolean
Whether the transcription is favorite or not.
מחיקה

נקודת גישה ל API:

DELETE 
http://tochen.supertech.co.il/api/v1/transcriptions/{id}

דוגמת בקשה: 

curl --location --request DELETE 'http://tochen.supertech.co.il/api/v1/transcriptions/{id}' \
--header 'Authorization: Bearer {api_key}'