הודעות - מפתחים - כותבתוכן

הערות

רמת מומחה

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

רשימה

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

GET

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

דוגמת בקשה:

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

פרמטר

סוג

תיאור

search

אופציונאלי string

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

search_by

אופציונאלי string

חיפוש לפי. הערכים האפשריים הם: message עבור הודעה. Defaults to: message.

chat_id

אופציונאלי string

סינון לפי מזהה צ'אט.

role

אופציונאלי string

סנן לפי תפקיד. הערכים האפשריים הם: user עבור משתמש, assistant עבור מסייע.

sort_by

אופציונאלי string

סינון לפי. הערכים האפשריים הם: id עבור תאריך יצירה. Defaults to: id.

sort

אופציונאלי string

Sort. הערכים האפשריים הם: desc עבור בסדר יורד, asc עבור בסדר עולה. Defaults to: desc.

per_page

אופציונאלי integer

תוצאות לעמוד. הערכים האפשריים הם: 10, 25, 50, 100. Defaults to: 10.

חנות

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

POST

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

דוגמת בקשה:

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

פרמטר

סוג

תיאור

name

חובה string

שם הצ'אט.

chat_id

חובה string

מזהה הצ'אט תחת ההודעה שיש לשמור.

role

חובה string

תפקיד ההודעה. הערכים האפשריים הם: user עבור משתמש, assistant עבור מסייע.