API משימות תרגום
יצירת משימת תרגום
צור משימת תרגום חדשה לתרגום מסמכים/קבצים.
- כתובת מלאה
- https://otranslator.com/api/v1/translation/create
- אימות
- יש להעביר את ה-API Key בכותרת הבקשה Authorization
- Content-Type
- multipart/form-data
- פורמט שגוי
- { "error": "Invalid API key." }
נקודות לתשומת לב
יצירת משימה נכנסת מיד לתור ההמתנה ומחזירה taskId. בהמשך ניתן לקבל את ההתקדמות, העלות וקישור ההורדה דרך ממשק שאילתת המשימות.
נדרשת יתרת נקודות זכות של לפחות 2 credits בחשבון כדי ליצור משימה. כאשר preview מוגדר כ-true, ייווצר רק תצוגה מקדימה וישולמו נקודות זכות עבור התצוגה המקדימה.
פרמטר glossary מתאים לפי שם מילון המונחים, ניתן להעביר מספר שדות זהים כדי לציין מספר מילוני מונחים.
דוגמה
1curl -X POST 'https://otranslator.com/api/v1/translation/create' \
2--header 'Authorization: [yourSecretKey]' \
3--form 'file=@bitcoin.pdf' \
4--form 'fromLang=English' \
5--form 'toLang=Simplified Chinese' \
6--form 'outputFormat=MD' \
7--form 'bilingualMode=Horizontal' פרמטרי בקשה
| פרמטרים | סוג | ברירת מחדל | תיאור | דוגמה |
|---|---|---|---|---|
| *file | binary | - |
| bitcoin.pdf |
| *fromLang | String | - |
| English |
| *toLang | String | - |
| Simplified Chinese |
| model | String | - |
| - |
| fileDescription | String | - | תיאור המסמך, שיפור איכות התרגום באמצעות מתן מידע נוסף, למשל הוספת מידע רקע על המסמך ודרישות תרגום נוספות | - |
| glossary | String | - | שם מילון המונחים שבשימוש בתרגום | - |
| preview | Boolean | false | האם ליצור תצוגה מקדימה בלבד. ביצירת תצוגה מקדימה בלבד, ייצור תצוגה מקדימה של תרגום המסמך תמורת תשלום של 2 קרדיטים | - |
| shouldTranslateImage | Boolean | false |
| - |
| forceOCR | Boolean | false | האם לאלץ שימוש ב-OCR לזיהוי תוכן המסמך. לאחר ההפעלה יופעל גם תרגום תמונות. | - |
| shouldTranslateFileName | Boolean | true | האם לתרגם שמות קבצים | - |
| strictSourceLanguageCheck | Boolean | false | האם לתרגם רק טקסט המזוהה כשפת המקור. לאחר ההפעלה, סינון תוכן שאינו בשפת המקור יהיה מחמיר יותר, וחישוב העלות ישתמש במקדם מחמיר יותר. | - |
| outputFormat | String | - | פורמט פלט. בהעברת MD יתבצע נסיון ליצור תרגום Markdown. | MD |
| bilingualMode | String | Horizontal | כיוון פריסת קובץ דו-לשוני. Horizontal מציין תצוגה מימין לשמאל, Vertical מציין תצוגה מלמעלה למטה. | Horizontal |
| password | String | - | סיסמת פתיחה לקובץ PDF | - |
| ignoreComments | Boolean | false | האם להתעלם מהערות ב-DOCX ו-PPTX, XLSX | - |
| ignoreNotes | Boolean | false | האם להתעלם מהערות ב-PPTX | - |
| ignoreHeadersAndFooters | Boolean | false | האם להתעלם מכותרות עליונות ותחתונות ב-DOCX | - |
| ignoreHidden | Boolean | false | האם להתעלם מעמודים מוסתרים ב-PPTX | - |
| ignoreMasters | Boolean | false | האם להתעלם מטקסט התבנית ב-PPTX | - |
| ignoreSheetNames | Boolean | false | האם לא לתרגם שמות גיליונות של XLSX | - |
| extractTextRegExpPattern | String | - |
| - |
| extractTextRegExpFlags | String | - |
| - |
| allowFlip | Boolean | true | האם לאפשר היפוך פריסת עמוד עבור שפות מימין לשמאל. העברת false תכבה גם את היפוך התמונות. | - |
| allowFlipImage | Boolean | true | האם לאפשר היפוך תוכן תמונות עבור שפות מימין לשמאל. | - |
| webhookUrl | String | - | כתובת URL לקריאה חוזרת בעת עדכון סטטוס, תוכן הקריאה החוזרת כולל: {taskId, progress, status} | - |
תגובה
| פרמטרים | סוג | ברירת מחדל | תיאור | דוגמה |
|---|---|---|---|---|
| taskId | String | - | מזהה משימה | - |
שגיאות נפוצות
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.
402 Insufficient credits balance.
The account does not have enough credits to create the task.
400 Missing required parameter: fromLang.
Provide fromLang using a language returned by /api/v1/languages.
400 Missing required parameter: toLang.
Provide toLang using a language returned by /api/v1/languages.
400 Invalid fromLang: [language]. Use a language returned by /api/v1/languages.
The provided source language is not supported.
400 Invalid toLang: [language]. Use a language returned by /api/v1/languages.
The provided target language is not supported.
400 Missing required file upload: file.
Upload the source document in the file form field.
404 Glossary "[name]" not found.
The specified glossary does not exist or does not belong to the current API account.