@crestal/nation-sdk 0.1.19

package/docs/AgentApi.md

@@ -0,0 +1,167 @@
+# AgentApi
+
+All URIs are relative to *http://localhost*
+
+|Method | HTTP request | Description|
+|------------- | ------------- | -------------|
+|[**createAgent**](#createagent) | **POST** /agents | Create a new agent|
+|[**getAgentById**](#getagentbyid) | **GET** /agents/{aid} | Get agent by ID|
+|[**getAgentStatistics**](#getagentstatistics) | **GET** /agents/{aid}/statistics | Get Agent Statistics|
+
+# **createAgent**
+> AgentResponse createAgent(agentUpdate)
+
+Create a new agent owned by the current user. The agent will be initialized with the provided details.
+
+### Example
+
+```typescript
+import {
+    AgentApi,
+    Configuration,
+    AgentUpdate
+} from '@crestal/nation-sdk';
+
+const configuration = new Configuration();
+const apiInstance = new AgentApi(configuration);
+
+let agentUpdate: AgentUpdate; //
+
+const { status, data } = await apiInstance.createAgent(
+    agentUpdate
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **agentUpdate** | **AgentUpdate**|  | |
+
+
+### Return type
+
+**AgentResponse**
+
+### 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)
+
+# **getAgentById**
+> AgentResponse getAgentById()
+
+Retrieve a specific agent by its ID. Returns 404 if not found.
+
+### Example
+
+```typescript
+import {
+    AgentApi,
+    Configuration
+} from '@crestal/nation-sdk';
+
+const configuration = new Configuration();
+const apiInstance = new AgentApi(configuration);
+
+let aid: string; //Agent ID (default to undefined)
+
+const { status, data } = await apiInstance.getAgentById(
+    aid
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **aid** | [**string**] | Agent ID | defaults to undefined|
+
+
+### Return type
+
+**AgentResponse**
+
+### Authorization
+
+No authorization required
+
+### 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)
+
+# **getAgentStatistics**
+> AgentStatisticsResponse getAgentStatistics()
+
+Get statistics for an agent account.  This endpoint is not in readonly router, because it may create a new account.
+
+### Example
+
+```typescript
+import {
+    AgentApi,
+    Configuration
+} from '@crestal/nation-sdk';
+
+const configuration = new Configuration();
+const apiInstance = new AgentApi(configuration);
+
+let aid: string; //ID of the agent (default to undefined)
+
+const { status, data } = await apiInstance.getAgentStatistics(
+    aid
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **aid** | [**string**] | ID of the agent | defaults to undefined|
+
+
+### Return type
+
+**AgentStatisticsResponse**
+
+### Authorization
+
+No authorization required
+
+### 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)
+

package/docs/AgentAutonomous.md

@@ -0,0 +1,33 @@
+# AgentAutonomous
+
+Autonomous agent configuration.
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **string** | Unique identifier for the autonomous configuration | [optional] [default to undefined]
+**name** | **string** |  | [optional] [default to undefined]
+**description** | **string** |  | [optional] [default to undefined]
+**minutes** | **number** |  | [optional] [default to undefined]
+**cron** | **string** |  | [optional] [default to undefined]
+**prompt** | **string** | Special prompt used during autonomous operation | [default to undefined]
+**enabled** | **boolean** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { AgentAutonomous } from '@crestal/nation-sdk';
+
+const instance: AgentAutonomous = {
+    id,
+    name,
+    description,
+    minutes,
+    cron,
+    prompt,
+    enabled,
+};
+```
+
+[[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/AgentExample.md

@@ -0,0 +1,25 @@
+# AgentExample
+
+Agent example configuration.
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**name** | **string** | Name of the example | [default to undefined]
+**description** | **string** | Description of the example | [default to undefined]
+**prompt** | **string** | Example prompt | [default to undefined]
+
+## Example
+
+```typescript
+import { AgentExample } from '@crestal/nation-sdk';
+
+const instance: AgentExample = {
+    name,
+    description,
+    prompt,
+};
+```
+
+[[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/AgentResponse.md

@@ -0,0 +1,91 @@
+# AgentResponse
+
+Response model for Agent API.
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **string** | Unique identifier for the agent. Must be URL-safe, containing only lowercase letters, numbers, and hyphens | [default to undefined]
+**number** | **number** |  | [default to undefined]
+**created_at** | **string** | Timestamp when the agent was created, will ignore when importing | [default to undefined]
+**updated_at** | **string** | Timestamp when the agent was last updated, will ignore when importing | [default to undefined]
+**name** | **string** |  | [optional] [default to undefined]
+**slug** | **string** |  | [optional] [default to undefined]
+**description** | **string** |  | [optional] [default to undefined]
+**external_website** | **string** |  | [optional] [default to undefined]
+**picture** | **string** |  | [optional] [default to undefined]
+**ticker** | **string** |  | [optional] [default to undefined]
+**token_address** | **string** |  | [optional] [default to undefined]
+**token_pool** | **string** |  | [optional] [default to undefined]
+**mode** | **string** |  | [optional] [default to undefined]
+**fee_percentage** | **string** |  | [optional] [default to undefined]
+**owner** | **string** |  | [optional] [default to undefined]
+**upstream_id** | **string** |  | [optional] [default to undefined]
+**upstream_extra** | **object** |  | [optional] [default to undefined]
+**model** | **string** | AI model identifier to be used by this agent for processing requests. Available models: gpt-4o, gpt-4o-mini, deepseek-chat, deepseek-reasoner, grok-2, eternalai, reigent | [default to undefined]
+**autonomous** | **Array<object>** |  | [optional] [default to undefined]
+**example_intro** | **string** |  | [optional] [default to undefined]
+**examples** | [**Array<AgentExample>**](AgentExample.md) |  | [optional] [default to undefined]
+**skills** | **object** |  | [optional] [default to undefined]
+**wallet_provider** | **string** |  | [optional] [default to undefined]
+**network_id** | **string** |  | [optional] [default to undefined]
+**cdp_network_id** | **string** |  | [optional] [default to undefined]
+**telegram_entrypoint_enabled** | **boolean** |  | [optional] [default to undefined]
+**cdp_wallet_address** | **string** |  | [default to undefined]
+**has_twitter_linked** | **boolean** | Whether the agent has linked their Twitter account | [default to undefined]
+**linked_twitter_username** | **string** |  | [default to undefined]
+**linked_twitter_name** | **string** |  | [default to undefined]
+**has_twitter_self_key** | **boolean** | Whether the agent has self-keyed their Twitter account | [default to undefined]
+**has_telegram_self_key** | **boolean** | Whether the agent has self-keyed their Telegram account | [default to undefined]
+**linked_telegram_username** | **string** |  | [default to undefined]
+**linked_telegram_name** | **string** |  | [default to undefined]
+**accept_image_input** | **boolean** | Whether the agent accepts image inputs in public mode | [default to undefined]
+**accept_image_input_private** | **boolean** | Whether the agent accepts image inputs in private mode | [default to undefined]
+
+## Example
+
+```typescript
+import { AgentResponse } from '@crestal/nation-sdk';
+
+const instance: AgentResponse = {
+    id,
+    number,
+    created_at,
+    updated_at,
+    name,
+    slug,
+    description,
+    external_website,
+    picture,
+    ticker,
+    token_address,
+    token_pool,
+    mode,
+    fee_percentage,
+    owner,
+    upstream_id,
+    upstream_extra,
+    model,
+    autonomous,
+    example_intro,
+    examples,
+    skills,
+    wallet_provider,
+    network_id,
+    cdp_network_id,
+    telegram_entrypoint_enabled,
+    cdp_wallet_address,
+    has_twitter_linked,
+    linked_twitter_username,
+    linked_twitter_name,
+    has_twitter_self_key,
+    has_telegram_self_key,
+    linked_telegram_username,
+    linked_telegram_name,
+    accept_image_input,
+    accept_image_input_private,
+};
+```
+
+[[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/AgentStatisticsResponse.md

@@ -0,0 +1,49 @@
+# AgentStatisticsResponse
+
+Response model for agent statistics.
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**agent_id** | **string** | ID of the agent | [default to undefined]
+**account_id** | **string** | ID of the agent\'s credit account | [default to undefined]
+**balance** | **string** | Total balance of the agent\'s account | [default to undefined]
+**total_income** | **string** | Total income from all credit events | [default to undefined]
+**net_income** | **string** | Net income from all credit events | [default to undefined]
+**permanent_income** | **string** | Permanent income from all credit events | [default to undefined]
+**permanent_profit** | **string** | Permanent profit from all credit events | [default to undefined]
+**last_24h_income** | **string** | Income from last 24 hours | [default to undefined]
+**last_24h_permanent_income** | **string** | Permanent income from last 24 hours | [default to undefined]
+**avg_action_cost** | **string** | Average action cost | [default to undefined]
+**min_action_cost** | **string** | Minimum action cost | [default to undefined]
+**max_action_cost** | **string** | Maximum action cost | [default to undefined]
+**low_action_cost** | **string** | Low action cost | [default to undefined]
+**medium_action_cost** | **string** | Medium action cost | [default to undefined]
+**high_action_cost** | **string** | High action cost | [default to undefined]
+
+## Example
+
+```typescript
+import { AgentStatisticsResponse } from '@crestal/nation-sdk';
+
+const instance: AgentStatisticsResponse = {
+    agent_id,
+    account_id,
+    balance,
+    total_income,
+    net_income,
+    permanent_income,
+    permanent_profit,
+    last_24h_income,
+    last_24h_permanent_income,
+    avg_action_cost,
+    min_action_cost,
+    max_action_cost,
+    low_action_cost,
+    medium_action_cost,
+    high_action_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/AgentUpdate.md

@@ -0,0 +1,91 @@
+# AgentUpdate
+
+Agent update model.
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**name** | **string** |  | [default to undefined]
+**slug** | **string** |  | [optional] [default to undefined]
+**description** | **string** |  | [optional] [default to undefined]
+**external_website** | **string** |  | [optional] [default to undefined]
+**picture** | **string** |  | [optional] [default to undefined]
+**ticker** | **string** |  | [optional] [default to undefined]
+**token_address** | **string** |  | [optional] [default to undefined]
+**token_pool** | **string** |  | [optional] [default to undefined]
+**mode** | **string** |  | [optional] [default to undefined]
+**fee_percentage** | [**FeePercentage**](FeePercentage.md) |  | [optional] [default to undefined]
+**purpose** | **string** |  | [default to undefined]
+**personality** | **string** |  | [default to undefined]
+**principles** | **string** |  | [default to undefined]
+**owner** | **string** |  | [optional] [default to undefined]
+**upstream_id** | **string** |  | [optional] [default to undefined]
+**upstream_extra** | **object** |  | [optional] [default to undefined]
+**model** | **string** | AI model identifier to be used by this agent for processing requests. Available models: gpt-4o, gpt-4o-mini, deepseek-chat, deepseek-reasoner, grok-2, eternalai, reigent, venice-uncensored | [optional] [default to 'gpt-4.1-mini']
+**prompt** | **string** |  | [optional] [default to undefined]
+**prompt_append** | **string** |  | [optional] [default to undefined]
+**temperature** | **number** |  | [optional] [default to undefined]
+**frequency_penalty** | **number** |  | [optional] [default to undefined]
+**presence_penalty** | **number** |  | [optional] [default to undefined]
+**short_term_memory_strategy** | **string** |  | [optional] [default to undefined]
+**autonomous** | [**Array<AgentAutonomous>**](AgentAutonomous.md) |  | [optional] [default to undefined]
+**example_intro** | **string** |  | [optional] [default to undefined]
+**examples** | [**Array<AgentExample>**](AgentExample.md) |  | [optional] [default to undefined]
+**skills** | **object** |  | [optional] [default to undefined]
+**wallet_provider** | **string** |  | [optional] [default to undefined]
+**network_id** | **string** |  | [optional] [default to undefined]
+**cdp_network_id** | **string** |  | [optional] [default to undefined]
+**twitter_entrypoint_enabled** | **boolean** |  | [optional] [default to undefined]
+**twitter_entrypoint_prompt** | **string** |  | [optional] [default to undefined]
+**twitter_config** | **object** |  | [optional] [default to undefined]
+**telegram_entrypoint_enabled** | **boolean** |  | [optional] [default to undefined]
+**telegram_entrypoint_prompt** | **string** |  | [optional] [default to undefined]
+**telegram_config** | **object** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { AgentUpdate } from '@crestal/nation-sdk';
+
+const instance: AgentUpdate = {
+    name,
+    slug,
+    description,
+    external_website,
+    picture,
+    ticker,
+    token_address,
+    token_pool,
+    mode,
+    fee_percentage,
+    purpose,
+    personality,
+    principles,
+    owner,
+    upstream_id,
+    upstream_extra,
+    model,
+    prompt,
+    prompt_append,
+    temperature,
+    frequency_penalty,
+    presence_penalty,
+    short_term_memory_strategy,
+    autonomous,
+    example_intro,
+    examples,
+    skills,
+    wallet_provider,
+    network_id,
+    cdp_network_id,
+    twitter_entrypoint_enabled,
+    twitter_entrypoint_prompt,
+    twitter_config,
+    telegram_entrypoint_enabled,
+    telegram_entrypoint_prompt,
+    telegram_config,
+};
+```
+
+[[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/AuthorType.md

@@ -0,0 +1,23 @@
+# AuthorType
+
+Type of message author.
+
+## Enum
+
+* `Agent` (value: `'agent'`)
+
+* `Trigger` (value: `'trigger'`)
+
+* `Skill` (value: `'skill'`)
+
+* `Telegram` (value: `'telegram'`)
+
+* `Twitter` (value: `'twitter'`)
+
+* `Web` (value: `'web'`)
+
+* `System` (value: `'system'`)
+
+* `Api` (value: `'api'`)
+
+[[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/Chat.md

@@ -0,0 +1,33 @@
+# Chat
+
+Chat model with all fields including server-generated ones.
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **string** | Unique identifier for the chat | [optional] [default to undefined]
+**agent_id** | **string** | ID of the agent this chat belongs to | [default to undefined]
+**user_id** | **string** | User ID of the chat | [default to undefined]
+**summary** | **string** | Summary of the chat | [optional] [default to '']
+**rounds** | **number** | Number of rounds in the chat | [optional] [default to 0]
+**created_at** | **string** | Timestamp when this chat was created | [default to undefined]
+**updated_at** | **string** | Timestamp when this chat was updated | [default to undefined]
+
+## Example
+
+```typescript
+import { Chat } from '@crestal/nation-sdk';
+
+const instance: Chat = {
+    id,
+    agent_id,
+    user_id,
+    summary,
+    rounds,
+    created_at,
+    updated_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)