API

System APIs

POST system/ai-chat-messages

Registers a new AI chat message

HTTP method POST
URI https://api.rambase.net/system/ai-chat-messages
Supported formats Xml, Html, Json (ex. $format=json)
Successful HTTP status code 201
API resource identifier 7277, version 1

The following body must be added to the request. Mouse over fieldnames for description and other useful information about the fields. Note that fields in bold are required/mandatory.

Format:
1
<AiChatMessage>
2
     <Context>
3
          <MessageId
MessageId

Required/mandatory field

External identifier of the chat message

>{String}</MessageId>
4
          <SessionId
SessionId

Required/mandatory field

External identifier of the chat session

>{String}</SessionId>
5
          <LanguageModel
LanguageModel

Required/mandatory field

Language model used for the message

>{String}</LanguageModel>
6
     </Context>
7
     <Sender>
8
          <UserId
UserId

Required/mandatory field

User identifier

Minimum value: 100

>{Integer}</UserId>
9
     </Sender>
10
     <TokenUsage>
11
          <InputTokens
InputTokens

Required/mandatory field

Number of input tokens

Minimum value: 0

>{Long}</InputTokens>
12
          <OutputTokens
OutputTokens

Required/mandatory field

Number of output tokens

Minimum value: 0

>{Long}</OutputTokens>
13
          <CacheReadTokens
CacheReadTokens

Required/mandatory field

Number of cache-read tokens

Minimum value: 0

>{Long}</CacheReadTokens>
14
          <CacheWriteTokens
CacheWriteTokens

Required/mandatory field

Number of cache-write tokens

Minimum value: 0

>{Long}</CacheWriteTokens>
15
     </TokenUsage>
16
</AiChatMessage>
1
{
2
     "aiChatMessage": {
3
          "context": {
4
               "messageId
MessageId

Required/mandatory field

External identifier of the chat message

": "{String}",
5
               "sessionId
SessionId

Required/mandatory field

External identifier of the chat session

": "{String}",
6
               "languageModel
LanguageModel

Required/mandatory field

Language model used for the message

": "{String}"
7
          },
8
          "sender": {
9
               "userId
UserId

Required/mandatory field

User identifier

Minimum value: 100

": "{Integer}"
10
          },
11
          "tokenUsage": {
12
               "inputTokens
InputTokens

Required/mandatory field

Number of input tokens

Minimum value: 0

": "{Long}",
13
               "outputTokens
OutputTokens

Required/mandatory field

Number of output tokens

Minimum value: 0

": "{Long}",
14
               "cacheReadTokens
CacheReadTokens

Required/mandatory field

Number of cache-read tokens

Minimum value: 0

": "{Long}",
15
               "cacheWriteTokens
CacheWriteTokens

Required/mandatory field

Number of cache-write tokens

Minimum value: 0

": "{Long}"
16
          }
17
     }
18
}

The query string is placed after the resource URL, seperated with a questionmark (?). The query string is composed of a series of query parameters with values. See the page about query parameters on how to use these parameters.

$access_token String, optional After successful login you get an access token which needs to be provided in all API requests. Even though it is possible to pass this token as query parameter, we recommended passing it using the HTTP request header as described in Authorization. Note that all access tokens have an expiration time.
$db String, optional Set the database/company for the request
$useMinimumVersion Integer, optional Used to run a new version of an API resource when your API client is running a deprecated API resource. See the Breaking changes page for more information.
$showDomainDescriptions Boolean, optional Set to "true" to include domain descriptions for fields using domain values. See the Domain values page for more information. Default value is false.
$lang String, optional Specifies the language used in the response, following the 3-letter ISO-639-1 [lll]

Read more about filters and sorting on how to use filter parameters and named filters.

Read more about filters and sorting on how to use sortable parameters

Requesting this resource will yield the following response. Mouse over fieldnames (or fieldgroups) for descriptions and other useful information about the fields.

Please note that some fields may be removed from the response, based on user roles/duties/permissions.

Format:
1
<AiChatMessage>
2
     <AiChatMessageId
AiChatMessageId

Unique identifier of the AI chat message

>{Integer}</AiChatMessageId>
3
     <Status
Status

Status of the AI chat message

Possible domain values can be found here

>{Integer}</Status>
4
     <CreatedAt
CreatedAt

Date and time of creation

>{Datetime}</CreatedAt>
5
     <Context>
6
          <MessageId
MessageId

External identifier of the chat message

>{String}</MessageId>
7
          <SessionId
SessionId

External identifier of the chat session

>{String}</SessionId>
8
          <LanguageModel
LanguageModel

Language model used for the message

>{String}</LanguageModel>
9
     </Context>
10
     <Sender>
11
          <UserId
UserId

User identifier

>{Integer}</UserId>
12
          <UserLink
UserLink

User reference

>{String}</UserLink>
13
     </Sender>
14
     <TokenUsage>
15
          <InputTokens
InputTokens

Number of input tokens

>{Long}</InputTokens>
16
          <OutputTokens
OutputTokens

Number of output tokens

>{Long}</OutputTokens>
17
          <CacheReadTokens
CacheReadTokens

Number of cache-read tokens

>{Long}</CacheReadTokens>
18
          <CacheWriteTokens
CacheWriteTokens

Number of cache-write tokens

>{Long}</CacheWriteTokens>
19
     </TokenUsage>
20
</AiChatMessage>
1
{
2
     "aiChatMessage": {
3
          "aiChatMessageId
AiChatMessageId

Unique identifier of the AI chat message

": "{Integer}",
4
          "status
Status

Status of the AI chat message

Possible domain values can be found here

": "{Integer}",
5
          "createdAt
CreatedAt

Date and time of creation

": "{Datetime}",
6
          "context": {
7
               "messageId
MessageId

External identifier of the chat message

": "{String}",
8
               "sessionId
SessionId

External identifier of the chat session

": "{String}",
9
               "languageModel
LanguageModel

Language model used for the message

": "{String}"
10
          },
11
          "sender": {
12
               "userId
UserId

User identifier

": "{Integer}",
13
               "userLink
UserLink

User reference

": "{String}"
14
          },
15
          "tokenUsage": {
16
               "inputTokens
InputTokens

Number of input tokens

": "{Long}",
17
               "outputTokens
OutputTokens

Number of output tokens

": "{Long}",
18
               "cacheReadTokens
CacheReadTokens

Number of cache-read tokens

": "{Long}",
19
               "cacheWriteTokens
CacheWriteTokens

Number of cache-write tokens

": "{Long}"
20
          }
21
     }
22
}

List of available operations/actions for this resource.
See the operations documentation for more information about API operations.

Possible error codes the response might return: