Api session items chatmessages: Difference between revisions
Jump to navigation
Jump to search
No edit summary |
No edit summary |
||
| (3 intermediate revisions by the same user not shown) | |||
| Line 1: | Line 1: | ||
API Endpoint: /api/session/items/chatmessages/ | API Endpoint: /api/session/items/chatmessages/ | ||
Default Query: | Default Query: | ||
<syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/items/chatmessages/? | <syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/items/chatmessages/?token=API_TOKEN</syntaxhighlight> | ||
Example Response: | Example Response: | ||
<syntaxhighlight lang="text" copy>[ { | <syntaxhighlight lang="text" copy>[ { | ||
"channelID" : 0, | "channelID" : 0, | ||
"date" : | "date" : 1790081150816, | ||
"id" : 0, | "id" : 0, | ||
"message" : "Welcome to Team Chat, here you can sent messages to other currently active users in your domain.", | "message" : "Welcome to Team Chat, here you can sent messages to other currently active users in your domain.", | ||
| Line 15: | Line 13: | ||
}, { | }, { | ||
"channelID" : 1, | "channelID" : 1, | ||
"date" : | "date" : 1790081150816, | ||
"id" : 1, | "id" : 1, | ||
"message" : "Hello! I am your Tygron Wiki assistant.\n\t\t\n\t\tI can help you with searching the [[Main_Page|Wiki]] for information on features and configurations.\n\t\tWhile following strict [[Chat_Channel#Privacy|AI chat privacy]] rules.\n\t\t\t\t\n\t\tHow can I assist you today?", | "message" : "Hello! I am your Tygron Wiki assistant.\n\t\t\n\t\tI can help you with searching the [[Main_Page|Wiki]] for information on features and configurations.\n\t\tWhile following strict [[Chat_Channel#Privacy|AI chat privacy]] rules.\n\t\t\t\t\n\t\tHow can I assist you today?", | ||
"role" : "INTRO", | "role" : "INTRO", | ||
"version" : | "version" : 2 | ||
} ]</syntaxhighlight> | } ]</syntaxhighlight> | ||
==Limit Queries== | ==Limit Queries== | ||
| Line 31: | Line 29: | ||
Count: | Count: | ||
<syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/items/chatmessages/count/?token=API_TOKEN</syntaxhighlight> | <syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/items/chatmessages/count/?token=API_TOKEN</syntaxhighlight> | ||
Specific Item: | Specific Item by ID: | ||
<syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/items/chatmessages/{ | <syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/items/chatmessages/{id}/?token=API_TOKEN</syntaxhighlight> | ||
==Formats== | ==Formats== | ||
HTML: | HTML: | ||
| Line 236: | Line 234: | ||
{{article end|seealso=*[[Api Content Items]] | {{article end|seealso=*[[Api Content Items]] | ||
*[[Api session event editor | *[[Api session event editor]] | ||
}} | }} | ||
[[Category:API]] | [[Category:API]] | ||
[[Category:Items]] | [[Category:Items]] | ||
Latest revision as of 15:24, 30 September 2026
API Endpoint: /api/session/items/chatmessages/
Default Query:
https://engine.tygron.com/api/session/items/chatmessages/?token=API_TOKENExample Response:
[ {
"channelID" : 0,
"date" : 1790081150816,
"id" : 0,
"message" : "Welcome to Team Chat, here you can sent messages to other currently active users in your domain.",
"role" : "INTRO",
"version" : 1
}, {
"channelID" : 1,
"date" : 1790081150816,
"id" : 1,
"message" : "Hello! I am your Tygron Wiki assistant.\n\t\t\n\t\tI can help you with searching the [[Main_Page|Wiki]] for information on features and configurations.\n\t\tWhile following strict [[Chat_Channel#Privacy|AI chat privacy]] rules.\n\t\t\t\t\n\t\tHow can I assist you today?",
"role" : "INTRO",
"version" : 2
} ]Limit Queries
Version=100:
https://engine.tygron.com/api/session/items/chatmessages/?version=100&token=API_TOKENGet Queries
Attributes:
https://engine.tygron.com/api/session/items/chatmessages/attributes/?token=API_TOKENMax version:
https://engine.tygron.com/api/session/items/chatmessages/version/?token=API_TOKENCount:
https://engine.tygron.com/api/session/items/chatmessages/count/?token=API_TOKENSpecific Item by ID:
https://engine.tygron.com/api/session/items/chatmessages/{id}/?token=API_TOKENFormats
HTML:
https://engine.tygron.com/api/session/items/chatmessages/?f=HTML&token=API_TOKENJSON:
https://engine.tygron.com/api/session/items/chatmessages/?f=JSON&token=API_TOKENCSV:
https://engine.tygron.com/api/session/items/chatmessages/?f=CSV&token=API_TOKENSSV:
https://engine.tygron.com/api/session/items/chatmessages/?f=SSV&token=API_TOKENSMILE:
https://engine.tygron.com/api/session/items/chatmessages/?f=SMILE&token=API_TOKENZIPJSON:
https://engine.tygron.com/api/session/items/chatmessages/?f=ZIPJSON&token=API_TOKENZIPSMILE:
https://engine.tygron.com/api/session/items/chatmessages/?f=ZIPSMILE&token=API_TOKENApi Model AIChatMessage
API Model description of AIChatMessage
| Name | Type | Description |
|---|---|---|
| calcTimeMS | long | |
| channelID | int | Chat Channel ID |
| date | long | |
| id | int | |
| message | String | |
| role | Role | |
| state | AIState | |
| thinking | String | |
| toolCalls | AIToolCall[] | |
| version | int |
Api Model AIState
API Enumeration description of AIState
| Name | Description |
|---|---|
| NONE | |
| QUEUING | |
| READING | |
| GENERATING | |
| FINISHED |
Api Model AIToolCall
API Model description of AIToolCall
| Name | Type | Description |
|---|---|---|
| arguments | String | |
| id | String | |
| name | String |
Api Model ChatMessage
API Model description of ChatMessage
| Name | Type | Description |
|---|---|---|
| channelID | int | Chat Channel ID |
| date | long | |
| id | int | |
| message | String | |
| role | Role | |
| version | int |
Api Model DomainMessage
API Model description of DomainMessage
| Name | Type | Description |
|---|---|---|
| channelID | int | Chat Channel ID |
| date | long | |
| fullName | String | |
| id | int | |
| message | String | |
| role | Role | |
| userName | String | |
| version | int |
Api Model Role
API Enumeration description of Role
| Name | Description |
|---|---|
| SYSTEM | |
| INTRO | |
| ASSISTANT | |
| USER |