Api session items chatmessages: Difference between revisions

From Tygron Support wiki
Jump to navigation Jump to search
← Older edit
Frank@tygron.nl (talk | contribs)
Tygron, Tygron_admin, Interface administrators, Administrators
34,718 edits
No edit summary
No edit summary
 
(9 intermediate revisions by the same user not shown)
Line 1: Line 1:
Api session items [[Chat Message]]s Endpoints.
Api session items [[Chat Message]]s Endpoints.


Edit items with event: [[Api session event editor chat|editorchat]].
Edit items with event: [[Api session event editor chatmessage|editorchatmessage]].


Default Query:
Default Query:
Line 9: Line 9:
==Limit Queries==
==Limit Queries==
version=100:  
version=100:  
<pre>https://engine.tygron.com/api/session/items/chatmessages/?version=100&token=API_TOKEN</pre>
<syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/items/chatmessages/?version=100&token=API_TOKEN</syntaxhighlight>
==Show Queries==
==Show Queries==
max version:  
max version:  
<pre>https://engine.tygron.com/api/session/items/chatmessages/version/?token=API_TOKEN</pre>
<syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/items/chatmessages/version/?token=API_TOKEN</syntaxhighlight>
size:  
size:  
<pre>https://engine.tygron.com/api/session/items/chatmessages/size/?token=API_TOKEN</pre>
<syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/items/chatmessages/size/?token=API_TOKEN</syntaxhighlight>
==Formats==
==Formats==
HTML:  
HTML:  
<pre>https://engine.tygron.com/api/session/items/chatmessages/?f=HTML&token=API_TOKEN</pre>
<syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/items/chatmessages/?f=HTML&token=API_TOKEN</syntaxhighlight>
JSON:  
JSON:  
<pre>https://engine.tygron.com/api/session/items/chatmessages/?f=JSON&token=API_TOKEN</pre>
<syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/items/chatmessages/?f=JSON&token=API_TOKEN</syntaxhighlight>
CSV:  
CSV:  
<pre>https://engine.tygron.com/api/session/items/chatmessages/?f=CSV&token=API_TOKEN</pre>
<syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/items/chatmessages/?f=CSV&token=API_TOKEN</syntaxhighlight>
SSV:  
SSV:  
<pre>https://engine.tygron.com/api/session/items/chatmessages/?f=SSV&token=API_TOKEN</pre>
<syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/items/chatmessages/?f=SSV&token=API_TOKEN</syntaxhighlight>
SMILE:  
SMILE:  
<pre>https://engine.tygron.com/api/session/items/chatmessages/?f=SMILE&token=API_TOKEN</pre>
<syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/items/chatmessages/?f=SMILE&token=API_TOKEN</syntaxhighlight>
ZIPJSON:  
ZIPJSON:  
<pre>https://engine.tygron.com/api/session/items/chatmessages/?f=ZIPJSON&token=API_TOKEN</pre>
<syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/items/chatmessages/?f=ZIPJSON&token=API_TOKEN</syntaxhighlight>
ZIPSMILE:  
ZIPSMILE:  
<pre>https://engine.tygron.com/api/session/items/chatmessages/?f=ZIPSMILE&token=API_TOKEN</pre>
<syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/items/chatmessages/?f=ZIPSMILE&token=API_TOKEN</syntaxhighlight>
==Api Model AIChatMessage==
API Model description of AIChatMessage
 
{|class=wikitable
!Name
!Type
!Description
|-
|calcTimeMS
|long
|
|-
|channelID
|int
|[[Chat Channel]] ID
|-
|date
|long
|
|-
|finished
|boolean
|
|-
|id
|int
|
|-
|message
|String
|
|-
|role
|Role
|
|-
|thinking
|String
|
|-
|version
|int
|
|}
 
==Api Model ChatMessage==
API Model description of ChatMessage
 
{|class=wikitable
!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
 
{|class=wikitable
!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
 
{|class=wikitable
!Name
!Description
|-
|SYSTEM
|
|-
|TOOL
|
|-
|ASSISTANT
|
|-
|USER
|
|}
 
{{article end|seealso=*[[Api Content Items]]
{{article end|seealso=*[[Api Content Items]]
*[[Api session event editor chat]]
*[[Api session event editor chatmessage]]
}}
}}


[[Category:API]]
[[Category:API]]
[[Category:Items]]

Latest revision as of 14:13, 24 April 2026

Api session items Chat Messages Endpoints.

Edit items with event: editorchatmessage.

Default Query: 

https://engine.tygron.com/api/session/items/chatmessages/?f=JSON&token=API_TOKEN

Example Response: 

[ ]

Limit Queries

version=100: 

https://engine.tygron.com/api/session/items/chatmessages/?version=100&token=API_TOKEN

Show Queries

max version: 

https://engine.tygron.com/api/session/items/chatmessages/version/?token=API_TOKEN

size: 

https://engine.tygron.com/api/session/items/chatmessages/size/?token=API_TOKEN

Formats

HTML: 

https://engine.tygron.com/api/session/items/chatmessages/?f=HTML&token=API_TOKEN

JSON: 

https://engine.tygron.com/api/session/items/chatmessages/?f=JSON&token=API_TOKEN

CSV: 

https://engine.tygron.com/api/session/items/chatmessages/?f=CSV&token=API_TOKEN

SSV: 

https://engine.tygron.com/api/session/items/chatmessages/?f=SSV&token=API_TOKEN

SMILE: 

https://engine.tygron.com/api/session/items/chatmessages/?f=SMILE&token=API_TOKEN

ZIPJSON: 

https://engine.tygron.com/api/session/items/chatmessages/?f=ZIPJSON&token=API_TOKEN

ZIPSMILE: 

https://engine.tygron.com/api/session/items/chatmessages/?f=ZIPSMILE&token=API_TOKEN

Api Model AIChatMessage

API Model description of AIChatMessage

Name Type Description
calcTimeMS long
channelID int Chat Channel ID
date long
finished boolean
id int
message String
role Role
thinking String
version int

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
TOOL
ASSISTANT
USER

See also

Retrieved from "https://support.tygron.com/w/index.php?title=Api_session_items_chatmessages&oldid=78789"