מסמכים - מפתחים - כותבתוכן

הערות

רמת מומחה

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

רשימה

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

GET

http://tochen.supertech.co.il/api/v1/documents

דוגמת בקשה:

curl --location --request GET 'http://tochen.supertech.co.il/api/v1/documents' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer {api_key}'

פרמטר

סוג

תיאור

search

אופציונאלי string

שאילתת החיפוש.

search_by

אופציונאלי string

חיפוש לפי. הערכים האפשריים הם: name עבור שם, result עבור תוצאה. Defaults to: name.

template_id

אופציונאלי integer

סינון לפי מזהה תבנית הערכים האפשריים הם: 1 עבור סגנון חופשי, 2 עבור אודותינו, 3 עבור מודעה, 4 עבור מאמר, 5 עבור פתיח בלוג, 6 עבור מתווה בלוג, 7 עבור סיום בלוג, 8 עבור פסקה לבלוג, 9 עבור פוסט בלוג, 10 עבור מקטע בלוג, 11 עבור נקודות לדיון בבלוג., 12 עבור כותרת בלוג, 13 עבור קריאה לפעולה, 14 עבור שכתוב תוכן, 15 עבור סיכום תוכן, 16 עבור שאלות נפוצות, 17 עבור תגיות האש, 18 עבור כותרת, 19 עבור איך זה עובד, 20 עבור תיאור מטה, 21 עבור מתא מילות מפתח, 22 עבור הצהרת משימה, 23 עבור ניוזלטר, 24 עבור כאב-התרגשות-פתרון, 25 עבור פסקה, 26 עבור הודעה לעיתונות, 27 עבור פוסט חברתי, 28 עבור כיתוב לפוסט חברתי, 29 עבור רעיונות לסטארטאפ, 30 עבור שמות חברות הפתרונות, 31 עבור תת כותרת, 32 עבור עדויות, 33 עבור Social media quote, 34 עבור Social media bio, 35 עבור הצעת הערך, 36 עבור תיאור וידאו, 37 עבור תסריט וידאו, 38 עבור תגיות וידאו, 39 עבור כותרת וידאו, 40 עבור הצהרת חזון, 41 עבור דף מוצר, 42 עבור דואר אלקטרוני פתיחה, 43 עבור התראה דחיפה, 44 עבור רשימת מאמרים בבלוג, 45 עבור דקדוק תוכן, 46 עבור תגיות בבלוג, 47 עבור יתרונות וחסרונות, 48 עבור פרסומת בגוגל, 49 עבור פרסומת בפייסבוק, 50 עבור תיאור משרה, 51 עבור ביקורת, 52 עבור מקטע תכונה, 54 עבור שיר. Defaults to: freestyle.

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/documents/{id}

דוגמת בקשה:

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

חנות

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

POST

http://tochen.supertech.co.il/api/v1/documents

דוגמת בקשה:

curl --location --request POST 'http://tochen.supertech.co.il/api/v1/documents' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--header 'Authorization: Bearer {api_key}' \
--data-urlencode 'name={name}' \
--data-urlencode 'prompt={prompt}'

פרמטר

סוג

תיאור

name

חובה string

שם המסמך.

prompt

חובה string

ההוראות לביצוע על ידי הבינה המלאכותית.

creativity

חובה float

The creative level of the result. הערכים האפשריים הם: 0 עבור חזרתי, 0.25 עבור החלטי, 0.5 עבור מקורי, 0.75 עבור יצירתי, 1 עבור המצאתי. Defaults to: 0.5.

עדכון

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

PUT PATCH

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

דוגמת בקשה:

curl --location --request PUT 'http://tochen.supertech.co.il/api/v1/documents/{id}' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--header 'Authorization: Bearer {api_key}'

פרמטר

סוג

תיאור

name

אופציונאלי string

שם המסמך.

result

אופציונאלי string

תוצאת המסמך.

favorite

אופציונאלי boolean

בין אם המסמך מועדף או לא.

מחיקה

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

DELETE

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

דוגמת בקשה:

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