@crestal/nation-sdk 0.1.19

package/docs/ChatApi.md

@@ -0,0 +1,516 @@
+# ChatApi
+
+All URIs are relative to *http://localhost*
+
+|Method | HTTP request | Description|
+|------------- | ------------- | -------------|
+|[**createChatThread**](#createchatthread) | **POST** /agents/{aid}/chats | Create a new chat thread|
+|[**deleteChatThread**](#deletechatthread) | **DELETE** /agents/{aid}/chats/{chat_id} | Delete a chat thread|
+|[**getChatThreadById**](#getchatthreadbyid) | **GET** /agents/{aid}/chats/{chat_id} | Get chat thread by ID|
+|[**getMessageById**](#getmessagebyid) | **GET** /messages/{message_id} | Get message by ID|
+|[**listChatsForAgent**](#listchatsforagent) | **GET** /agents/{aid}/chats | List chat threads for an agent|
+|[**listMessagesInChat**](#listmessagesinchat) | **GET** /agents/{aid}/chats/{chat_id}/messages | List messages in a chat thread|
+|[**retryMessageInChat**](#retrymessageinchat) | **POST** /agents/{aid}/chats/{chat_id}/messages/retry | Retry a message in a chat thread|
+|[**sendMessageToChat**](#sendmessagetochat) | **POST** /agents/{aid}/chats/{chat_id}/messages | Send a message to a chat thread|
+|[**updateChatThread**](#updatechatthread) | **PATCH** /agents/{aid}/chats/{chat_id} | Update a chat thread|
+
+# **createChatThread**
+> Chat createChatThread()
+
+Create a new chat thread for a specific agent and user.
+
+### Example
+
+```typescript
+import {
+    ChatApi,
+    Configuration
+} from '@crestal/nation-sdk';
+
+const configuration = new Configuration();
+const apiInstance = new ChatApi(configuration);
+
+let aid: string; //Agent ID (default to undefined)
+
+const { status, data } = await apiInstance.createChatThread(
+    aid
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **aid** | [**string**] | Agent ID | defaults to undefined|
+
+
+### Return type
+
+**Chat**
+
+### Authorization
+
+[HTTPBearer](../README.md#HTTPBearer)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | Successful Response |  -  |
+|**422** | Validation Error |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
+
+# **deleteChatThread**
+> deleteChatThread()
+
+Delete a specific chat thread for the current user and agent. Returns 404 if not found or not owned by the user.
+
+### Example
+
+```typescript
+import {
+    ChatApi,
+    Configuration
+} from '@crestal/nation-sdk';
+
+const configuration = new Configuration();
+const apiInstance = new ChatApi(configuration);
+
+let aid: string; //Agent ID (default to undefined)
+let chatId: string; //Chat ID (default to undefined)
+
+const { status, data } = await apiInstance.deleteChatThread(
+    aid,
+    chatId
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **aid** | [**string**] | Agent ID | defaults to undefined|
+| **chatId** | [**string**] | Chat ID | defaults to undefined|
+
+
+### Return type
+
+void (empty response body)
+
+### Authorization
+
+[HTTPBearer](../README.md#HTTPBearer)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**204** | Successful Response |  -  |
+|**422** | Validation Error |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
+
+# **getChatThreadById**
+> Chat getChatThreadById()
+
+Retrieve a specific chat thread by its ID for the current user and agent. Returns 404 if not found or not owned by the user.
+
+### Example
+
+```typescript
+import {
+    ChatApi,
+    Configuration
+} from '@crestal/nation-sdk';
+
+const configuration = new Configuration();
+const apiInstance = new ChatApi(configuration);
+
+let aid: string; //Agent ID (default to undefined)
+let chatId: string; //Chat ID (default to undefined)
+
+const { status, data } = await apiInstance.getChatThreadById(
+    aid,
+    chatId
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **aid** | [**string**] | Agent ID | defaults to undefined|
+| **chatId** | [**string**] | Chat ID | defaults to undefined|
+
+
+### Return type
+
+**Chat**
+
+### Authorization
+
+[HTTPBearer](../README.md#HTTPBearer)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | Successful Response |  -  |
+|**422** | Validation Error |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
+
+# **getMessageById**
+> ChatMessage getMessageById()
+
+Retrieve a specific chat message by its ID for the current user. Returns 404 if not found or not owned by the user.
+
+### Example
+
+```typescript
+import {
+    ChatApi,
+    Configuration
+} from '@crestal/nation-sdk';
+
+const configuration = new Configuration();
+const apiInstance = new ChatApi(configuration);
+
+let messageId: string; //Message ID (default to undefined)
+
+const { status, data } = await apiInstance.getMessageById(
+    messageId
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **messageId** | [**string**] | Message ID | defaults to undefined|
+
+
+### Return type
+
+**ChatMessage**
+
+### Authorization
+
+[HTTPBearer](../README.md#HTTPBearer)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | Successful Response |  -  |
+|**422** | Validation Error |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
+
+# **listChatsForAgent**
+> Array<Chat> listChatsForAgent()
+
+Retrieve all chat threads associated with a specific agent for the current user.
+
+### Example
+
+```typescript
+import {
+    ChatApi,
+    Configuration
+} from '@crestal/nation-sdk';
+
+const configuration = new Configuration();
+const apiInstance = new ChatApi(configuration);
+
+let aid: string; //Agent ID (default to undefined)
+
+const { status, data } = await apiInstance.listChatsForAgent(
+    aid
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **aid** | [**string**] | Agent ID | defaults to undefined|
+
+
+### Return type
+
+**Array<Chat>**
+
+### Authorization
+
+[HTTPBearer](../README.md#HTTPBearer)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | Successful Response |  -  |
+|**422** | Validation Error |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
+
+# **listMessagesInChat**
+> ChatMessagesResponse listMessagesInChat()
+
+Retrieve the message history for a specific chat thread with cursor-based pagination.
+
+### Example
+
+```typescript
+import {
+    ChatApi,
+    Configuration
+} from '@crestal/nation-sdk';
+
+const configuration = new Configuration();
+const apiInstance = new ChatApi(configuration);
+
+let aid: string; //Agent ID (default to undefined)
+let chatId: string; //Chat ID (default to undefined)
+let cursor: string; //Cursor for pagination (message id) (optional) (default to undefined)
+let limit: number; //Maximum number of messages to return (optional) (default to 20)
+
+const { status, data } = await apiInstance.listMessagesInChat(
+    aid,
+    chatId,
+    cursor,
+    limit
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **aid** | [**string**] | Agent ID | defaults to undefined|
+| **chatId** | [**string**] | Chat ID | defaults to undefined|
+| **cursor** | [**string**] | Cursor for pagination (message id) | (optional) defaults to undefined|
+| **limit** | [**number**] | Maximum number of messages to return | (optional) defaults to 20|
+
+
+### Return type
+
+**ChatMessagesResponse**
+
+### Authorization
+
+[HTTPBearer](../README.md#HTTPBearer)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | Successful Response |  -  |
+|**422** | Validation Error |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
+
+# **retryMessageInChat**
+> Array<ChatMessage> retryMessageInChat()
+
+Retry sending the last message in a specific chat thread. If the last message is from an agent/system, returns all messages after the last user message. If the last message is from a user, generates a new agent response. Only works with non-streaming mode.
+
+### Example
+
+```typescript
+import {
+    ChatApi,
+    Configuration
+} from '@crestal/nation-sdk';
+
+const configuration = new Configuration();
+const apiInstance = new ChatApi(configuration);
+
+let aid: string; //Agent ID (default to undefined)
+let chatId: string; //Chat ID (default to undefined)
+
+const { status, data } = await apiInstance.retryMessageInChat(
+    aid,
+    chatId
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **aid** | [**string**] | Agent ID | defaults to undefined|
+| **chatId** | [**string**] | Chat ID | defaults to undefined|
+
+
+### Return type
+
+**Array<ChatMessage>**
+
+### Authorization
+
+[HTTPBearer](../README.md#HTTPBearer)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | Successful Response |  -  |
+|**422** | Validation Error |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
+
+# **sendMessageToChat**
+> Array<ChatMessage> sendMessageToChat(chatMessageRequest)
+
+Send a new message to a specific chat thread. Supports streaming responses if requested.
+
+### Example
+
+```typescript
+import {
+    ChatApi,
+    Configuration,
+    ChatMessageRequest
+} from '@crestal/nation-sdk';
+
+const configuration = new Configuration();
+const apiInstance = new ChatApi(configuration);
+
+let aid: string; //Agent ID (default to undefined)
+let chatId: string; //Chat ID (default to undefined)
+let chatMessageRequest: ChatMessageRequest; //
+
+const { status, data } = await apiInstance.sendMessageToChat(
+    aid,
+    chatId,
+    chatMessageRequest
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **chatMessageRequest** | **ChatMessageRequest**|  | |
+| **aid** | [**string**] | Agent ID | defaults to undefined|
+| **chatId** | [**string**] | Chat ID | defaults to undefined|
+
+
+### Return type
+
+**Array<ChatMessage>**
+
+### Authorization
+
+[HTTPBearer](../README.md#HTTPBearer)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | Successful Response |  -  |
+|**422** | Validation Error |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
+
+# **updateChatThread**
+> Chat updateChatThread(chatUpdateRequest)
+
+Update details of a specific chat thread. Currently only supports updating the summary.
+
+### Example
+
+```typescript
+import {
+    ChatApi,
+    Configuration,
+    ChatUpdateRequest
+} from '@crestal/nation-sdk';
+
+const configuration = new Configuration();
+const apiInstance = new ChatApi(configuration);
+
+let aid: string; //Agent ID (default to undefined)
+let chatId: string; //Chat ID (default to undefined)
+let chatUpdateRequest: ChatUpdateRequest; //
+
+const { status, data } = await apiInstance.updateChatThread(
+    aid,
+    chatId,
+    chatUpdateRequest
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **chatUpdateRequest** | **ChatUpdateRequest**|  | |
+| **aid** | [**string**] | Agent ID | defaults to undefined|
+| **chatId** | [**string**] | Chat ID | defaults to undefined|
+
+
+### Return type
+
+**Chat**
+
+### Authorization
+
+[HTTPBearer](../README.md#HTTPBearer)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | Successful Response |  -  |
+|**422** | Validation Error |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
+

package/docs/ChatMessage.md

@@ -0,0 +1,63 @@
+# ChatMessage
+
+Chat message model with all fields including server-generated ones.
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **string** | Unique identifier for the chat message | [optional] [default to undefined]
+**agent_id** | **string** | ID of the agent this message belongs to | [default to undefined]
+**chat_id** | **string** | ID of the chat this message belongs to | [default to undefined]
+**user_id** | **string** |  | [default to undefined]
+**author_id** | **string** | ID of the message author | [default to undefined]
+**author_type** | [**AuthorType**](AuthorType.md) | Type of the message author | [default to undefined]
+**model** | **string** |  | [optional] [default to undefined]
+**thread_type** | [**AuthorType**](AuthorType.md) |  | [optional] [default to undefined]
+**reply_to** | **string** |  | [optional] [default to undefined]
+**message** | **string** | Content of the message | [default to undefined]
+**attachments** | [**Array<ChatMessageAttachment>**](ChatMessageAttachment.md) |  | [optional] [default to undefined]
+**skill_calls** | [**Array<ChatMessageSkillCall>**](ChatMessageSkillCall.md) |  | [optional] [default to undefined]
+**input_tokens** | **number** | Number of tokens in the input message | [optional] [default to 0]
+**output_tokens** | **number** | Number of tokens in the output message | [optional] [default to 0]
+**time_cost** | **number** | Time cost for the message in seconds | [optional] [default to 0.0]
+**credit_event_id** | **string** |  | [optional] [default to undefined]
+**credit_cost** | **string** |  | [optional] [default to undefined]
+**cold_start_cost** | **number** | Cost for the cold start of the message in seconds | [optional] [default to 0.0]
+**app_id** | **string** |  | [optional] [default to undefined]
+**search_mode** | **boolean** |  | [optional] [default to undefined]
+**super_mode** | **boolean** |  | [optional] [default to undefined]
+**created_at** | **string** | Timestamp when this message was created | [default to undefined]
+
+## Example
+
+```typescript
+import { ChatMessage } from '@crestal/nation-sdk';
+
+const instance: ChatMessage = {
+    id,
+    agent_id,
+    chat_id,
+    user_id,
+    author_id,
+    author_type,
+    model,
+    thread_type,
+    reply_to,
+    message,
+    attachments,
+    skill_calls,
+    input_tokens,
+    output_tokens,
+    time_cost,
+    credit_event_id,
+    credit_cost,
+    cold_start_cost,
+    app_id,
+    search_mode,
+    super_mode,
+    created_at,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/ChatMessageAttachment.md

@@ -0,0 +1,23 @@
+# ChatMessageAttachment
+
+Chat message attachment model.  An attachment can be a link, image, or file that is associated with a chat message.
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**type** | [**ChatMessageAttachmentType**](ChatMessageAttachmentType.md) | Type of the attachment (link, image, or file) | [default to undefined]
+**url** | **string** | URL of the attachment | [default to undefined]
+
+## Example
+
+```typescript
+import { ChatMessageAttachment } from '@crestal/nation-sdk';
+
+const instance: ChatMessageAttachment = {
+    type,
+    url,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/ChatMessageAttachmentType.md

@@ -0,0 +1,13 @@
+# ChatMessageAttachmentType
+
+Type of chat message attachment.
+
+## Enum
+
+* `Link` (value: `'link'`)
+
+* `Image` (value: `'image'`)
+
+* `File` (value: `'file'`)
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/ChatMessageRequest.md

@@ -0,0 +1,31 @@
+# ChatMessageRequest
+
+Request model for chat messages.  This model represents the request body for creating a new chat message. It contains the necessary fields to identify the chat context and message content, along with optional attachments. The user ID is obtained from authentication and not included in the request body.
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**app_id** | **string** |  | [optional] [default to undefined]
+**message** | **string** | Content of the message | [default to undefined]
+**stream** | **boolean** |  | [optional] [default to undefined]
+**search_mode** | **boolean** |  | [optional] [default to undefined]
+**super_mode** | **boolean** |  | [optional] [default to undefined]
+**attachments** | [**Array<ChatMessageAttachment>**](ChatMessageAttachment.md) |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { ChatMessageRequest } from '@crestal/nation-sdk';
+
+const instance: ChatMessageRequest = {
+    app_id,
+    message,
+    stream,
+    search_mode,
+    super_mode,
+    attachments,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/ChatMessageSkillCall.md

@@ -0,0 +1,35 @@
+# ChatMessageSkillCall
+
+TypedDict for skill call details.
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **string** |  | [optional] [default to undefined]
+**name** | **string** |  | [default to undefined]
+**parameters** | **object** |  | [default to undefined]
+**success** | **boolean** |  | [default to undefined]
+**response** | **string** |  | [optional] [default to undefined]
+**error_message** | **string** |  | [optional] [default to undefined]
+**credit_event_id** | **string** |  | [optional] [default to undefined]
+**credit_cost** | **string** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { ChatMessageSkillCall } from '@crestal/nation-sdk';
+
+const instance: ChatMessageSkillCall = {
+    id,
+    name,
+    parameters,
+    success,
+    response,
+    error_message,
+    credit_event_id,
+    credit_cost,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/ChatMessagesResponse.md

@@ -0,0 +1,25 @@
+# ChatMessagesResponse
+
+Response model for chat messages with pagination.
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**data** | [**Array<ChatMessage>**](ChatMessage.md) |  | [default to undefined]
+**has_more** | **boolean** |  | [optional] [default to false]
+**next_cursor** | **string** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { ChatMessagesResponse } from '@crestal/nation-sdk';
+
+const instance: ChatMessagesResponse = {
+    data,
+    has_more,
+    next_cursor,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)