API משימות תרגום
שאילתת משימת התרגום
שאילתה על המצב והפרטים של משימת תרגום.
- כתובת מלאה
- https://otranslator.com/api/v1/translation/query
- אימות
- יש להעביר את ה-API Key בכותרת הבקשה Authorization
- Content-Type
- application/json
- פורמט שגוי
- { "error": "Invalid API key." }
נקודות לתשומת לב
מומלץ לבצע polling לממשק זה כאשר סטטוס המשימה הוא Waiting או Processing, ולהפסיק את ה-polling לאחר שהסטטוס עובר ל-Completed, Terminated או Cancelled.
קישור ההורדה הוא כתובת גישה זמנית, יש לשמור את הקובץ בצד העסקי לפי הצורך או לבצע שאילתה מחדש.
דוגמה
1curl -X POST 'https://otranslator.com/api/v1/translation/query' \
2--header 'Authorization: [yourSecretKey]' \
3--header 'Content-Type: application/json' \
4--data '{
5 "taskId": "[string]"
6}'פרמטרי בקשה
| פרמטרים | סוג | ברירת מחדל | תיאור | דוגמה |
|---|---|---|---|---|
| *taskId | String | - | מזהה משימת תרגום | - |
תגובה
| פרמטרים | סוג | ברירת מחדל | תיאור | דוגמה |
|---|---|---|---|---|
| taskId | String | - | מזהה משימה | - |
| model | String | - | המודל שבו נעשה שימוש לתרגום | - |
| fromLang | String | - | שפת המקור | - |
| toLang | String | - | שפת יעד | - |
| status | String | - | סטטוס: 'Init' | 'Waiting' | 'Processing' | 'Completed' | 'Terminated' | 'Cancelled' | - |
| progress | Number | - | התקדמות, 0~100 | - |
| errorMsg | String | - | הודעת שגיאה | - |
| fileTitle | String | - | שם הקובץ המקורי | - |
| fileUrl | String | - | כתובת הורדה של הקובץ המקורי | - |
| translatedFileUrl | String | - | כתובת הורדת התרגום | - |
| translatedBilingualFileUrl | String | - |
| - |
| translatedEditableFileUrl | String | - | כתובת הורדה של קובץ תרגום הניתן לעריכה. מוחזר רק כאשר נוצרת תוצאה הניתנת לעריכה עבור סוג הקובץ המתאים. | - |
| tokenCount | Integer | - |
| - |
| wordNums | Integer | - | ספירת מילים במסמך. סוגי קבצים שונים עשויים להיות ריקים. | - |
| price | Integer | - | מספר הקרדיטים הנדרש לתרגום המלא | - |
| usedCredits | Integer | - | מספר ה-Credits שנוצלו במשימת התרגום | - |
| glossary | String[] | - | שם מילון המונחים בשימוש עבור משימת התרגום | - |
| shouldTranslateImage | Boolean | - | האם לתרגם תמונות במסמך | - |
| forceOCR | Boolean | - | האם לאלץ שימוש ב-OCR לזיהוי תוכן המסמך | - |
| createdAt | DateTime | - | זמן יצירת משימת התרגום | - |
| updatedAt | DateTime | - | זמן עדכון משימת התרגום | - |
שגיאות נפוצות
401 Missing API key.
The Authorization request header is required.
401 Invalid API key.
The API key does not exist, has been deleted, or is no longer valid.
400 Missing required parameter: taskId.
Provide the taskId returned by the create translation task API.
404 Task not found.
The task does not exist, has been deleted, does not belong to the current API account, or was not created through the API.