├── smallestai ├── atoms │ ├── py.typed │ ├── api │ │ └── __init__.py │ ├── api_response.py │ └── models │ │ ├── agent_id_delete200_response.py │ │ ├── campaign_get200_response_data.py │ │ └── api_response.py ├── waves │ ├── __init__.py │ ├── models.py │ └── exceptions.py └── __init__.py ├── tests ├── atoms │ ├── audience_template.csv │ ├── test_user_api.py │ ├── test_organization_api.py │ ├── test_logs_api.py │ ├── test_calls_api.py │ ├── test_agent_templates_api.py │ ├── test_campaigns_api.py │ └── test_agents_api.py └── waves │ └── test_utils.py ├── requirements.txt ├── docs └── atoms │ ├── models │ ├── ApiResponse.md │ ├── WebhookAgent.md │ ├── AgentIdDelete200Response.md │ ├── UserGet200Response.md │ ├── AgentGet200Response.md │ ├── AgentIdGet200Response.md │ ├── CampaignGetRequest.md │ ├── CampaignPost201Response.md │ ├── AudiencePost400Response.md │ ├── KnowledgebasePostRequest.md │ ├── BadRequestErrorResponse.md │ ├── WebhookPost201Response.md │ ├── CampaignGet200ResponseData.md │ ├── UnauthorizedErrorReponse.md │ ├── WebhookGet200Response.md │ ├── AudienceIdGet400Response.md │ ├── AudienceIdGet403Response.md │ ├── AudienceIdGet404Response.md │ ├── AgentIdPatch200Response.md │ ├── CampaignGet200Response.md │ ├── AgentGet200ResponseData.md │ ├── WebhookIdDelete404Response.md │ ├── AudienceGet200Response.md │ ├── AudiencePost200Response.md │ ├── AudienceIdDelete200Response.md │ ├── AudienceIdDelete400Response.md │ ├── InternalServerErrorResponse.md │ ├── KnowledgebasePost201Response.md │ ├── CampaignIdGet200Response.md │ ├── AudienceIdGet200Response.md │ ├── AudienceIdMembersDeleteRequest.md │ ├── KnowledgebaseGet200Response.md │ ├── WebhookPostRequest.md │ ├── AgentIdWorkflowGet404Response.md │ ├── CampaignPostRequest.md │ ├── OrganizationGet200Response.md │ ├── AgentDTOLanguage.md │ ├── AudienceIdMembersPostRequest.md │ ├── KnowledgebaseIdGet200Response.md │ ├── AudienceIdMembersGet400Response.md │ ├── AudienceIdMembersGet500Response.md │ ├── AgentTemplateGet200Response.md │ ├── AudienceIdMembersPost400Response.md │ ├── AudienceIdMembersPost403Response.md │ ├── ConversationIdGet200Response.md │ ├── WebhookPostRequestEventsInner.md │ ├── AgentFromTemplatePost200Response.md │ ├── AgentIdWorkflowGet200Response.md │ ├── ConversationOutboundPostRequest.md │ ├── WebhookEvent.md │ ├── AudienceIdMembersGet200Response.md │ ├── KnowledgebaseIdItemsGet200Response.md │ ├── AudienceIdMembersSearchGet400Response.md │ ├── AudienceIdMembersSearchGet500Response.md │ ├── AudienceIdMembersDelete200ResponseData.md │ ├── AudienceIdMembersPost200Response.md │ ├── ConversationOutboundPost200ResponseData.md │ ├── OrganizationGet200ResponseDataSubscription.md │ ├── AudienceIdMembersDelete200Response.md │ ├── ProductPhoneNumbersGet200Response.md │ ├── ConversationOutboundPost200Response.md │ ├── KnowledgebaseIdItemsUploadTextPostRequest.md │ ├── OrganizationGet200ResponseDataMembersInner.md │ ├── AudienceIdMembersSearchGet200Response.md │ ├── CreateAgentFromTemplateRequest.md │ ├── KnowledgeBase.md │ ├── AgentDTOSynthesizerVoiceConfig.md │ ├── AgentAgentIdWebhookSubscriptionsGet404Response.md │ ├── WebhookSubscription.md │ ├── AgentAgentIdWebhookSubscriptionsPost400Response.md │ ├── AgentAgentIdWebhookSubscriptionsPostRequest.md │ ├── AudienceIdMembersPost200ResponseDataInner.md │ ├── AgentAgentIdWebhookSubscriptionsPost201Response.md │ ├── OrganizationGet200ResponseData.md │ ├── AgentAgentIdWebhookSubscriptionsGet200Response.md │ ├── AgentAgentIdWebhookSubscriptionsDelete200Response.md │ ├── AgentIdPatchRequestLanguage.md │ ├── AgentDTOSynthesizer.md │ ├── UserGet200ResponseData.md │ ├── AudienceIdMembersPost200ResponseDataInnerData.md │ ├── AgentIdWorkflowGet200ResponseDataNodesInnerPosition.md │ ├── AgentIdWorkflowGet200ResponseDataEdgesInnerData.md │ ├── AgentIdWorkflowGet200ResponseData.md │ ├── AudienceIdMembersGet200ResponseDataMembersInner.md │ ├── AudienceIdMembersSearchGet200ResponseData.md │ ├── WebhookSubscriptionPopulated.md │ ├── AudienceIdMembersGet200ResponseData.md │ ├── AgentIdWorkflowGet200ResponseDataEdgesInnerMarkerEnd.md │ ├── ProductPhoneNumbersGet200ResponseDataInnerAttributes.md │ ├── AgentDTOLanguageSwitching.md │ ├── AgentTemplateGet200ResponseDataInner.md │ ├── Webhook.md │ ├── AgentIdWorkflowGet200ResponseDataNodesInnerDataVariables.md │ ├── AgentIdWorkflowGet200ResponseDataNodesInnerDataVariablesDataInner.md │ ├── AgentIdPatchRequestSynthesizerVoiceConfigOneOf1.md │ ├── AudienceIdMembersSearchGet200ResponseDataSearchInfo.md │ ├── AudienceGet200ResponseDataInner.md │ ├── ProductPhoneNumbersGet200ResponseDataInner.md │ ├── CreateAgentRequestLanguage.md │ ├── AgentIdPatchRequestSynthesizerVoiceConfig.md │ ├── AudiencePost200ResponseData.md │ ├── AgentIdPatchRequestSynthesizerVoiceConfigOneOf.md │ ├── KnowledgeBaseItem.md │ ├── CreateAgentRequestLanguageSynthesizerVoiceConfig.md │ ├── AgentIdPatchRequest.md │ ├── WebhookGet200ResponseData.md │ ├── AgentIdPatchRequestLanguageSwitching.md │ ├── CampaignIdGet200ResponseData.md │ ├── AgentIdWorkflowGet200ResponseDataNodesInner.md │ ├── AgentDTO.md │ ├── AgentIdPatchRequestSynthesizer.md │ ├── AgentIdWorkflowGet200ResponseDataEdgesInner.md │ ├── ConversationIdGet200ResponseData.md │ ├── CreateAgentRequestLanguageSynthesizer.md │ ├── CreateAgentRequest.md │ └── AgentIdWorkflowGet200ResponseDataNodesInnerData.md │ ├── UserApi.md │ ├── OrganizationApi.md │ ├── LogsApi.md │ ├── CallsApi.md │ └── AgentTemplatesApi.md ├── LICENSE └── pyproject.toml /smallestai/atoms/py.typed: -------------------------------------------------------------------------------- 1 | -------------------------------------------------------------------------------- /tests/atoms/audience_template.csv: -------------------------------------------------------------------------------- 1 | phoneNumber,Name 2 | +919999900000,John 3 | +919999900001,Alice 4 | +919999900002,Bob 5 | +919999900003,Sarah -------------------------------------------------------------------------------- /smallestai/waves/__init__.py: -------------------------------------------------------------------------------- 1 | from smallestai.waves.waves_client import WavesClient 2 | from smallestai.waves.async_waves_client import AsyncWavesClient 3 | from smallestai.waves.stream_tts import WavesStreamingTTS, TTSConfig 4 | 5 | __all__ = ["WavesClient", "AsyncWavesClient", "WavesStreamingTTS", "TTSConfig"] -------------------------------------------------------------------------------- /tests/atoms/test_user_api.py: -------------------------------------------------------------------------------- 1 | import pytest 2 | from smallestai.atoms.atoms_client import AtomsClient 3 | from smallestai.atoms.models.user_get200_response import UserGet200Response 4 | 5 | def test_get_current_user(atoms_client): 6 | response = atoms_client.get_current_user() 7 | assert isinstance(response, UserGet200Response) -------------------------------------------------------------------------------- /requirements.txt: -------------------------------------------------------------------------------- 1 | aiohttp~=3.11 2 | aiofiles~=24.1 3 | requests~=2.32 4 | pydub~=0.25 5 | jiwer~=3.1 6 | httpx~=0.28 7 | pytest~=8.3 8 | pytest-asyncio~=0.25 9 | deepgram-sdk~=3.10 10 | python-dotenv~=1.0 11 | urllib3~=1.25.3, < 3.0.0 12 | python_dateutil~=2.8.2 13 | pydantic~=2 14 | typing-extensions~=4.7.1 15 | websocket-client~=1.8.0 -------------------------------------------------------------------------------- /tests/atoms/test_organization_api.py: -------------------------------------------------------------------------------- 1 | import pytest 2 | from smallestai.atoms.atoms_client import AtomsClient 3 | from smallestai.atoms.models.organization_get200_response import OrganizationGet200Response 4 | 5 | def test_get_organization(atoms_client): 6 | response = atoms_client.get_organization() 7 | assert isinstance(response, OrganizationGet200Response) -------------------------------------------------------------------------------- /tests/atoms/test_logs_api.py: -------------------------------------------------------------------------------- 1 | from smallestai.atoms.models.conversation_id_get200_response import ConversationIdGet200Response 2 | 3 | def test_get_conversation_logs(atoms_client, global_state): 4 | 5 | call_id = global_state["base_call"]["id"] 6 | 7 | response = atoms_client.get_conversation_logs(id=call_id) 8 | print(response) 9 | 10 | assert isinstance(response, ConversationIdGet200Response) -------------------------------------------------------------------------------- /smallestai/atoms/api/__init__.py: -------------------------------------------------------------------------------- 1 | # flake8: noqa 2 | 3 | # import apis into api package 4 | from smallestai.atoms.api.agent_templates_api import AgentTemplatesApi 5 | from smallestai.atoms.api.agents_api import AgentsApi 6 | from smallestai.atoms.api.calls_api import CallsApi 7 | from smallestai.atoms.api.campaigns_api import CampaignsApi 8 | from smallestai.atoms.api.knowledge_base_api import KnowledgeBaseApi 9 | from smallestai.atoms.api.logs_api import LogsApi 10 | from smallestai.atoms.api.organization_api import OrganizationApi 11 | from smallestai.atoms.api.user_api import UserApi 12 | -------------------------------------------------------------------------------- /smallestai/waves/models.py: -------------------------------------------------------------------------------- 1 | TTSLanguages_lightning = ["en", "hi"] 2 | TTSLanguages_lightning_large = ["en", "hi"] 3 | TTSLanguages_lightning_v2 = ["en", "hi", "mr", "kn", "ta", "bn", "gu", "de", "fr", "es", "it", "pl", "nl", "ru", "ar", "he"] 4 | TTSModels = [ 5 | "lightning", 6 | "lightning-large", 7 | "lightning-v2" 8 | ] 9 | ASRLanguages_lightning = [ 10 | "it", "es", "en", "pt", "hi", "de", "fr", "uk", "ru", "kn", "ml", "pl", 11 | "mr", "gu", "cs", "sk", "te", "or", "nl", "bn", "lv", "et", "ro", "pa", 12 | "fi", "sv", "bg", "ta", "hu", "da", "lt", "mt", "multi" 13 | ] 14 | ASRModels = [ 15 | "lightning" 16 | ] 17 | -------------------------------------------------------------------------------- /smallestai/waves/exceptions.py: -------------------------------------------------------------------------------- 1 | class InvalidError(Exception): 2 | """Base exception for TTS SDK""" 3 | default_message = "API key is required. Please set the `SMALLEST_API_KEY` environment variable or visit https://waves.smallest.ai/ to obtain your API key." 4 | 5 | def __init__(self, message=None): 6 | super().__init__(message or self.default_message) 7 | 8 | class APIError(InvalidError): 9 | """Raised when the API returns an error""" 10 | pass 11 | 12 | class ValidationError(InvalidError): 13 | """Raised when input validation fails""" 14 | pass 15 | 16 | class AuthenticationError(InvalidError): 17 | """Raised when authentication fails""" 18 | pass -------------------------------------------------------------------------------- /tests/atoms/test_calls_api.py: -------------------------------------------------------------------------------- 1 | import pytest 2 | from smallestai.atoms.atoms_client import AtomsClient 3 | from smallestai.atoms.models.conversation_outbound_post_request import ConversationOutboundPostRequest 4 | from smallestai.atoms.models.conversation_outbound_post200_response import ConversationOutboundPost200Response 5 | 6 | def test_start_outbound_call(atoms_client, global_state): 7 | request = ConversationOutboundPostRequest( 8 | agentId=global_state["base_agent"]["id"], 9 | phoneNumber="+919789384444" 10 | ) 11 | response = atoms_client.start_outbound_call(conversation_outbound_post_request=request) 12 | assert isinstance(response, ConversationOutboundPost200Response) -------------------------------------------------------------------------------- /smallestai/atoms/api_response.py: -------------------------------------------------------------------------------- 1 | """API response object.""" 2 | 3 | from __future__ import annotations 4 | from typing import Optional, Generic, Mapping, TypeVar 5 | from pydantic import Field, StrictInt, StrictBytes, BaseModel 6 | 7 | T = TypeVar("T") 8 | 9 | class ApiResponse(BaseModel, Generic[T]): 10 | """ 11 | API response object 12 | """ 13 | 14 | status_code: StrictInt = Field(description="HTTP status code") 15 | headers: Optional[Mapping[str, str]] = Field(None, description="HTTP headers") 16 | data: T = Field(description="Deserialized data given the data type") 17 | raw_data: StrictBytes = Field(description="Raw data (HTTP response body)") 18 | 19 | model_config = { 20 | "arbitrary_types_allowed": True 21 | } 22 | -------------------------------------------------------------------------------- /docs/atoms/models/ApiResponse.md: -------------------------------------------------------------------------------- 1 | # ApiResponse 2 | 3 | 4 | ## Properties 5 | 6 | Name | Type | Description | Notes 7 | ------------ | ------------- | ------------- | ------------- 8 | **status** | **bool** | | [optional] 9 | **data** | **object** | | [optional] 10 | 11 | ## Example 12 | 13 | ```python 14 | from atoms.models.api_response import ApiResponse 15 | 16 | # TODO update the JSON string below 17 | json = "{}" 18 | # create an instance of ApiResponse from a JSON string 19 | api_response_instance = ApiResponse.from_json(json) 20 | # print the JSON string representation of the object 21 | print(ApiResponse.to_json()) 22 | 23 | # convert the object into a dict 24 | api_response_dict = api_response_instance.to_dict() 25 | # create an instance of ApiResponse from a dict 26 | api_response_from_dict = ApiResponse.from_dict(api_response_dict) 27 | ``` 28 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 29 | 30 | 31 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | MIT License 2 | 3 | Copyright (c) 2021 smallest.ai 4 | 5 | Permission is hereby granted, free of charge, to any person obtaining a copy 6 | of this software and associated documentation files (the "Software"), to deal 7 | in the Software without restriction, including without limitation the rights 8 | to use, copy, modify, merge, publish, distribute, sublicense, and/or sell 9 | copies of the Software, and to permit persons to whom the Software is 10 | furnished to do so, subject to the following conditions: 11 | 12 | The above copyright notice and this permission notice shall be included in all 13 | copies or substantial portions of the Software. 14 | 15 | THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR 16 | IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, 17 | FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE 18 | AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER 19 | LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, 20 | OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE 21 | SOFTWARE. 22 | -------------------------------------------------------------------------------- /docs/atoms/models/WebhookAgent.md: -------------------------------------------------------------------------------- 1 | # WebhookAgent 2 | 3 | 4 | ## Properties 5 | 6 | Name | Type | Description | Notes 7 | ------------ | ------------- | ------------- | ------------- 8 | **id** | **str** | The ID of the agent | [optional] 9 | **name** | **str** | The name of the agent | [optional] 10 | **description** | **str** | The description of the agent | [optional] 11 | 12 | ## Example 13 | 14 | ```python 15 | from atoms.models.webhook_agent import WebhookAgent 16 | 17 | # TODO update the JSON string below 18 | json = "{}" 19 | # create an instance of WebhookAgent from a JSON string 20 | webhook_agent_instance = WebhookAgent.from_json(json) 21 | # print the JSON string representation of the object 22 | print(WebhookAgent.to_json()) 23 | 24 | # convert the object into a dict 25 | webhook_agent_dict = webhook_agent_instance.to_dict() 26 | # create an instance of WebhookAgent from a dict 27 | webhook_agent_from_dict = WebhookAgent.from_dict(webhook_agent_dict) 28 | ``` 29 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 30 | 31 | 32 | -------------------------------------------------------------------------------- /docs/atoms/models/AgentIdDelete200Response.md: -------------------------------------------------------------------------------- 1 | # AgentIdDelete200Response 2 | 3 | 4 | ## Properties 5 | 6 | Name | Type | Description | Notes 7 | ------------ | ------------- | ------------- | ------------- 8 | **status** | **bool** | | [optional] 9 | 10 | ## Example 11 | 12 | ```python 13 | from atoms.models.agent_id_delete200_response import AgentIdDelete200Response 14 | 15 | # TODO update the JSON string below 16 | json = "{}" 17 | # create an instance of AgentIdDelete200Response from a JSON string 18 | agent_id_delete200_response_instance = AgentIdDelete200Response.from_json(json) 19 | # print the JSON string representation of the object 20 | print(AgentIdDelete200Response.to_json()) 21 | 22 | # convert the object into a dict 23 | agent_id_delete200_response_dict = agent_id_delete200_response_instance.to_dict() 24 | # create an instance of AgentIdDelete200Response from a dict 25 | agent_id_delete200_response_from_dict = AgentIdDelete200Response.from_dict(agent_id_delete200_response_dict) 26 | ``` 27 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 28 | 29 | 30 | -------------------------------------------------------------------------------- /docs/atoms/models/UserGet200Response.md: -------------------------------------------------------------------------------- 1 | # UserGet200Response 2 | 3 | 4 | ## Properties 5 | 6 | Name | Type | Description | Notes 7 | ------------ | ------------- | ------------- | ------------- 8 | **status** | **bool** | | [optional] 9 | **data** | [**UserGet200ResponseData**](UserGet200ResponseData.md) | | [optional] 10 | 11 | ## Example 12 | 13 | ```python 14 | from atoms.models.user_get200_response import UserGet200Response 15 | 16 | # TODO update the JSON string below 17 | json = "{}" 18 | # create an instance of UserGet200Response from a JSON string 19 | user_get200_response_instance = UserGet200Response.from_json(json) 20 | # print the JSON string representation of the object 21 | print(UserGet200Response.to_json()) 22 | 23 | # convert the object into a dict 24 | user_get200_response_dict = user_get200_response_instance.to_dict() 25 | # create an instance of UserGet200Response from a dict 26 | user_get200_response_from_dict = UserGet200Response.from_dict(user_get200_response_dict) 27 | ``` 28 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 29 | 30 | 31 | -------------------------------------------------------------------------------- /docs/atoms/models/AgentGet200Response.md: -------------------------------------------------------------------------------- 1 | # AgentGet200Response 2 | 3 | 4 | ## Properties 5 | 6 | Name | Type | Description | Notes 7 | ------------ | ------------- | ------------- | ------------- 8 | **status** | **bool** | | [optional] 9 | **data** | [**AgentGet200ResponseData**](AgentGet200ResponseData.md) | | [optional] 10 | 11 | ## Example 12 | 13 | ```python 14 | from atoms.models.agent_get200_response import AgentGet200Response 15 | 16 | # TODO update the JSON string below 17 | json = "{}" 18 | # create an instance of AgentGet200Response from a JSON string 19 | agent_get200_response_instance = AgentGet200Response.from_json(json) 20 | # print the JSON string representation of the object 21 | print(AgentGet200Response.to_json()) 22 | 23 | # convert the object into a dict 24 | agent_get200_response_dict = agent_get200_response_instance.to_dict() 25 | # create an instance of AgentGet200Response from a dict 26 | agent_get200_response_from_dict = AgentGet200Response.from_dict(agent_get200_response_dict) 27 | ``` 28 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 29 | 30 | 31 | -------------------------------------------------------------------------------- /docs/atoms/models/AgentIdGet200Response.md: -------------------------------------------------------------------------------- 1 | # AgentIdGet200Response 2 | 3 | 4 | ## Properties 5 | 6 | Name | Type | Description | Notes 7 | ------------ | ------------- | ------------- | ------------- 8 | **status** | **bool** | | [optional] 9 | **data** | [**AgentDTO**](AgentDTO.md) | | [optional] 10 | 11 | ## Example 12 | 13 | ```python 14 | from atoms.models.agent_id_get200_response import AgentIdGet200Response 15 | 16 | # TODO update the JSON string below 17 | json = "{}" 18 | # create an instance of AgentIdGet200Response from a JSON string 19 | agent_id_get200_response_instance = AgentIdGet200Response.from_json(json) 20 | # print the JSON string representation of the object 21 | print(AgentIdGet200Response.to_json()) 22 | 23 | # convert the object into a dict 24 | agent_id_get200_response_dict = agent_id_get200_response_instance.to_dict() 25 | # create an instance of AgentIdGet200Response from a dict 26 | agent_id_get200_response_from_dict = AgentIdGet200Response.from_dict(agent_id_get200_response_dict) 27 | ``` 28 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 29 | 30 | 31 | -------------------------------------------------------------------------------- /docs/atoms/models/CampaignGetRequest.md: -------------------------------------------------------------------------------- 1 | # CampaignGetRequest 2 | 3 | 4 | ## Properties 5 | 6 | Name | Type | Description | Notes 7 | ------------ | ------------- | ------------- | ------------- 8 | **page** | **float** | The page number | [optional] [default to 1] 9 | **limit** | **float** | The number of items per page | [optional] [default to 10] 10 | 11 | ## Example 12 | 13 | ```python 14 | from atoms.models.campaign_get_request import CampaignGetRequest 15 | 16 | # TODO update the JSON string below 17 | json = "{}" 18 | # create an instance of CampaignGetRequest from a JSON string 19 | campaign_get_request_instance = CampaignGetRequest.from_json(json) 20 | # print the JSON string representation of the object 21 | print(CampaignGetRequest.to_json()) 22 | 23 | # convert the object into a dict 24 | campaign_get_request_dict = campaign_get_request_instance.to_dict() 25 | # create an instance of CampaignGetRequest from a dict 26 | campaign_get_request_from_dict = CampaignGetRequest.from_dict(campaign_get_request_dict) 27 | ``` 28 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 29 | 30 | 31 | -------------------------------------------------------------------------------- /docs/atoms/models/CampaignPost201Response.md: -------------------------------------------------------------------------------- 1 | # CampaignPost201Response 2 | 3 | 4 | ## Properties 5 | 6 | Name | Type | Description | Notes 7 | ------------ | ------------- | ------------- | ------------- 8 | **status** | **bool** | | [optional] 9 | **data** | **object** | | [optional] 10 | 11 | ## Example 12 | 13 | ```python 14 | from atoms.models.campaign_post201_response import CampaignPost201Response 15 | 16 | # TODO update the JSON string below 17 | json = "{}" 18 | # create an instance of CampaignPost201Response from a JSON string 19 | campaign_post201_response_instance = CampaignPost201Response.from_json(json) 20 | # print the JSON string representation of the object 21 | print(CampaignPost201Response.to_json()) 22 | 23 | # convert the object into a dict 24 | campaign_post201_response_dict = campaign_post201_response_instance.to_dict() 25 | # create an instance of CampaignPost201Response from a dict 26 | campaign_post201_response_from_dict = CampaignPost201Response.from_dict(campaign_post201_response_dict) 27 | ``` 28 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 29 | 30 | 31 | -------------------------------------------------------------------------------- /docs/atoms/models/AudiencePost400Response.md: -------------------------------------------------------------------------------- 1 | # AudiencePost400Response 2 | 3 | 4 | ## Properties 5 | 6 | Name | Type | Description | Notes 7 | ------------ | ------------- | ------------- | ------------- 8 | **status** | **bool** | | [optional] 9 | **errors** | **List[str]** | | [optional] 10 | 11 | ## Example 12 | 13 | ```python 14 | from atoms.models.audience_post400_response import AudiencePost400Response 15 | 16 | # TODO update the JSON string below 17 | json = "{}" 18 | # create an instance of AudiencePost400Response from a JSON string 19 | audience_post400_response_instance = AudiencePost400Response.from_json(json) 20 | # print the JSON string representation of the object 21 | print(AudiencePost400Response.to_json()) 22 | 23 | # convert the object into a dict 24 | audience_post400_response_dict = audience_post400_response_instance.to_dict() 25 | # create an instance of AudiencePost400Response from a dict 26 | audience_post400_response_from_dict = AudiencePost400Response.from_dict(audience_post400_response_dict) 27 | ``` 28 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 29 | 30 | 31 | -------------------------------------------------------------------------------- /docs/atoms/models/KnowledgebasePostRequest.md: -------------------------------------------------------------------------------- 1 | # KnowledgebasePostRequest 2 | 3 | 4 | ## Properties 5 | 6 | Name | Type | Description | Notes 7 | ------------ | ------------- | ------------- | ------------- 8 | **name** | **str** | | 9 | **description** | **str** | | [optional] 10 | 11 | ## Example 12 | 13 | ```python 14 | from atoms.models.knowledgebase_post_request import KnowledgebasePostRequest 15 | 16 | # TODO update the JSON string below 17 | json = "{}" 18 | # create an instance of KnowledgebasePostRequest from a JSON string 19 | knowledgebase_post_request_instance = KnowledgebasePostRequest.from_json(json) 20 | # print the JSON string representation of the object 21 | print(KnowledgebasePostRequest.to_json()) 22 | 23 | # convert the object into a dict 24 | knowledgebase_post_request_dict = knowledgebase_post_request_instance.to_dict() 25 | # create an instance of KnowledgebasePostRequest from a dict 26 | knowledgebase_post_request_from_dict = KnowledgebasePostRequest.from_dict(knowledgebase_post_request_dict) 27 | ``` 28 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 29 | 30 | 31 | -------------------------------------------------------------------------------- /tests/atoms/test_agent_templates_api.py: -------------------------------------------------------------------------------- 1 | import pytest 2 | from smallestai.atoms.atoms_client import AtomsClient 3 | from smallestai.atoms.models.agent_template_get200_response import AgentTemplateGet200Response 4 | from smallestai.atoms.models.agent_from_template_post200_response import AgentFromTemplatePost200Response 5 | from smallestai.atoms.models.create_agent_from_template_request import CreateAgentFromTemplateRequest 6 | 7 | def test_get_agent_templates(atoms_client, global_state): 8 | """Test getting list of agent templates""" 9 | response = atoms_client.get_agent_templates() 10 | assert isinstance(response, AgentTemplateGet200Response) 11 | 12 | def test_create_agent_from_template(atoms_client, global_state): 13 | """Test creating an agent from a template""" 14 | 15 | request = CreateAgentFromTemplateRequest( 16 | templateId=global_state["base_agent_template"]["id"], 17 | agentName="Test Template Agent", 18 | agentDescription="Agent created from template for testing" 19 | ) 20 | 21 | response = atoms_client.create_agent_from_template(create_agent_from_template_request=request) 22 | assert isinstance(response, AgentFromTemplatePost200Response) -------------------------------------------------------------------------------- /docs/atoms/models/BadRequestErrorResponse.md: -------------------------------------------------------------------------------- 1 | # BadRequestErrorResponse 2 | 3 | 4 | ## Properties 5 | 6 | Name | Type | Description | Notes 7 | ------------ | ------------- | ------------- | ------------- 8 | **status** | **bool** | | [optional] 9 | **errors** | **List[str]** | | [optional] 10 | 11 | ## Example 12 | 13 | ```python 14 | from atoms.models.bad_request_error_response import BadRequestErrorResponse 15 | 16 | # TODO update the JSON string below 17 | json = "{}" 18 | # create an instance of BadRequestErrorResponse from a JSON string 19 | bad_request_error_response_instance = BadRequestErrorResponse.from_json(json) 20 | # print the JSON string representation of the object 21 | print(BadRequestErrorResponse.to_json()) 22 | 23 | # convert the object into a dict 24 | bad_request_error_response_dict = bad_request_error_response_instance.to_dict() 25 | # create an instance of BadRequestErrorResponse from a dict 26 | bad_request_error_response_from_dict = BadRequestErrorResponse.from_dict(bad_request_error_response_dict) 27 | ``` 28 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 29 | 30 | 31 | -------------------------------------------------------------------------------- /docs/atoms/models/WebhookPost201Response.md: -------------------------------------------------------------------------------- 1 | # WebhookPost201Response 2 | 3 | 4 | ## Properties 5 | 6 | Name | Type | Description | Notes 7 | ------------ | ------------- | ------------- | ------------- 8 | **status** | **bool** | | [optional] 9 | **data** | **str** | The ID of the created webhook | [optional] 10 | 11 | ## Example 12 | 13 | ```python 14 | from atoms.models.webhook_post201_response import WebhookPost201Response 15 | 16 | # TODO update the JSON string below 17 | json = "{}" 18 | # create an instance of WebhookPost201Response from a JSON string 19 | webhook_post201_response_instance = WebhookPost201Response.from_json(json) 20 | # print the JSON string representation of the object 21 | print(WebhookPost201Response.to_json()) 22 | 23 | # convert the object into a dict 24 | webhook_post201_response_dict = webhook_post201_response_instance.to_dict() 25 | # create an instance of WebhookPost201Response from a dict 26 | webhook_post201_response_from_dict = WebhookPost201Response.from_dict(webhook_post201_response_dict) 27 | ``` 28 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 29 | 30 | 31 | -------------------------------------------------------------------------------- /docs/atoms/models/CampaignGet200ResponseData.md: -------------------------------------------------------------------------------- 1 | # CampaignGet200ResponseData 2 | 3 | 4 | ## Properties 5 | 6 | Name | Type | Description | Notes 7 | ------------ | ------------- | ------------- | ------------- 8 | **campaigns** | **List[object]** | | [optional] 9 | 10 | ## Example 11 | 12 | ```python 13 | from atoms.models.campaign_get200_response_data import CampaignGet200ResponseData 14 | 15 | # TODO update the JSON string below 16 | json = "{}" 17 | # create an instance of CampaignGet200ResponseData from a JSON string 18 | campaign_get200_response_data_instance = CampaignGet200ResponseData.from_json(json) 19 | # print the JSON string representation of the object 20 | print(CampaignGet200ResponseData.to_json()) 21 | 22 | # convert the object into a dict 23 | campaign_get200_response_data_dict = campaign_get200_response_data_instance.to_dict() 24 | # create an instance of CampaignGet200ResponseData from a dict 25 | campaign_get200_response_data_from_dict = CampaignGet200ResponseData.from_dict(campaign_get200_response_data_dict) 26 | ``` 27 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 28 | 29 | 30 | -------------------------------------------------------------------------------- /docs/atoms/models/UnauthorizedErrorReponse.md: -------------------------------------------------------------------------------- 1 | # UnauthorizedErrorReponse 2 | 3 | 4 | ## Properties 5 | 6 | Name | Type | Description | Notes 7 | ------------ | ------------- | ------------- | ------------- 8 | **status** | **bool** | | [optional] 9 | **errors** | **List[str]** | | [optional] 10 | 11 | ## Example 12 | 13 | ```python 14 | from atoms.models.unauthorized_error_reponse import UnauthorizedErrorReponse 15 | 16 | # TODO update the JSON string below 17 | json = "{}" 18 | # create an instance of UnauthorizedErrorReponse from a JSON string 19 | unauthorized_error_reponse_instance = UnauthorizedErrorReponse.from_json(json) 20 | # print the JSON string representation of the object 21 | print(UnauthorizedErrorReponse.to_json()) 22 | 23 | # convert the object into a dict 24 | unauthorized_error_reponse_dict = unauthorized_error_reponse_instance.to_dict() 25 | # create an instance of UnauthorizedErrorReponse from a dict 26 | unauthorized_error_reponse_from_dict = UnauthorizedErrorReponse.from_dict(unauthorized_error_reponse_dict) 27 | ``` 28 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 29 | 30 | 31 | -------------------------------------------------------------------------------- /docs/atoms/models/WebhookGet200Response.md: -------------------------------------------------------------------------------- 1 | # WebhookGet200Response 2 | 3 | 4 | ## Properties 5 | 6 | Name | Type | Description | Notes 7 | ------------ | ------------- | ------------- | ------------- 8 | **status** | **bool** | | [optional] 9 | **data** | [**WebhookGet200ResponseData**](WebhookGet200ResponseData.md) | | [optional] 10 | 11 | ## Example 12 | 13 | ```python 14 | from atoms.models.webhook_get200_response import WebhookGet200Response 15 | 16 | # TODO update the JSON string below 17 | json = "{}" 18 | # create an instance of WebhookGet200Response from a JSON string 19 | webhook_get200_response_instance = WebhookGet200Response.from_json(json) 20 | # print the JSON string representation of the object 21 | print(WebhookGet200Response.to_json()) 22 | 23 | # convert the object into a dict 24 | webhook_get200_response_dict = webhook_get200_response_instance.to_dict() 25 | # create an instance of WebhookGet200Response from a dict 26 | webhook_get200_response_from_dict = WebhookGet200Response.from_dict(webhook_get200_response_dict) 27 | ``` 28 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 29 | 30 | 31 | -------------------------------------------------------------------------------- /docs/atoms/models/AudienceIdGet400Response.md: -------------------------------------------------------------------------------- 1 | # AudienceIdGet400Response 2 | 3 | 4 | ## Properties 5 | 6 | Name | Type | Description | Notes 7 | ------------ | ------------- | ------------- | ------------- 8 | **status** | **bool** | | [optional] 9 | **errors** | **List[str]** | | [optional] 10 | 11 | ## Example 12 | 13 | ```python 14 | from atoms.models.audience_id_get400_response import AudienceIdGet400Response 15 | 16 | # TODO update the JSON string below 17 | json = "{}" 18 | # create an instance of AudienceIdGet400Response from a JSON string 19 | audience_id_get400_response_instance = AudienceIdGet400Response.from_json(json) 20 | # print the JSON string representation of the object 21 | print(AudienceIdGet400Response.to_json()) 22 | 23 | # convert the object into a dict 24 | audience_id_get400_response_dict = audience_id_get400_response_instance.to_dict() 25 | # create an instance of AudienceIdGet400Response from a dict 26 | audience_id_get400_response_from_dict = AudienceIdGet400Response.from_dict(audience_id_get400_response_dict) 27 | ``` 28 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 29 | 30 | 31 | -------------------------------------------------------------------------------- /docs/atoms/models/AudienceIdGet403Response.md: -------------------------------------------------------------------------------- 1 | # AudienceIdGet403Response 2 | 3 | 4 | ## Properties 5 | 6 | Name | Type | Description | Notes 7 | ------------ | ------------- | ------------- | ------------- 8 | **status** | **bool** | | [optional] 9 | **errors** | **List[str]** | | [optional] 10 | 11 | ## Example 12 | 13 | ```python 14 | from atoms.models.audience_id_get403_response import AudienceIdGet403Response 15 | 16 | # TODO update the JSON string below 17 | json = "{}" 18 | # create an instance of AudienceIdGet403Response from a JSON string 19 | audience_id_get403_response_instance = AudienceIdGet403Response.from_json(json) 20 | # print the JSON string representation of the object 21 | print(AudienceIdGet403Response.to_json()) 22 | 23 | # convert the object into a dict 24 | audience_id_get403_response_dict = audience_id_get403_response_instance.to_dict() 25 | # create an instance of AudienceIdGet403Response from a dict 26 | audience_id_get403_response_from_dict = AudienceIdGet403Response.from_dict(audience_id_get403_response_dict) 27 | ``` 28 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 29 | 30 | 31 | -------------------------------------------------------------------------------- /docs/atoms/models/AudienceIdGet404Response.md: -------------------------------------------------------------------------------- 1 | # AudienceIdGet404Response 2 | 3 | 4 | ## Properties 5 | 6 | Name | Type | Description | Notes 7 | ------------ | ------------- | ------------- | ------------- 8 | **status** | **bool** | | [optional] 9 | **errors** | **List[str]** | | [optional] 10 | 11 | ## Example 12 | 13 | ```python 14 | from atoms.models.audience_id_get404_response import AudienceIdGet404Response 15 | 16 | # TODO update the JSON string below 17 | json = "{}" 18 | # create an instance of AudienceIdGet404Response from a JSON string 19 | audience_id_get404_response_instance = AudienceIdGet404Response.from_json(json) 20 | # print the JSON string representation of the object 21 | print(AudienceIdGet404Response.to_json()) 22 | 23 | # convert the object into a dict 24 | audience_id_get404_response_dict = audience_id_get404_response_instance.to_dict() 25 | # create an instance of AudienceIdGet404Response from a dict 26 | audience_id_get404_response_from_dict = AudienceIdGet404Response.from_dict(audience_id_get404_response_dict) 27 | ``` 28 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 29 | 30 | 31 | -------------------------------------------------------------------------------- /docs/atoms/models/AgentIdPatch200Response.md: -------------------------------------------------------------------------------- 1 | # AgentIdPatch200Response 2 | 3 | 4 | ## Properties 5 | 6 | Name | Type | Description | Notes 7 | ------------ | ------------- | ------------- | ------------- 8 | **status** | **bool** | | [optional] 9 | **data** | **str** | The ID of the updated agent | [optional] 10 | 11 | ## Example 12 | 13 | ```python 14 | from atoms.models.agent_id_patch200_response import AgentIdPatch200Response 15 | 16 | # TODO update the JSON string below 17 | json = "{}" 18 | # create an instance of AgentIdPatch200Response from a JSON string 19 | agent_id_patch200_response_instance = AgentIdPatch200Response.from_json(json) 20 | # print the JSON string representation of the object 21 | print(AgentIdPatch200Response.to_json()) 22 | 23 | # convert the object into a dict 24 | agent_id_patch200_response_dict = agent_id_patch200_response_instance.to_dict() 25 | # create an instance of AgentIdPatch200Response from a dict 26 | agent_id_patch200_response_from_dict = AgentIdPatch200Response.from_dict(agent_id_patch200_response_dict) 27 | ``` 28 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 29 | 30 | 31 | -------------------------------------------------------------------------------- /docs/atoms/models/CampaignGet200Response.md: -------------------------------------------------------------------------------- 1 | # CampaignGet200Response 2 | 3 | 4 | ## Properties 5 | 6 | Name | Type | Description | Notes 7 | ------------ | ------------- | ------------- | ------------- 8 | **status** | **bool** | | [optional] 9 | **data** | [**CampaignGet200ResponseData**](CampaignGet200ResponseData.md) | | [optional] 10 | 11 | ## Example 12 | 13 | ```python 14 | from atoms.models.campaign_get200_response import CampaignGet200Response 15 | 16 | # TODO update the JSON string below 17 | json = "{}" 18 | # create an instance of CampaignGet200Response from a JSON string 19 | campaign_get200_response_instance = CampaignGet200Response.from_json(json) 20 | # print the JSON string representation of the object 21 | print(CampaignGet200Response.to_json()) 22 | 23 | # convert the object into a dict 24 | campaign_get200_response_dict = campaign_get200_response_instance.to_dict() 25 | # create an instance of CampaignGet200Response from a dict 26 | campaign_get200_response_from_dict = CampaignGet200Response.from_dict(campaign_get200_response_dict) 27 | ``` 28 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 29 | 30 | 31 | -------------------------------------------------------------------------------- /docs/atoms/models/AgentGet200ResponseData.md: -------------------------------------------------------------------------------- 1 | # AgentGet200ResponseData 2 | 3 | 4 | ## Properties 5 | 6 | Name | Type | Description | Notes 7 | ------------ | ------------- | ------------- | ------------- 8 | **agents** | [**List[AgentDTO]**](AgentDTO.md) | | [optional] 9 | **total** | **float** | Total number of agents | [optional] 10 | 11 | ## Example 12 | 13 | ```python 14 | from atoms.models.agent_get200_response_data import AgentGet200ResponseData 15 | 16 | # TODO update the JSON string below 17 | json = "{}" 18 | # create an instance of AgentGet200ResponseData from a JSON string 19 | agent_get200_response_data_instance = AgentGet200ResponseData.from_json(json) 20 | # print the JSON string representation of the object 21 | print(AgentGet200ResponseData.to_json()) 22 | 23 | # convert the object into a dict 24 | agent_get200_response_data_dict = agent_get200_response_data_instance.to_dict() 25 | # create an instance of AgentGet200ResponseData from a dict 26 | agent_get200_response_data_from_dict = AgentGet200ResponseData.from_dict(agent_get200_response_data_dict) 27 | ``` 28 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 29 | 30 | 31 | -------------------------------------------------------------------------------- /docs/atoms/models/WebhookIdDelete404Response.md: -------------------------------------------------------------------------------- 1 | # WebhookIdDelete404Response 2 | 3 | 4 | ## Properties 5 | 6 | Name | Type | Description | Notes 7 | ------------ | ------------- | ------------- | ------------- 8 | **status** | **bool** | | [optional] 9 | **errors** | **List[str]** | | [optional] 10 | 11 | ## Example 12 | 13 | ```python 14 | from atoms.models.webhook_id_delete404_response import WebhookIdDelete404Response 15 | 16 | # TODO update the JSON string below 17 | json = "{}" 18 | # create an instance of WebhookIdDelete404Response from a JSON string 19 | webhook_id_delete404_response_instance = WebhookIdDelete404Response.from_json(json) 20 | # print the JSON string representation of the object 21 | print(WebhookIdDelete404Response.to_json()) 22 | 23 | # convert the object into a dict 24 | webhook_id_delete404_response_dict = webhook_id_delete404_response_instance.to_dict() 25 | # create an instance of WebhookIdDelete404Response from a dict 26 | webhook_id_delete404_response_from_dict = WebhookIdDelete404Response.from_dict(webhook_id_delete404_response_dict) 27 | ``` 28 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 29 | 30 | 31 | -------------------------------------------------------------------------------- /docs/atoms/models/AudienceGet200Response.md: -------------------------------------------------------------------------------- 1 | # AudienceGet200Response 2 | 3 | 4 | ## Properties 5 | 6 | Name | Type | Description | Notes 7 | ------------ | ------------- | ------------- | ------------- 8 | **status** | **bool** | | [optional] 9 | **data** | [**List[AudienceGet200ResponseDataInner]**](AudienceGet200ResponseDataInner.md) | | [optional] 10 | 11 | ## Example 12 | 13 | ```python 14 | from atoms.models.audience_get200_response import AudienceGet200Response 15 | 16 | # TODO update the JSON string below 17 | json = "{}" 18 | # create an instance of AudienceGet200Response from a JSON string 19 | audience_get200_response_instance = AudienceGet200Response.from_json(json) 20 | # print the JSON string representation of the object 21 | print(AudienceGet200Response.to_json()) 22 | 23 | # convert the object into a dict 24 | audience_get200_response_dict = audience_get200_response_instance.to_dict() 25 | # create an instance of AudienceGet200Response from a dict 26 | audience_get200_response_from_dict = AudienceGet200Response.from_dict(audience_get200_response_dict) 27 | ``` 28 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 29 | 30 | 31 | -------------------------------------------------------------------------------- /docs/atoms/models/AudiencePost200Response.md: -------------------------------------------------------------------------------- 1 | # AudiencePost200Response 2 | 3 | 4 | ## Properties 5 | 6 | Name | Type | Description | Notes 7 | ------------ | ------------- | ------------- | ------------- 8 | **status** | **bool** | | [optional] 9 | **data** | [**AudiencePost200ResponseData**](AudiencePost200ResponseData.md) | | [optional] 10 | 11 | ## Example 12 | 13 | ```python 14 | from atoms.models.audience_post200_response import AudiencePost200Response 15 | 16 | # TODO update the JSON string below 17 | json = "{}" 18 | # create an instance of AudiencePost200Response from a JSON string 19 | audience_post200_response_instance = AudiencePost200Response.from_json(json) 20 | # print the JSON string representation of the object 21 | print(AudiencePost200Response.to_json()) 22 | 23 | # convert the object into a dict 24 | audience_post200_response_dict = audience_post200_response_instance.to_dict() 25 | # create an instance of AudiencePost200Response from a dict 26 | audience_post200_response_from_dict = AudiencePost200Response.from_dict(audience_post200_response_dict) 27 | ``` 28 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 29 | 30 | 31 | -------------------------------------------------------------------------------- /docs/atoms/models/AudienceIdDelete200Response.md: -------------------------------------------------------------------------------- 1 | # AudienceIdDelete200Response 2 | 3 | 4 | ## Properties 5 | 6 | Name | Type | Description | Notes 7 | ------------ | ------------- | ------------- | ------------- 8 | **status** | **bool** | | [optional] 9 | **data** | **List[str]** | | [optional] 10 | 11 | ## Example 12 | 13 | ```python 14 | from atoms.models.audience_id_delete200_response import AudienceIdDelete200Response 15 | 16 | # TODO update the JSON string below 17 | json = "{}" 18 | # create an instance of AudienceIdDelete200Response from a JSON string 19 | audience_id_delete200_response_instance = AudienceIdDelete200Response.from_json(json) 20 | # print the JSON string representation of the object 21 | print(AudienceIdDelete200Response.to_json()) 22 | 23 | # convert the object into a dict 24 | audience_id_delete200_response_dict = audience_id_delete200_response_instance.to_dict() 25 | # create an instance of AudienceIdDelete200Response from a dict 26 | audience_id_delete200_response_from_dict = AudienceIdDelete200Response.from_dict(audience_id_delete200_response_dict) 27 | ``` 28 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 29 | 30 | 31 | -------------------------------------------------------------------------------- /docs/atoms/models/AudienceIdDelete400Response.md: -------------------------------------------------------------------------------- 1 | # AudienceIdDelete400Response 2 | 3 | 4 | ## Properties 5 | 6 | Name | Type | Description | Notes 7 | ------------ | ------------- | ------------- | ------------- 8 | **status** | **bool** | | [optional] 9 | **errors** | **List[str]** | | [optional] 10 | 11 | ## Example 12 | 13 | ```python 14 | from atoms.models.audience_id_delete400_response import AudienceIdDelete400Response 15 | 16 | # TODO update the JSON string below 17 | json = "{}" 18 | # create an instance of AudienceIdDelete400Response from a JSON string 19 | audience_id_delete400_response_instance = AudienceIdDelete400Response.from_json(json) 20 | # print the JSON string representation of the object 21 | print(AudienceIdDelete400Response.to_json()) 22 | 23 | # convert the object into a dict 24 | audience_id_delete400_response_dict = audience_id_delete400_response_instance.to_dict() 25 | # create an instance of AudienceIdDelete400Response from a dict 26 | audience_id_delete400_response_from_dict = AudienceIdDelete400Response.from_dict(audience_id_delete400_response_dict) 27 | ``` 28 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 29 | 30 | 31 | -------------------------------------------------------------------------------- /docs/atoms/models/InternalServerErrorResponse.md: -------------------------------------------------------------------------------- 1 | # InternalServerErrorResponse 2 | 3 | 4 | ## Properties 5 | 6 | Name | Type | Description | Notes 7 | ------------ | ------------- | ------------- | ------------- 8 | **status** | **bool** | | [optional] 9 | **errors** | **List[str]** | | [optional] 10 | 11 | ## Example 12 | 13 | ```python 14 | from atoms.models.internal_server_error_response import InternalServerErrorResponse 15 | 16 | # TODO update the JSON string below 17 | json = "{}" 18 | # create an instance of InternalServerErrorResponse from a JSON string 19 | internal_server_error_response_instance = InternalServerErrorResponse.from_json(json) 20 | # print the JSON string representation of the object 21 | print(InternalServerErrorResponse.to_json()) 22 | 23 | # convert the object into a dict 24 | internal_server_error_response_dict = internal_server_error_response_instance.to_dict() 25 | # create an instance of InternalServerErrorResponse from a dict 26 | internal_server_error_response_from_dict = InternalServerErrorResponse.from_dict(internal_server_error_response_dict) 27 | ``` 28 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 29 | 30 | 31 | -------------------------------------------------------------------------------- /docs/atoms/models/KnowledgebasePost201Response.md: -------------------------------------------------------------------------------- 1 | # KnowledgebasePost201Response 2 | 3 | 4 | ## Properties 5 | 6 | Name | Type | Description | Notes 7 | ------------ | ------------- | ------------- | ------------- 8 | **status** | **bool** | | [optional] 9 | **data** | **str** | | [optional] 10 | 11 | ## Example 12 | 13 | ```python 14 | from atoms.models.knowledgebase_post201_response import KnowledgebasePost201Response 15 | 16 | # TODO update the JSON string below 17 | json = "{}" 18 | # create an instance of KnowledgebasePost201Response from a JSON string 19 | knowledgebase_post201_response_instance = KnowledgebasePost201Response.from_json(json) 20 | # print the JSON string representation of the object 21 | print(KnowledgebasePost201Response.to_json()) 22 | 23 | # convert the object into a dict 24 | knowledgebase_post201_response_dict = knowledgebase_post201_response_instance.to_dict() 25 | # create an instance of KnowledgebasePost201Response from a dict 26 | knowledgebase_post201_response_from_dict = KnowledgebasePost201Response.from_dict(knowledgebase_post201_response_dict) 27 | ``` 28 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 29 | 30 | 31 | -------------------------------------------------------------------------------- /docs/atoms/models/CampaignIdGet200Response.md: -------------------------------------------------------------------------------- 1 | # CampaignIdGet200Response 2 | 3 | 4 | ## Properties 5 | 6 | Name | Type | Description | Notes 7 | ------------ | ------------- | ------------- | ------------- 8 | **status** | **bool** | | [optional] 9 | **data** | [**CampaignIdGet200ResponseData**](CampaignIdGet200ResponseData.md) | | [optional] 10 | 11 | ## Example 12 | 13 | ```python 14 | from atoms.models.campaign_id_get200_response import CampaignIdGet200Response 15 | 16 | # TODO update the JSON string below 17 | json = "{}" 18 | # create an instance of CampaignIdGet200Response from a JSON string 19 | campaign_id_get200_response_instance = CampaignIdGet200Response.from_json(json) 20 | # print the JSON string representation of the object 21 | print(CampaignIdGet200Response.to_json()) 22 | 23 | # convert the object into a dict 24 | campaign_id_get200_response_dict = campaign_id_get200_response_instance.to_dict() 25 | # create an instance of CampaignIdGet200Response from a dict 26 | campaign_id_get200_response_from_dict = CampaignIdGet200Response.from_dict(campaign_id_get200_response_dict) 27 | ``` 28 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 29 | 30 | 31 | -------------------------------------------------------------------------------- /docs/atoms/models/AudienceIdGet200Response.md: -------------------------------------------------------------------------------- 1 | # AudienceIdGet200Response 2 | 3 | 4 | ## Properties 5 | 6 | Name | Type | Description | Notes 7 | ------------ | ------------- | ------------- | ------------- 8 | **status** | **bool** | | [optional] 9 | **data** | [**AudienceGet200ResponseDataInner**](AudienceGet200ResponseDataInner.md) | | [optional] 10 | 11 | ## Example 12 | 13 | ```python 14 | from atoms.models.audience_id_get200_response import AudienceIdGet200Response 15 | 16 | # TODO update the JSON string below 17 | json = "{}" 18 | # create an instance of AudienceIdGet200Response from a JSON string 19 | audience_id_get200_response_instance = AudienceIdGet200Response.from_json(json) 20 | # print the JSON string representation of the object 21 | print(AudienceIdGet200Response.to_json()) 22 | 23 | # convert the object into a dict 24 | audience_id_get200_response_dict = audience_id_get200_response_instance.to_dict() 25 | # create an instance of AudienceIdGet200Response from a dict 26 | audience_id_get200_response_from_dict = AudienceIdGet200Response.from_dict(audience_id_get200_response_dict) 27 | ``` 28 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 29 | 30 | 31 | -------------------------------------------------------------------------------- /docs/atoms/models/AudienceIdMembersDeleteRequest.md: -------------------------------------------------------------------------------- 1 | # AudienceIdMembersDeleteRequest 2 | 3 | 4 | ## Properties 5 | 6 | Name | Type | Description | Notes 7 | ------------ | ------------- | ------------- | ------------- 8 | **member_ids** | **List[str]** | Array of member IDs to delete | 9 | 10 | ## Example 11 | 12 | ```python 13 | from atoms.models.audience_id_members_delete_request import AudienceIdMembersDeleteRequest 14 | 15 | # TODO update the JSON string below 16 | json = "{}" 17 | # create an instance of AudienceIdMembersDeleteRequest from a JSON string 18 | audience_id_members_delete_request_instance = AudienceIdMembersDeleteRequest.from_json(json) 19 | # print the JSON string representation of the object 20 | print(AudienceIdMembersDeleteRequest.to_json()) 21 | 22 | # convert the object into a dict 23 | audience_id_members_delete_request_dict = audience_id_members_delete_request_instance.to_dict() 24 | # create an instance of AudienceIdMembersDeleteRequest from a dict 25 | audience_id_members_delete_request_from_dict = AudienceIdMembersDeleteRequest.from_dict(audience_id_members_delete_request_dict) 26 | ``` 27 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 28 | 29 | 30 | -------------------------------------------------------------------------------- /docs/atoms/models/KnowledgebaseGet200Response.md: -------------------------------------------------------------------------------- 1 | # KnowledgebaseGet200Response 2 | 3 | 4 | ## Properties 5 | 6 | Name | Type | Description | Notes 7 | ------------ | ------------- | ------------- | ------------- 8 | **status** | **bool** | | [optional] 9 | **data** | [**List[KnowledgeBase]**](KnowledgeBase.md) | | [optional] 10 | 11 | ## Example 12 | 13 | ```python 14 | from atoms.models.knowledgebase_get200_response import KnowledgebaseGet200Response 15 | 16 | # TODO update the JSON string below 17 | json = "{}" 18 | # create an instance of KnowledgebaseGet200Response from a JSON string 19 | knowledgebase_get200_response_instance = KnowledgebaseGet200Response.from_json(json) 20 | # print the JSON string representation of the object 21 | print(KnowledgebaseGet200Response.to_json()) 22 | 23 | # convert the object into a dict 24 | knowledgebase_get200_response_dict = knowledgebase_get200_response_instance.to_dict() 25 | # create an instance of KnowledgebaseGet200Response from a dict 26 | knowledgebase_get200_response_from_dict = KnowledgebaseGet200Response.from_dict(knowledgebase_get200_response_dict) 27 | ``` 28 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 29 | 30 | 31 | -------------------------------------------------------------------------------- /docs/atoms/models/WebhookPostRequest.md: -------------------------------------------------------------------------------- 1 | # WebhookPostRequest 2 | 3 | 4 | ## Properties 5 | 6 | Name | Type | Description | Notes 7 | ------------ | ------------- | ------------- | ------------- 8 | **endpoint** | **str** | The webhook endpoint URL | 9 | **description** | **str** | The description of the webhook | 10 | **events** | [**List[WebhookPostRequestEventsInner]**](WebhookPostRequestEventsInner.md) | Array of events to subscribe to | 11 | 12 | ## Example 13 | 14 | ```python 15 | from atoms.models.webhook_post_request import WebhookPostRequest 16 | 17 | # TODO update the JSON string below 18 | json = "{}" 19 | # create an instance of WebhookPostRequest from a JSON string 20 | webhook_post_request_instance = WebhookPostRequest.from_json(json) 21 | # print the JSON string representation of the object 22 | print(WebhookPostRequest.to_json()) 23 | 24 | # convert the object into a dict 25 | webhook_post_request_dict = webhook_post_request_instance.to_dict() 26 | # create an instance of WebhookPostRequest from a dict 27 | webhook_post_request_from_dict = WebhookPostRequest.from_dict(webhook_post_request_dict) 28 | ``` 29 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 30 | 31 | 32 | -------------------------------------------------------------------------------- /docs/atoms/models/AgentIdWorkflowGet404Response.md: -------------------------------------------------------------------------------- 1 | # AgentIdWorkflowGet404Response 2 | 3 | 4 | ## Properties 5 | 6 | Name | Type | Description | Notes 7 | ------------ | ------------- | ------------- | ------------- 8 | **status** | **bool** | | [optional] 9 | **errors** | **List[str]** | | [optional] 10 | 11 | ## Example 12 | 13 | ```python 14 | from atoms.models.agent_id_workflow_get404_response import AgentIdWorkflowGet404Response 15 | 16 | # TODO update the JSON string below 17 | json = "{}" 18 | # create an instance of AgentIdWorkflowGet404Response from a JSON string 19 | agent_id_workflow_get404_response_instance = AgentIdWorkflowGet404Response.from_json(json) 20 | # print the JSON string representation of the object 21 | print(AgentIdWorkflowGet404Response.to_json()) 22 | 23 | # convert the object into a dict 24 | agent_id_workflow_get404_response_dict = agent_id_workflow_get404_response_instance.to_dict() 25 | # create an instance of AgentIdWorkflowGet404Response from a dict 26 | agent_id_workflow_get404_response_from_dict = AgentIdWorkflowGet404Response.from_dict(agent_id_workflow_get404_response_dict) 27 | ``` 28 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 29 | 30 | 31 | -------------------------------------------------------------------------------- /docs/atoms/models/CampaignPostRequest.md: -------------------------------------------------------------------------------- 1 | # CampaignPostRequest 2 | 3 | 4 | ## Properties 5 | 6 | Name | Type | Description | Notes 7 | ------------ | ------------- | ------------- | ------------- 8 | **name** | **str** | The name of the campaign | 9 | **description** | **str** | The description of the campaign | [optional] 10 | **audience_id** | **str** | The ID of the audience | 11 | **agent_id** | **str** | The ID of the agent | 12 | 13 | ## Example 14 | 15 | ```python 16 | from atoms.models.campaign_post_request import CampaignPostRequest 17 | 18 | # TODO update the JSON string below 19 | json = "{}" 20 | # create an instance of CampaignPostRequest from a JSON string 21 | campaign_post_request_instance = CampaignPostRequest.from_json(json) 22 | # print the JSON string representation of the object 23 | print(CampaignPostRequest.to_json()) 24 | 25 | # convert the object into a dict 26 | campaign_post_request_dict = campaign_post_request_instance.to_dict() 27 | # create an instance of CampaignPostRequest from a dict 28 | campaign_post_request_from_dict = CampaignPostRequest.from_dict(campaign_post_request_dict) 29 | ``` 30 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 31 | 32 | 33 | -------------------------------------------------------------------------------- /docs/atoms/models/OrganizationGet200Response.md: -------------------------------------------------------------------------------- 1 | # OrganizationGet200Response 2 | 3 | 4 | ## Properties 5 | 6 | Name | Type | Description | Notes 7 | ------------ | ------------- | ------------- | ------------- 8 | **status** | **bool** | | [optional] 9 | **data** | [**OrganizationGet200ResponseData**](OrganizationGet200ResponseData.md) | | [optional] 10 | 11 | ## Example 12 | 13 | ```python 14 | from atoms.models.organization_get200_response import OrganizationGet200Response 15 | 16 | # TODO update the JSON string below 17 | json = "{}" 18 | # create an instance of OrganizationGet200Response from a JSON string 19 | organization_get200_response_instance = OrganizationGet200Response.from_json(json) 20 | # print the JSON string representation of the object 21 | print(OrganizationGet200Response.to_json()) 22 | 23 | # convert the object into a dict 24 | organization_get200_response_dict = organization_get200_response_instance.to_dict() 25 | # create an instance of OrganizationGet200Response from a dict 26 | organization_get200_response_from_dict = OrganizationGet200Response.from_dict(organization_get200_response_dict) 27 | ``` 28 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 29 | 30 | 31 | -------------------------------------------------------------------------------- /docs/atoms/models/AgentDTOLanguage.md: -------------------------------------------------------------------------------- 1 | # AgentDTOLanguage 2 | 3 | The language configuration of the agent 4 | 5 | ## Properties 6 | 7 | Name | Type | Description | Notes 8 | ------------ | ------------- | ------------- | ------------- 9 | **enabled** | **str** | The language of the agent | [optional] 10 | **switching** | [**AgentDTOLanguageSwitching**](AgentDTOLanguageSwitching.md) | | [optional] 11 | **supported** | **List[str]** | The supported languages of the agent | [optional] 12 | 13 | ## Example 14 | 15 | ```python 16 | from atoms.models.agent_dto_language import AgentDTOLanguage 17 | 18 | # TODO update the JSON string below 19 | json = "{}" 20 | # create an instance of AgentDTOLanguage from a JSON string 21 | agent_dto_language_instance = AgentDTOLanguage.from_json(json) 22 | # print the JSON string representation of the object 23 | print(AgentDTOLanguage.to_json()) 24 | 25 | # convert the object into a dict 26 | agent_dto_language_dict = agent_dto_language_instance.to_dict() 27 | # create an instance of AgentDTOLanguage from a dict 28 | agent_dto_language_from_dict = AgentDTOLanguage.from_dict(agent_dto_language_dict) 29 | ``` 30 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 31 | 32 | 33 | -------------------------------------------------------------------------------- /docs/atoms/models/AudienceIdMembersPostRequest.md: -------------------------------------------------------------------------------- 1 | # AudienceIdMembersPostRequest 2 | 3 | 4 | ## Properties 5 | 6 | Name | Type | Description | Notes 7 | ------------ | ------------- | ------------- | ------------- 8 | **members** | **List[object]** | Array of member objects with dynamic structure based on audience configuration | 9 | 10 | ## Example 11 | 12 | ```python 13 | from atoms.models.audience_id_members_post_request import AudienceIdMembersPostRequest 14 | 15 | # TODO update the JSON string below 16 | json = "{}" 17 | # create an instance of AudienceIdMembersPostRequest from a JSON string 18 | audience_id_members_post_request_instance = AudienceIdMembersPostRequest.from_json(json) 19 | # print the JSON string representation of the object 20 | print(AudienceIdMembersPostRequest.to_json()) 21 | 22 | # convert the object into a dict 23 | audience_id_members_post_request_dict = audience_id_members_post_request_instance.to_dict() 24 | # create an instance of AudienceIdMembersPostRequest from a dict 25 | audience_id_members_post_request_from_dict = AudienceIdMembersPostRequest.from_dict(audience_id_members_post_request_dict) 26 | ``` 27 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 28 | 29 | 30 | -------------------------------------------------------------------------------- /docs/atoms/models/KnowledgebaseIdGet200Response.md: -------------------------------------------------------------------------------- 1 | # KnowledgebaseIdGet200Response 2 | 3 | 4 | ## Properties 5 | 6 | Name | Type | Description | Notes 7 | ------------ | ------------- | ------------- | ------------- 8 | **status** | **bool** | | [optional] 9 | **data** | [**KnowledgeBase**](KnowledgeBase.md) | | [optional] 10 | 11 | ## Example 12 | 13 | ```python 14 | from atoms.models.knowledgebase_id_get200_response import KnowledgebaseIdGet200Response 15 | 16 | # TODO update the JSON string below 17 | json = "{}" 18 | # create an instance of KnowledgebaseIdGet200Response from a JSON string 19 | knowledgebase_id_get200_response_instance = KnowledgebaseIdGet200Response.from_json(json) 20 | # print the JSON string representation of the object 21 | print(KnowledgebaseIdGet200Response.to_json()) 22 | 23 | # convert the object into a dict 24 | knowledgebase_id_get200_response_dict = knowledgebase_id_get200_response_instance.to_dict() 25 | # create an instance of KnowledgebaseIdGet200Response from a dict 26 | knowledgebase_id_get200_response_from_dict = KnowledgebaseIdGet200Response.from_dict(knowledgebase_id_get200_response_dict) 27 | ``` 28 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 29 | 30 | 31 | -------------------------------------------------------------------------------- /docs/atoms/models/AudienceIdMembersGet400Response.md: -------------------------------------------------------------------------------- 1 | # AudienceIdMembersGet400Response 2 | 3 | 4 | ## Properties 5 | 6 | Name | Type | Description | Notes 7 | ------------ | ------------- | ------------- | ------------- 8 | **status** | **str** | | [optional] 9 | **errors** | **List[str]** | | [optional] 10 | 11 | ## Example 12 | 13 | ```python 14 | from atoms.models.audience_id_members_get400_response import AudienceIdMembersGet400Response 15 | 16 | # TODO update the JSON string below 17 | json = "{}" 18 | # create an instance of AudienceIdMembersGet400Response from a JSON string 19 | audience_id_members_get400_response_instance = AudienceIdMembersGet400Response.from_json(json) 20 | # print the JSON string representation of the object 21 | print(AudienceIdMembersGet400Response.to_json()) 22 | 23 | # convert the object into a dict 24 | audience_id_members_get400_response_dict = audience_id_members_get400_response_instance.to_dict() 25 | # create an instance of AudienceIdMembersGet400Response from a dict 26 | audience_id_members_get400_response_from_dict = AudienceIdMembersGet400Response.from_dict(audience_id_members_get400_response_dict) 27 | ``` 28 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 29 | 30 | 31 | -------------------------------------------------------------------------------- /docs/atoms/models/AudienceIdMembersGet500Response.md: -------------------------------------------------------------------------------- 1 | # AudienceIdMembersGet500Response 2 | 3 | 4 | ## Properties 5 | 6 | Name | Type | Description | Notes 7 | ------------ | ------------- | ------------- | ------------- 8 | **status** | **bool** | | [optional] 9 | **errors** | **List[str]** | | [optional] 10 | 11 | ## Example 12 | 13 | ```python 14 | from atoms.models.audience_id_members_get500_response import AudienceIdMembersGet500Response 15 | 16 | # TODO update the JSON string below 17 | json = "{}" 18 | # create an instance of AudienceIdMembersGet500Response from a JSON string 19 | audience_id_members_get500_response_instance = AudienceIdMembersGet500Response.from_json(json) 20 | # print the JSON string representation of the object 21 | print(AudienceIdMembersGet500Response.to_json()) 22 | 23 | # convert the object into a dict 24 | audience_id_members_get500_response_dict = audience_id_members_get500_response_instance.to_dict() 25 | # create an instance of AudienceIdMembersGet500Response from a dict 26 | audience_id_members_get500_response_from_dict = AudienceIdMembersGet500Response.from_dict(audience_id_members_get500_response_dict) 27 | ``` 28 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 29 | 30 | 31 | -------------------------------------------------------------------------------- /docs/atoms/models/AgentTemplateGet200Response.md: -------------------------------------------------------------------------------- 1 | # AgentTemplateGet200Response 2 | 3 | 4 | ## Properties 5 | 6 | Name | Type | Description | Notes 7 | ------------ | ------------- | ------------- | ------------- 8 | **status** | **bool** | | [optional] 9 | **data** | [**List[AgentTemplateGet200ResponseDataInner]**](AgentTemplateGet200ResponseDataInner.md) | | [optional] 10 | 11 | ## Example 12 | 13 | ```python 14 | from atoms.models.agent_template_get200_response import AgentTemplateGet200Response 15 | 16 | # TODO update the JSON string below 17 | json = "{}" 18 | # create an instance of AgentTemplateGet200Response from a JSON string 19 | agent_template_get200_response_instance = AgentTemplateGet200Response.from_json(json) 20 | # print the JSON string representation of the object 21 | print(AgentTemplateGet200Response.to_json()) 22 | 23 | # convert the object into a dict 24 | agent_template_get200_response_dict = agent_template_get200_response_instance.to_dict() 25 | # create an instance of AgentTemplateGet200Response from a dict 26 | agent_template_get200_response_from_dict = AgentTemplateGet200Response.from_dict(agent_template_get200_response_dict) 27 | ``` 28 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 29 | 30 | 31 | -------------------------------------------------------------------------------- /docs/atoms/models/AudienceIdMembersPost400Response.md: -------------------------------------------------------------------------------- 1 | # AudienceIdMembersPost400Response 2 | 3 | 4 | ## Properties 5 | 6 | Name | Type | Description | Notes 7 | ------------ | ------------- | ------------- | ------------- 8 | **status** | **bool** | | [optional] 9 | **errors** | **List[str]** | | [optional] 10 | 11 | ## Example 12 | 13 | ```python 14 | from atoms.models.audience_id_members_post400_response import AudienceIdMembersPost400Response 15 | 16 | # TODO update the JSON string below 17 | json = "{}" 18 | # create an instance of AudienceIdMembersPost400Response from a JSON string 19 | audience_id_members_post400_response_instance = AudienceIdMembersPost400Response.from_json(json) 20 | # print the JSON string representation of the object 21 | print(AudienceIdMembersPost400Response.to_json()) 22 | 23 | # convert the object into a dict 24 | audience_id_members_post400_response_dict = audience_id_members_post400_response_instance.to_dict() 25 | # create an instance of AudienceIdMembersPost400Response from a dict 26 | audience_id_members_post400_response_from_dict = AudienceIdMembersPost400Response.from_dict(audience_id_members_post400_response_dict) 27 | ``` 28 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 29 | 30 | 31 | -------------------------------------------------------------------------------- /docs/atoms/models/AudienceIdMembersPost403Response.md: -------------------------------------------------------------------------------- 1 | # AudienceIdMembersPost403Response 2 | 3 | 4 | ## Properties 5 | 6 | Name | Type | Description | Notes 7 | ------------ | ------------- | ------------- | ------------- 8 | **status** | **bool** | | [optional] 9 | **errors** | **List[str]** | | [optional] 10 | 11 | ## Example 12 | 13 | ```python 14 | from atoms.models.audience_id_members_post403_response import AudienceIdMembersPost403Response 15 | 16 | # TODO update the JSON string below 17 | json = "{}" 18 | # create an instance of AudienceIdMembersPost403Response from a JSON string 19 | audience_id_members_post403_response_instance = AudienceIdMembersPost403Response.from_json(json) 20 | # print the JSON string representation of the object 21 | print(AudienceIdMembersPost403Response.to_json()) 22 | 23 | # convert the object into a dict 24 | audience_id_members_post403_response_dict = audience_id_members_post403_response_instance.to_dict() 25 | # create an instance of AudienceIdMembersPost403Response from a dict 26 | audience_id_members_post403_response_from_dict = AudienceIdMembersPost403Response.from_dict(audience_id_members_post403_response_dict) 27 | ``` 28 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 29 | 30 | 31 | -------------------------------------------------------------------------------- /docs/atoms/models/ConversationIdGet200Response.md: -------------------------------------------------------------------------------- 1 | # ConversationIdGet200Response 2 | 3 | 4 | ## Properties 5 | 6 | Name | Type | Description | Notes 7 | ------------ | ------------- | ------------- | ------------- 8 | **status** | **bool** | | [optional] 9 | **data** | [**ConversationIdGet200ResponseData**](ConversationIdGet200ResponseData.md) | | [optional] 10 | 11 | ## Example 12 | 13 | ```python 14 | from atoms.models.conversation_id_get200_response import ConversationIdGet200Response 15 | 16 | # TODO update the JSON string below 17 | json = "{}" 18 | # create an instance of ConversationIdGet200Response from a JSON string 19 | conversation_id_get200_response_instance = ConversationIdGet200Response.from_json(json) 20 | # print the JSON string representation of the object 21 | print(ConversationIdGet200Response.to_json()) 22 | 23 | # convert the object into a dict 24 | conversation_id_get200_response_dict = conversation_id_get200_response_instance.to_dict() 25 | # create an instance of ConversationIdGet200Response from a dict 26 | conversation_id_get200_response_from_dict = ConversationIdGet200Response.from_dict(conversation_id_get200_response_dict) 27 | ``` 28 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 29 | 30 | 31 | -------------------------------------------------------------------------------- /docs/atoms/models/WebhookPostRequestEventsInner.md: -------------------------------------------------------------------------------- 1 | # WebhookPostRequestEventsInner 2 | 3 | 4 | ## Properties 5 | 6 | Name | Type | Description | Notes 7 | ------------ | ------------- | ------------- | ------------- 8 | **agent_id** | **str** | The ID of the agent | [optional] 9 | **event_type** | **str** | The type of event to subscribe to | [optional] 10 | 11 | ## Example 12 | 13 | ```python 14 | from atoms.models.webhook_post_request_events_inner import WebhookPostRequestEventsInner 15 | 16 | # TODO update the JSON string below 17 | json = "{}" 18 | # create an instance of WebhookPostRequestEventsInner from a JSON string 19 | webhook_post_request_events_inner_instance = WebhookPostRequestEventsInner.from_json(json) 20 | # print the JSON string representation of the object 21 | print(WebhookPostRequestEventsInner.to_json()) 22 | 23 | # convert the object into a dict 24 | webhook_post_request_events_inner_dict = webhook_post_request_events_inner_instance.to_dict() 25 | # create an instance of WebhookPostRequestEventsInner from a dict 26 | webhook_post_request_events_inner_from_dict = WebhookPostRequestEventsInner.from_dict(webhook_post_request_events_inner_dict) 27 | ``` 28 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 29 | 30 | 31 | -------------------------------------------------------------------------------- /docs/atoms/models/AgentFromTemplatePost200Response.md: -------------------------------------------------------------------------------- 1 | # AgentFromTemplatePost200Response 2 | 3 | 4 | ## Properties 5 | 6 | Name | Type | Description | Notes 7 | ------------ | ------------- | ------------- | ------------- 8 | **status** | **bool** | | [optional] 9 | **data** | **str** | The ID of the created agent | [optional] 10 | 11 | ## Example 12 | 13 | ```python 14 | from atoms.models.agent_from_template_post200_response import AgentFromTemplatePost200Response 15 | 16 | # TODO update the JSON string below 17 | json = "{}" 18 | # create an instance of AgentFromTemplatePost200Response from a JSON string 19 | agent_from_template_post200_response_instance = AgentFromTemplatePost200Response.from_json(json) 20 | # print the JSON string representation of the object 21 | print(AgentFromTemplatePost200Response.to_json()) 22 | 23 | # convert the object into a dict 24 | agent_from_template_post200_response_dict = agent_from_template_post200_response_instance.to_dict() 25 | # create an instance of AgentFromTemplatePost200Response from a dict 26 | agent_from_template_post200_response_from_dict = AgentFromTemplatePost200Response.from_dict(agent_from_template_post200_response_dict) 27 | ``` 28 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 29 | 30 | 31 | -------------------------------------------------------------------------------- /docs/atoms/models/AgentIdWorkflowGet200Response.md: -------------------------------------------------------------------------------- 1 | # AgentIdWorkflowGet200Response 2 | 3 | 4 | ## Properties 5 | 6 | Name | Type | Description | Notes 7 | ------------ | ------------- | ------------- | ------------- 8 | **status** | **bool** | | [optional] 9 | **data** | [**AgentIdWorkflowGet200ResponseData**](AgentIdWorkflowGet200ResponseData.md) | | [optional] 10 | 11 | ## Example 12 | 13 | ```python 14 | from atoms.models.agent_id_workflow_get200_response import AgentIdWorkflowGet200Response 15 | 16 | # TODO update the JSON string below 17 | json = "{}" 18 | # create an instance of AgentIdWorkflowGet200Response from a JSON string 19 | agent_id_workflow_get200_response_instance = AgentIdWorkflowGet200Response.from_json(json) 20 | # print the JSON string representation of the object 21 | print(AgentIdWorkflowGet200Response.to_json()) 22 | 23 | # convert the object into a dict 24 | agent_id_workflow_get200_response_dict = agent_id_workflow_get200_response_instance.to_dict() 25 | # create an instance of AgentIdWorkflowGet200Response from a dict 26 | agent_id_workflow_get200_response_from_dict = AgentIdWorkflowGet200Response.from_dict(agent_id_workflow_get200_response_dict) 27 | ``` 28 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 29 | 30 | 31 | -------------------------------------------------------------------------------- /docs/atoms/models/ConversationOutboundPostRequest.md: -------------------------------------------------------------------------------- 1 | # ConversationOutboundPostRequest 2 | 3 | 4 | ## Properties 5 | 6 | Name | Type | Description | Notes 7 | ------------ | ------------- | ------------- | ------------- 8 | **agent_id** | **str** | The ID of the agent initiating the conversation | 9 | **phone_number** | **str** | The phone number to call | 10 | 11 | ## Example 12 | 13 | ```python 14 | from atoms.models.conversation_outbound_post_request import ConversationOutboundPostRequest 15 | 16 | # TODO update the JSON string below 17 | json = "{}" 18 | # create an instance of ConversationOutboundPostRequest from a JSON string 19 | conversation_outbound_post_request_instance = ConversationOutboundPostRequest.from_json(json) 20 | # print the JSON string representation of the object 21 | print(ConversationOutboundPostRequest.to_json()) 22 | 23 | # convert the object into a dict 24 | conversation_outbound_post_request_dict = conversation_outbound_post_request_instance.to_dict() 25 | # create an instance of ConversationOutboundPostRequest from a dict 26 | conversation_outbound_post_request_from_dict = ConversationOutboundPostRequest.from_dict(conversation_outbound_post_request_dict) 27 | ``` 28 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 29 | 30 | 31 | -------------------------------------------------------------------------------- /docs/atoms/models/WebhookEvent.md: -------------------------------------------------------------------------------- 1 | # WebhookEvent 2 | 3 | 4 | ## Properties 5 | 6 | Name | Type | Description | Notes 7 | ------------ | ------------- | ------------- | ------------- 8 | **id** | **str** | The unique identifier for the event | [optional] 9 | **webhook_id** | **str** | The ID of the webhook | [optional] 10 | **event_type** | **str** | The type of event | [optional] 11 | **payload** | **object** | The event payload | [optional] 12 | **status** | **str** | The status of the event | [optional] 13 | **created_at** | **datetime** | The date and time when the event was created | [optional] 14 | 15 | ## Example 16 | 17 | ```python 18 | from atoms.models.webhook_event import WebhookEvent 19 | 20 | # TODO update the JSON string below 21 | json = "{}" 22 | # create an instance of WebhookEvent from a JSON string 23 | webhook_event_instance = WebhookEvent.from_json(json) 24 | # print the JSON string representation of the object 25 | print(WebhookEvent.to_json()) 26 | 27 | # convert the object into a dict 28 | webhook_event_dict = webhook_event_instance.to_dict() 29 | # create an instance of WebhookEvent from a dict 30 | webhook_event_from_dict = WebhookEvent.from_dict(webhook_event_dict) 31 | ``` 32 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 33 | 34 | 35 | -------------------------------------------------------------------------------- /docs/atoms/models/AudienceIdMembersGet200Response.md: -------------------------------------------------------------------------------- 1 | # AudienceIdMembersGet200Response 2 | 3 | 4 | ## Properties 5 | 6 | Name | Type | Description | Notes 7 | ------------ | ------------- | ------------- | ------------- 8 | **status** | **bool** | | [optional] 9 | **data** | [**AudienceIdMembersGet200ResponseData**](AudienceIdMembersGet200ResponseData.md) | | [optional] 10 | 11 | ## Example 12 | 13 | ```python 14 | from atoms.models.audience_id_members_get200_response import AudienceIdMembersGet200Response 15 | 16 | # TODO update the JSON string below 17 | json = "{}" 18 | # create an instance of AudienceIdMembersGet200Response from a JSON string 19 | audience_id_members_get200_response_instance = AudienceIdMembersGet200Response.from_json(json) 20 | # print the JSON string representation of the object 21 | print(AudienceIdMembersGet200Response.to_json()) 22 | 23 | # convert the object into a dict 24 | audience_id_members_get200_response_dict = audience_id_members_get200_response_instance.to_dict() 25 | # create an instance of AudienceIdMembersGet200Response from a dict 26 | audience_id_members_get200_response_from_dict = AudienceIdMembersGet200Response.from_dict(audience_id_members_get200_response_dict) 27 | ``` 28 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 29 | 30 | 31 | -------------------------------------------------------------------------------- /docs/atoms/models/KnowledgebaseIdItemsGet200Response.md: -------------------------------------------------------------------------------- 1 | # KnowledgebaseIdItemsGet200Response 2 | 3 | 4 | ## Properties 5 | 6 | Name | Type | Description | Notes 7 | ------------ | ------------- | ------------- | ------------- 8 | **status** | **bool** | | [optional] 9 | **data** | [**List[KnowledgeBaseItem]**](KnowledgeBaseItem.md) | | [optional] 10 | 11 | ## Example 12 | 13 | ```python 14 | from atoms.models.knowledgebase_id_items_get200_response import KnowledgebaseIdItemsGet200Response 15 | 16 | # TODO update the JSON string below 17 | json = "{}" 18 | # create an instance of KnowledgebaseIdItemsGet200Response from a JSON string 19 | knowledgebase_id_items_get200_response_instance = KnowledgebaseIdItemsGet200Response.from_json(json) 20 | # print the JSON string representation of the object 21 | print(KnowledgebaseIdItemsGet200Response.to_json()) 22 | 23 | # convert the object into a dict 24 | knowledgebase_id_items_get200_response_dict = knowledgebase_id_items_get200_response_instance.to_dict() 25 | # create an instance of KnowledgebaseIdItemsGet200Response from a dict 26 | knowledgebase_id_items_get200_response_from_dict = KnowledgebaseIdItemsGet200Response.from_dict(knowledgebase_id_items_get200_response_dict) 27 | ``` 28 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 29 | 30 | 31 | -------------------------------------------------------------------------------- /docs/atoms/models/AudienceIdMembersSearchGet400Response.md: -------------------------------------------------------------------------------- 1 | # AudienceIdMembersSearchGet400Response 2 | 3 | 4 | ## Properties 5 | 6 | Name | Type | Description | Notes 7 | ------------ | ------------- | ------------- | ------------- 8 | **status** | **bool** | | [optional] 9 | **errors** | **List[str]** | | [optional] 10 | 11 | ## Example 12 | 13 | ```python 14 | from atoms.models.audience_id_members_search_get400_response import AudienceIdMembersSearchGet400Response 15 | 16 | # TODO update the JSON string below 17 | json = "{}" 18 | # create an instance of AudienceIdMembersSearchGet400Response from a JSON string 19 | audience_id_members_search_get400_response_instance = AudienceIdMembersSearchGet400Response.from_json(json) 20 | # print the JSON string representation of the object 21 | print(AudienceIdMembersSearchGet400Response.to_json()) 22 | 23 | # convert the object into a dict 24 | audience_id_members_search_get400_response_dict = audience_id_members_search_get400_response_instance.to_dict() 25 | # create an instance of AudienceIdMembersSearchGet400Response from a dict 26 | audience_id_members_search_get400_response_from_dict = AudienceIdMembersSearchGet400Response.from_dict(audience_id_members_search_get400_response_dict) 27 | ``` 28 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 29 | 30 | 31 | -------------------------------------------------------------------------------- /docs/atoms/models/AudienceIdMembersSearchGet500Response.md: -------------------------------------------------------------------------------- 1 | # AudienceIdMembersSearchGet500Response 2 | 3 | 4 | ## Properties 5 | 6 | Name | Type | Description | Notes 7 | ------------ | ------------- | ------------- | ------------- 8 | **status** | **bool** | | [optional] 9 | **errors** | **List[str]** | | [optional] 10 | 11 | ## Example 12 | 13 | ```python 14 | from atoms.models.audience_id_members_search_get500_response import AudienceIdMembersSearchGet500Response 15 | 16 | # TODO update the JSON string below 17 | json = "{}" 18 | # create an instance of AudienceIdMembersSearchGet500Response from a JSON string 19 | audience_id_members_search_get500_response_instance = AudienceIdMembersSearchGet500Response.from_json(json) 20 | # print the JSON string representation of the object 21 | print(AudienceIdMembersSearchGet500Response.to_json()) 22 | 23 | # convert the object into a dict 24 | audience_id_members_search_get500_response_dict = audience_id_members_search_get500_response_instance.to_dict() 25 | # create an instance of AudienceIdMembersSearchGet500Response from a dict 26 | audience_id_members_search_get500_response_from_dict = AudienceIdMembersSearchGet500Response.from_dict(audience_id_members_search_get500_response_dict) 27 | ``` 28 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 29 | 30 | 31 | -------------------------------------------------------------------------------- /docs/atoms/models/AudienceIdMembersDelete200ResponseData.md: -------------------------------------------------------------------------------- 1 | # AudienceIdMembersDelete200ResponseData 2 | 3 | 4 | ## Properties 5 | 6 | Name | Type | Description | Notes 7 | ------------ | ------------- | ------------- | ------------- 8 | **deleted_count** | **int** | Number of members successfully deleted | [optional] 9 | 10 | ## Example 11 | 12 | ```python 13 | from atoms.models.audience_id_members_delete200_response_data import AudienceIdMembersDelete200ResponseData 14 | 15 | # TODO update the JSON string below 16 | json = "{}" 17 | # create an instance of AudienceIdMembersDelete200ResponseData from a JSON string 18 | audience_id_members_delete200_response_data_instance = AudienceIdMembersDelete200ResponseData.from_json(json) 19 | # print the JSON string representation of the object 20 | print(AudienceIdMembersDelete200ResponseData.to_json()) 21 | 22 | # convert the object into a dict 23 | audience_id_members_delete200_response_data_dict = audience_id_members_delete200_response_data_instance.to_dict() 24 | # create an instance of AudienceIdMembersDelete200ResponseData from a dict 25 | audience_id_members_delete200_response_data_from_dict = AudienceIdMembersDelete200ResponseData.from_dict(audience_id_members_delete200_response_data_dict) 26 | ``` 27 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 28 | 29 | 30 | -------------------------------------------------------------------------------- /docs/atoms/models/AudienceIdMembersPost200Response.md: -------------------------------------------------------------------------------- 1 | # AudienceIdMembersPost200Response 2 | 3 | 4 | ## Properties 5 | 6 | Name | Type | Description | Notes 7 | ------------ | ------------- | ------------- | ------------- 8 | **status** | **bool** | | [optional] 9 | **data** | [**List[AudienceIdMembersPost200ResponseDataInner]**](AudienceIdMembersPost200ResponseDataInner.md) | | [optional] 10 | 11 | ## Example 12 | 13 | ```python 14 | from atoms.models.audience_id_members_post200_response import AudienceIdMembersPost200Response 15 | 16 | # TODO update the JSON string below 17 | json = "{}" 18 | # create an instance of AudienceIdMembersPost200Response from a JSON string 19 | audience_id_members_post200_response_instance = AudienceIdMembersPost200Response.from_json(json) 20 | # print the JSON string representation of the object 21 | print(AudienceIdMembersPost200Response.to_json()) 22 | 23 | # convert the object into a dict 24 | audience_id_members_post200_response_dict = audience_id_members_post200_response_instance.to_dict() 25 | # create an instance of AudienceIdMembersPost200Response from a dict 26 | audience_id_members_post200_response_from_dict = AudienceIdMembersPost200Response.from_dict(audience_id_members_post200_response_dict) 27 | ``` 28 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 29 | 30 | 31 | -------------------------------------------------------------------------------- /docs/atoms/models/ConversationOutboundPost200ResponseData.md: -------------------------------------------------------------------------------- 1 | # ConversationOutboundPost200ResponseData 2 | 3 | 4 | ## Properties 5 | 6 | Name | Type | Description | Notes 7 | ------------ | ------------- | ------------- | ------------- 8 | **conversation_id** | **str** | The ID of the initiated call | [optional] 9 | 10 | ## Example 11 | 12 | ```python 13 | from atoms.models.conversation_outbound_post200_response_data import ConversationOutboundPost200ResponseData 14 | 15 | # TODO update the JSON string below 16 | json = "{}" 17 | # create an instance of ConversationOutboundPost200ResponseData from a JSON string 18 | conversation_outbound_post200_response_data_instance = ConversationOutboundPost200ResponseData.from_json(json) 19 | # print the JSON string representation of the object 20 | print(ConversationOutboundPost200ResponseData.to_json()) 21 | 22 | # convert the object into a dict 23 | conversation_outbound_post200_response_data_dict = conversation_outbound_post200_response_data_instance.to_dict() 24 | # create an instance of ConversationOutboundPost200ResponseData from a dict 25 | conversation_outbound_post200_response_data_from_dict = ConversationOutboundPost200ResponseData.from_dict(conversation_outbound_post200_response_data_dict) 26 | ``` 27 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 28 | 29 | 30 | -------------------------------------------------------------------------------- /docs/atoms/models/OrganizationGet200ResponseDataSubscription.md: -------------------------------------------------------------------------------- 1 | # OrganizationGet200ResponseDataSubscription 2 | 3 | 4 | ## Properties 5 | 6 | Name | Type | Description | Notes 7 | ------------ | ------------- | ------------- | ------------- 8 | **plan_id** | **str** | | [optional] 9 | 10 | ## Example 11 | 12 | ```python 13 | from atoms.models.organization_get200_response_data_subscription import OrganizationGet200ResponseDataSubscription 14 | 15 | # TODO update the JSON string below 16 | json = "{}" 17 | # create an instance of OrganizationGet200ResponseDataSubscription from a JSON string 18 | organization_get200_response_data_subscription_instance = OrganizationGet200ResponseDataSubscription.from_json(json) 19 | # print the JSON string representation of the object 20 | print(OrganizationGet200ResponseDataSubscription.to_json()) 21 | 22 | # convert the object into a dict 23 | organization_get200_response_data_subscription_dict = organization_get200_response_data_subscription_instance.to_dict() 24 | # create an instance of OrganizationGet200ResponseDataSubscription from a dict 25 | organization_get200_response_data_subscription_from_dict = OrganizationGet200ResponseDataSubscription.from_dict(organization_get200_response_data_subscription_dict) 26 | ``` 27 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 28 | 29 | 30 | -------------------------------------------------------------------------------- /docs/atoms/models/AudienceIdMembersDelete200Response.md: -------------------------------------------------------------------------------- 1 | # AudienceIdMembersDelete200Response 2 | 3 | 4 | ## Properties 5 | 6 | Name | Type | Description | Notes 7 | ------------ | ------------- | ------------- | ------------- 8 | **status** | **bool** | | [optional] 9 | **data** | [**AudienceIdMembersDelete200ResponseData**](AudienceIdMembersDelete200ResponseData.md) | | [optional] 10 | 11 | ## Example 12 | 13 | ```python 14 | from atoms.models.audience_id_members_delete200_response import AudienceIdMembersDelete200Response 15 | 16 | # TODO update the JSON string below 17 | json = "{}" 18 | # create an instance of AudienceIdMembersDelete200Response from a JSON string 19 | audience_id_members_delete200_response_instance = AudienceIdMembersDelete200Response.from_json(json) 20 | # print the JSON string representation of the object 21 | print(AudienceIdMembersDelete200Response.to_json()) 22 | 23 | # convert the object into a dict 24 | audience_id_members_delete200_response_dict = audience_id_members_delete200_response_instance.to_dict() 25 | # create an instance of AudienceIdMembersDelete200Response from a dict 26 | audience_id_members_delete200_response_from_dict = AudienceIdMembersDelete200Response.from_dict(audience_id_members_delete200_response_dict) 27 | ``` 28 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 29 | 30 | 31 | -------------------------------------------------------------------------------- /docs/atoms/models/ProductPhoneNumbersGet200Response.md: -------------------------------------------------------------------------------- 1 | # ProductPhoneNumbersGet200Response 2 | 3 | 4 | ## Properties 5 | 6 | Name | Type | Description | Notes 7 | ------------ | ------------- | ------------- | ------------- 8 | **status** | **bool** | | [optional] 9 | **data** | [**List[ProductPhoneNumbersGet200ResponseDataInner]**](ProductPhoneNumbersGet200ResponseDataInner.md) | | [optional] 10 | 11 | ## Example 12 | 13 | ```python 14 | from atoms.models.product_phone_numbers_get200_response import ProductPhoneNumbersGet200Response 15 | 16 | # TODO update the JSON string below 17 | json = "{}" 18 | # create an instance of ProductPhoneNumbersGet200Response from a JSON string 19 | product_phone_numbers_get200_response_instance = ProductPhoneNumbersGet200Response.from_json(json) 20 | # print the JSON string representation of the object 21 | print(ProductPhoneNumbersGet200Response.to_json()) 22 | 23 | # convert the object into a dict 24 | product_phone_numbers_get200_response_dict = product_phone_numbers_get200_response_instance.to_dict() 25 | # create an instance of ProductPhoneNumbersGet200Response from a dict 26 | product_phone_numbers_get200_response_from_dict = ProductPhoneNumbersGet200Response.from_dict(product_phone_numbers_get200_response_dict) 27 | ``` 28 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 29 | 30 | 31 | -------------------------------------------------------------------------------- /docs/atoms/UserApi.md: -------------------------------------------------------------------------------- 1 | # atoms.UserApi 2 | 3 | All URIs are relative to *https://atoms-api.smallest.ai/api/v1* 4 | 5 | Method | HTTP request | Description 6 | ------------- | ------------- | ------------- 7 | [**get_current_user**](UserApi.md#get_current_user) | **GET** /user | Get user details 8 | 9 | # **get_current_user** 10 | 11 | Get details of the currently authenticated user. 12 | 13 | ### Example 14 | 15 | ```python 16 | from smallestai.atoms import AtomsClient 17 | 18 | def main(): 19 | atoms_client = AtomsClient() 20 | 21 | response = atoms_client.get_current_user() 22 | print(f"Current user details: {response.data}") 23 | 24 | if __name__ == "__main__": 25 | main() 26 | ``` 27 | 28 | ### Parameters 29 | 30 | This endpoint does not need any parameter. 31 | 32 | ### Return type 33 | 34 | [**GetCurrentUser200Response**](./models/GetCurrentUser200Response.md) 35 | 36 | ### Authorization 37 | 38 | [BearerAuth](../README.md#BearerAuth) 39 | 40 | ### HTTP request headers 41 | 42 | - **Content-Type**: Not defined 43 | - **Accept**: application/json 44 | 45 | ### HTTP response details 46 | 47 | | Status code | Description | Response headers | 48 | |-------------|-------------|------------------| 49 | **200** | Successful response | - | 50 | **401** | Unauthorized access | - | 51 | **500** | Internal server error | - | 52 | 53 | [[Back to API list]](../../README.md#documentation-for-api-endpoints) 54 | 55 | -------------------------------------------------------------------------------- /docs/atoms/models/ConversationOutboundPost200Response.md: -------------------------------------------------------------------------------- 1 | # ConversationOutboundPost200Response 2 | 3 | 4 | ## Properties 5 | 6 | Name | Type | Description | Notes 7 | ------------ | ------------- | ------------- | ------------- 8 | **status** | **bool** | | [optional] 9 | **data** | [**ConversationOutboundPost200ResponseData**](ConversationOutboundPost200ResponseData.md) | | [optional] 10 | 11 | ## Example 12 | 13 | ```python 14 | from atoms.models.conversation_outbound_post200_response import ConversationOutboundPost200Response 15 | 16 | # TODO update the JSON string below 17 | json = "{}" 18 | # create an instance of ConversationOutboundPost200Response from a JSON string 19 | conversation_outbound_post200_response_instance = ConversationOutboundPost200Response.from_json(json) 20 | # print the JSON string representation of the object 21 | print(ConversationOutboundPost200Response.to_json()) 22 | 23 | # convert the object into a dict 24 | conversation_outbound_post200_response_dict = conversation_outbound_post200_response_instance.to_dict() 25 | # create an instance of ConversationOutboundPost200Response from a dict 26 | conversation_outbound_post200_response_from_dict = ConversationOutboundPost200Response.from_dict(conversation_outbound_post200_response_dict) 27 | ``` 28 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 29 | 30 | 31 | -------------------------------------------------------------------------------- /docs/atoms/models/KnowledgebaseIdItemsUploadTextPostRequest.md: -------------------------------------------------------------------------------- 1 | # KnowledgebaseIdItemsUploadTextPostRequest 2 | 3 | 4 | ## Properties 5 | 6 | Name | Type | Description | Notes 7 | ------------ | ------------- | ------------- | ------------- 8 | **title** | **str** | | 9 | **content** | **str** | | 10 | 11 | ## Example 12 | 13 | ```python 14 | from atoms.models.knowledgebase_id_items_upload_text_post_request import KnowledgebaseIdItemsUploadTextPostRequest 15 | 16 | # TODO update the JSON string below 17 | json = "{}" 18 | # create an instance of KnowledgebaseIdItemsUploadTextPostRequest from a JSON string 19 | knowledgebase_id_items_upload_text_post_request_instance = KnowledgebaseIdItemsUploadTextPostRequest.from_json(json) 20 | # print the JSON string representation of the object 21 | print(KnowledgebaseIdItemsUploadTextPostRequest.to_json()) 22 | 23 | # convert the object into a dict 24 | knowledgebase_id_items_upload_text_post_request_dict = knowledgebase_id_items_upload_text_post_request_instance.to_dict() 25 | # create an instance of KnowledgebaseIdItemsUploadTextPostRequest from a dict 26 | knowledgebase_id_items_upload_text_post_request_from_dict = KnowledgebaseIdItemsUploadTextPostRequest.from_dict(knowledgebase_id_items_upload_text_post_request_dict) 27 | ``` 28 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 29 | 30 | 31 | -------------------------------------------------------------------------------- /docs/atoms/OrganizationApi.md: -------------------------------------------------------------------------------- 1 | # atoms.OrganizationApi 2 | 3 | All URIs are relative to *https://atoms-api.smallest.ai/api/v1* 4 | 5 | Method | HTTP request | Description 6 | ------------- | ------------- | ------------- 7 | [**get_organization**](OrganizationApi.md#get_organization) | **GET** /organization | Get organization details 8 | 9 | # **get_organization** 10 | 11 | Get details of the current organization. 12 | 13 | ### Example 14 | 15 | ```python 16 | from smallestai.atoms import AtomsClient 17 | 18 | def main(): 19 | atoms_client = AtomsClient() 20 | 21 | response = atoms_client.get_organization() 22 | print(f"Organization details: {response.data}") 23 | 24 | if __name__ == "__main__": 25 | main() 26 | ``` 27 | 28 | ### Parameters 29 | 30 | This endpoint does not need any parameter. 31 | 32 | ### Return type 33 | 34 | [**GetCurrentUser200Response**](./models/GetCurrentUser200Response.md) 35 | 36 | ### Authorization 37 | 38 | [BearerAuth](../README.md#BearerAuth) 39 | 40 | ### HTTP request headers 41 | 42 | - **Content-Type**: Not defined 43 | - **Accept**: application/json 44 | 45 | ### HTTP response details 46 | 47 | | Status code | Description | Response headers | 48 | |-------------|-------------|------------------| 49 | **200** | Successful response | - | 50 | **401** | Unauthorized access | - | 51 | **500** | Internal server error | - | 52 | 53 | [[Back to API list]](../../README.md#documentation-for-api-endpoints) 54 | 55 | -------------------------------------------------------------------------------- /docs/atoms/models/OrganizationGet200ResponseDataMembersInner.md: -------------------------------------------------------------------------------- 1 | # OrganizationGet200ResponseDataMembersInner 2 | 3 | 4 | ## Properties 5 | 6 | Name | Type | Description | Notes 7 | ------------ | ------------- | ------------- | ------------- 8 | **id** | **str** | | [optional] 9 | **user_email** | **str** | | [optional] 10 | 11 | ## Example 12 | 13 | ```python 14 | from atoms.models.organization_get200_response_data_members_inner import OrganizationGet200ResponseDataMembersInner 15 | 16 | # TODO update the JSON string below 17 | json = "{}" 18 | # create an instance of OrganizationGet200ResponseDataMembersInner from a JSON string 19 | organization_get200_response_data_members_inner_instance = OrganizationGet200ResponseDataMembersInner.from_json(json) 20 | # print the JSON string representation of the object 21 | print(OrganizationGet200ResponseDataMembersInner.to_json()) 22 | 23 | # convert the object into a dict 24 | organization_get200_response_data_members_inner_dict = organization_get200_response_data_members_inner_instance.to_dict() 25 | # create an instance of OrganizationGet200ResponseDataMembersInner from a dict 26 | organization_get200_response_data_members_inner_from_dict = OrganizationGet200ResponseDataMembersInner.from_dict(organization_get200_response_data_members_inner_dict) 27 | ``` 28 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 29 | 30 | 31 | -------------------------------------------------------------------------------- /docs/atoms/models/AudienceIdMembersSearchGet200Response.md: -------------------------------------------------------------------------------- 1 | # AudienceIdMembersSearchGet200Response 2 | 3 | 4 | ## Properties 5 | 6 | Name | Type | Description | Notes 7 | ------------ | ------------- | ------------- | ------------- 8 | **status** | **bool** | | [optional] 9 | **data** | [**AudienceIdMembersSearchGet200ResponseData**](AudienceIdMembersSearchGet200ResponseData.md) | | [optional] 10 | 11 | ## Example 12 | 13 | ```python 14 | from atoms.models.audience_id_members_search_get200_response import AudienceIdMembersSearchGet200Response 15 | 16 | # TODO update the JSON string below 17 | json = "{}" 18 | # create an instance of AudienceIdMembersSearchGet200Response from a JSON string 19 | audience_id_members_search_get200_response_instance = AudienceIdMembersSearchGet200Response.from_json(json) 20 | # print the JSON string representation of the object 21 | print(AudienceIdMembersSearchGet200Response.to_json()) 22 | 23 | # convert the object into a dict 24 | audience_id_members_search_get200_response_dict = audience_id_members_search_get200_response_instance.to_dict() 25 | # create an instance of AudienceIdMembersSearchGet200Response from a dict 26 | audience_id_members_search_get200_response_from_dict = AudienceIdMembersSearchGet200Response.from_dict(audience_id_members_search_get200_response_dict) 27 | ``` 28 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 29 | 30 | 31 | -------------------------------------------------------------------------------- /docs/atoms/models/CreateAgentFromTemplateRequest.md: -------------------------------------------------------------------------------- 1 | # CreateAgentFromTemplateRequest 2 | 3 | 4 | ## Properties 5 | 6 | Name | Type | Description | Notes 7 | ------------ | ------------- | ------------- | ------------- 8 | **agent_name** | **str** | Name of the agent | 9 | **agent_description** | **str** | Description of the agent | [optional] 10 | **template_id** | **str** | ID of the template to use. You can get the list of templates with their description and id from the /agent/template endpoint. | 11 | 12 | ## Example 13 | 14 | ```python 15 | from atoms.models.create_agent_from_template_request import CreateAgentFromTemplateRequest 16 | 17 | # TODO update the JSON string below 18 | json = "{}" 19 | # create an instance of CreateAgentFromTemplateRequest from a JSON string 20 | create_agent_from_template_request_instance = CreateAgentFromTemplateRequest.from_json(json) 21 | # print the JSON string representation of the object 22 | print(CreateAgentFromTemplateRequest.to_json()) 23 | 24 | # convert the object into a dict 25 | create_agent_from_template_request_dict = create_agent_from_template_request_instance.to_dict() 26 | # create an instance of CreateAgentFromTemplateRequest from a dict 27 | create_agent_from_template_request_from_dict = CreateAgentFromTemplateRequest.from_dict(create_agent_from_template_request_dict) 28 | ``` 29 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 30 | 31 | 32 | -------------------------------------------------------------------------------- /pyproject.toml: -------------------------------------------------------------------------------- 1 | [project] 2 | name = "smallestai" 3 | version = "4.1.0" 4 | description = "Official Python client for the Smallest AI API" 5 | authors = [ 6 | {name = "Smallest", email = "support@smallest.ai"}, 7 | ] 8 | readme = "README.md" 9 | license = {text = "MIT"} 10 | requires-python = ">=3.9" 11 | classifiers = [ 12 | "Intended Audience :: Developers", 13 | "License :: OSI Approved :: MIT License", 14 | "Programming Language :: Python :: 3", 15 | ] 16 | keywords = ["smallest", "smallest.ai", "tts", "text-to-speech", "waves", "atoms"] 17 | dependencies = [ 18 | "aiohttp", 19 | "aiofiles", 20 | "requests", 21 | "pydub", 22 | "websocket-client", 23 | "urllib3 >= 1.25.3, < 3.0.0", 24 | "python-dateutil >= 2.8.2", 25 | "pydantic >= 2", 26 | "typing-extensions >= 4.7.1", 27 | "audioop-lts; python_version >= '3.13'" 28 | ] 29 | 30 | [project.optional-dependencies] 31 | test = [ 32 | "jiwer", 33 | "httpx", 34 | "pytest >= 7.2.1", 35 | "pytest-asyncio", 36 | "deepgram-sdk", 37 | "python-dotenv", 38 | "pytest-cov >= 2.8.1", 39 | "tox >= 3.9.0", 40 | "flake8 >= 4.0.0", 41 | "types-python-dateutil >= 2.8.19.14", 42 | "mypy >= 1.5" 43 | ] 44 | 45 | [project.urls] 46 | Homepage = "https://github.com/smallest-inc/smallest-python-sdk" 47 | 48 | [build-system] 49 | requires = ["setuptools>=61.0"] 50 | build-backend = "setuptools.build_meta" 51 | 52 | [tool.setuptools.packages.find] 53 | where = ["."] 54 | include = ["smallest*"] 55 | -------------------------------------------------------------------------------- /docs/atoms/models/KnowledgeBase.md: -------------------------------------------------------------------------------- 1 | # KnowledgeBase 2 | 3 | 4 | ## Properties 5 | 6 | Name | Type | Description | Notes 7 | ------------ | ------------- | ------------- | ------------- 8 | **id** | **str** | The unique identifier for the knowledge base | 9 | **name** | **str** | The name of the knowledge base | 10 | **description** | **str** | The description of the knowledge base | [optional] 11 | **organization** | **str** | The organization ID | 12 | **created_by** | **str** | The user ID who created the knowledge base | 13 | **created_at** | **datetime** | The date and time when the knowledge base was created | [optional] 14 | **updated_at** | **datetime** | The date and time when the knowledge base was last updated | [optional] 15 | 16 | ## Example 17 | 18 | ```python 19 | from atoms.models.knowledge_base import KnowledgeBase 20 | 21 | # TODO update the JSON string below 22 | json = "{}" 23 | # create an instance of KnowledgeBase from a JSON string 24 | knowledge_base_instance = KnowledgeBase.from_json(json) 25 | # print the JSON string representation of the object 26 | print(KnowledgeBase.to_json()) 27 | 28 | # convert the object into a dict 29 | knowledge_base_dict = knowledge_base_instance.to_dict() 30 | # create an instance of KnowledgeBase from a dict 31 | knowledge_base_from_dict = KnowledgeBase.from_dict(knowledge_base_dict) 32 | ``` 33 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 34 | 35 | 36 | -------------------------------------------------------------------------------- /docs/atoms/models/AgentDTOSynthesizerVoiceConfig.md: -------------------------------------------------------------------------------- 1 | # AgentDTOSynthesizerVoiceConfig 2 | 3 | The voice configuration of the synthesizer 4 | 5 | ## Properties 6 | 7 | Name | Type | Description | Notes 8 | ------------ | ------------- | ------------- | ------------- 9 | **model** | **str** | The model of the synthesizer | [optional] [default to 'waves_lightning_large'] 10 | **voice_id** | **str** | The voice ID of the synthesizer. | [optional] [default to 'nyah'] 11 | **gender** | **str** | | [optional] [default to 'female'] 12 | 13 | ## Example 14 | 15 | ```python 16 | from atoms.models.agent_dto_synthesizer_voice_config import AgentDTOSynthesizerVoiceConfig 17 | 18 | # TODO update the JSON string below 19 | json = "{}" 20 | # create an instance of AgentDTOSynthesizerVoiceConfig from a JSON string 21 | agent_dto_synthesizer_voice_config_instance = AgentDTOSynthesizerVoiceConfig.from_json(json) 22 | # print the JSON string representation of the object 23 | print(AgentDTOSynthesizerVoiceConfig.to_json()) 24 | 25 | # convert the object into a dict 26 | agent_dto_synthesizer_voice_config_dict = agent_dto_synthesizer_voice_config_instance.to_dict() 27 | # create an instance of AgentDTOSynthesizerVoiceConfig from a dict 28 | agent_dto_synthesizer_voice_config_from_dict = AgentDTOSynthesizerVoiceConfig.from_dict(agent_dto_synthesizer_voice_config_dict) 29 | ``` 30 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 31 | 32 | 33 | -------------------------------------------------------------------------------- /docs/atoms/models/AgentAgentIdWebhookSubscriptionsGet404Response.md: -------------------------------------------------------------------------------- 1 | # AgentAgentIdWebhookSubscriptionsGet404Response 2 | 3 | 4 | ## Properties 5 | 6 | Name | Type | Description | Notes 7 | ------------ | ------------- | ------------- | ------------- 8 | **status** | **bool** | | [optional] 9 | **errors** | **List[str]** | | [optional] 10 | 11 | ## Example 12 | 13 | ```python 14 | from atoms.models.agent_agent_id_webhook_subscriptions_get404_response import AgentAgentIdWebhookSubscriptionsGet404Response 15 | 16 | # TODO update the JSON string below 17 | json = "{}" 18 | # create an instance of AgentAgentIdWebhookSubscriptionsGet404Response from a JSON string 19 | agent_agent_id_webhook_subscriptions_get404_response_instance = AgentAgentIdWebhookSubscriptionsGet404Response.from_json(json) 20 | # print the JSON string representation of the object 21 | print(AgentAgentIdWebhookSubscriptionsGet404Response.to_json()) 22 | 23 | # convert the object into a dict 24 | agent_agent_id_webhook_subscriptions_get404_response_dict = agent_agent_id_webhook_subscriptions_get404_response_instance.to_dict() 25 | # create an instance of AgentAgentIdWebhookSubscriptionsGet404Response from a dict 26 | agent_agent_id_webhook_subscriptions_get404_response_from_dict = AgentAgentIdWebhookSubscriptionsGet404Response.from_dict(agent_agent_id_webhook_subscriptions_get404_response_dict) 27 | ``` 28 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 29 | 30 | 31 | -------------------------------------------------------------------------------- /docs/atoms/models/WebhookSubscription.md: -------------------------------------------------------------------------------- 1 | # WebhookSubscription 2 | 3 | 4 | ## Properties 5 | 6 | Name | Type | Description | Notes 7 | ------------ | ------------- | ------------- | ------------- 8 | **id** | **str** | The unique identifier for the subscription | [optional] 9 | **webhook_id** | **str** | The ID of the webhook | [optional] 10 | **agent_id** | **str** | The ID of the agent | [optional] 11 | **event_type** | **str** | The type of event subscribed to | [optional] 12 | **created_at** | **datetime** | The date and time when the subscription was created | [optional] 13 | **updated_at** | **datetime** | The date and time when the subscription was last updated | [optional] 14 | 15 | ## Example 16 | 17 | ```python 18 | from atoms.models.webhook_subscription import WebhookSubscription 19 | 20 | # TODO update the JSON string below 21 | json = "{}" 22 | # create an instance of WebhookSubscription from a JSON string 23 | webhook_subscription_instance = WebhookSubscription.from_json(json) 24 | # print the JSON string representation of the object 25 | print(WebhookSubscription.to_json()) 26 | 27 | # convert the object into a dict 28 | webhook_subscription_dict = webhook_subscription_instance.to_dict() 29 | # create an instance of WebhookSubscription from a dict 30 | webhook_subscription_from_dict = WebhookSubscription.from_dict(webhook_subscription_dict) 31 | ``` 32 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 33 | 34 | 35 | -------------------------------------------------------------------------------- /docs/atoms/models/AgentAgentIdWebhookSubscriptionsPost400Response.md: -------------------------------------------------------------------------------- 1 | # AgentAgentIdWebhookSubscriptionsPost400Response 2 | 3 | 4 | ## Properties 5 | 6 | Name | Type | Description | Notes 7 | ------------ | ------------- | ------------- | ------------- 8 | **status** | **bool** | | [optional] 9 | **errors** | **List[str]** | | [optional] 10 | 11 | ## Example 12 | 13 | ```python 14 | from atoms.models.agent_agent_id_webhook_subscriptions_post400_response import AgentAgentIdWebhookSubscriptionsPost400Response 15 | 16 | # TODO update the JSON string below 17 | json = "{}" 18 | # create an instance of AgentAgentIdWebhookSubscriptionsPost400Response from a JSON string 19 | agent_agent_id_webhook_subscriptions_post400_response_instance = AgentAgentIdWebhookSubscriptionsPost400Response.from_json(json) 20 | # print the JSON string representation of the object 21 | print(AgentAgentIdWebhookSubscriptionsPost400Response.to_json()) 22 | 23 | # convert the object into a dict 24 | agent_agent_id_webhook_subscriptions_post400_response_dict = agent_agent_id_webhook_subscriptions_post400_response_instance.to_dict() 25 | # create an instance of AgentAgentIdWebhookSubscriptionsPost400Response from a dict 26 | agent_agent_id_webhook_subscriptions_post400_response_from_dict = AgentAgentIdWebhookSubscriptionsPost400Response.from_dict(agent_agent_id_webhook_subscriptions_post400_response_dict) 27 | ``` 28 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 29 | 30 | 31 | -------------------------------------------------------------------------------- /docs/atoms/models/AgentAgentIdWebhookSubscriptionsPostRequest.md: -------------------------------------------------------------------------------- 1 | # AgentAgentIdWebhookSubscriptionsPostRequest 2 | 3 | 4 | ## Properties 5 | 6 | Name | Type | Description | Notes 7 | ------------ | ------------- | ------------- | ------------- 8 | **event_types** | **List[str]** | Array of event types to subscribe to | 9 | **webhook_id** | **str** | The ID of the webhook to subscribe to | 10 | 11 | ## Example 12 | 13 | ```python 14 | from atoms.models.agent_agent_id_webhook_subscriptions_post_request import AgentAgentIdWebhookSubscriptionsPostRequest 15 | 16 | # TODO update the JSON string below 17 | json = "{}" 18 | # create an instance of AgentAgentIdWebhookSubscriptionsPostRequest from a JSON string 19 | agent_agent_id_webhook_subscriptions_post_request_instance = AgentAgentIdWebhookSubscriptionsPostRequest.from_json(json) 20 | # print the JSON string representation of the object 21 | print(AgentAgentIdWebhookSubscriptionsPostRequest.to_json()) 22 | 23 | # convert the object into a dict 24 | agent_agent_id_webhook_subscriptions_post_request_dict = agent_agent_id_webhook_subscriptions_post_request_instance.to_dict() 25 | # create an instance of AgentAgentIdWebhookSubscriptionsPostRequest from a dict 26 | agent_agent_id_webhook_subscriptions_post_request_from_dict = AgentAgentIdWebhookSubscriptionsPostRequest.from_dict(agent_agent_id_webhook_subscriptions_post_request_dict) 27 | ``` 28 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 29 | 30 | 31 | -------------------------------------------------------------------------------- /docs/atoms/models/AudienceIdMembersPost200ResponseDataInner.md: -------------------------------------------------------------------------------- 1 | # AudienceIdMembersPost200ResponseDataInner 2 | 3 | 4 | ## Properties 5 | 6 | Name | Type | Description | Notes 7 | ------------ | ------------- | ------------- | ------------- 8 | **message** | **str** | | [optional] 9 | **data** | [**AudienceIdMembersPost200ResponseDataInnerData**](AudienceIdMembersPost200ResponseDataInnerData.md) | | [optional] 10 | 11 | ## Example 12 | 13 | ```python 14 | from atoms.models.audience_id_members_post200_response_data_inner import AudienceIdMembersPost200ResponseDataInner 15 | 16 | # TODO update the JSON string below 17 | json = "{}" 18 | # create an instance of AudienceIdMembersPost200ResponseDataInner from a JSON string 19 | audience_id_members_post200_response_data_inner_instance = AudienceIdMembersPost200ResponseDataInner.from_json(json) 20 | # print the JSON string representation of the object 21 | print(AudienceIdMembersPost200ResponseDataInner.to_json()) 22 | 23 | # convert the object into a dict 24 | audience_id_members_post200_response_data_inner_dict = audience_id_members_post200_response_data_inner_instance.to_dict() 25 | # create an instance of AudienceIdMembersPost200ResponseDataInner from a dict 26 | audience_id_members_post200_response_data_inner_from_dict = AudienceIdMembersPost200ResponseDataInner.from_dict(audience_id_members_post200_response_data_inner_dict) 27 | ``` 28 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 29 | 30 | 31 | -------------------------------------------------------------------------------- /docs/atoms/models/AgentAgentIdWebhookSubscriptionsPost201Response.md: -------------------------------------------------------------------------------- 1 | # AgentAgentIdWebhookSubscriptionsPost201Response 2 | 3 | 4 | ## Properties 5 | 6 | Name | Type | Description | Notes 7 | ------------ | ------------- | ------------- | ------------- 8 | **status** | **bool** | | [optional] 9 | **data** | **str** | Success message | [optional] 10 | 11 | ## Example 12 | 13 | ```python 14 | from atoms.models.agent_agent_id_webhook_subscriptions_post201_response import AgentAgentIdWebhookSubscriptionsPost201Response 15 | 16 | # TODO update the JSON string below 17 | json = "{}" 18 | # create an instance of AgentAgentIdWebhookSubscriptionsPost201Response from a JSON string 19 | agent_agent_id_webhook_subscriptions_post201_response_instance = AgentAgentIdWebhookSubscriptionsPost201Response.from_json(json) 20 | # print the JSON string representation of the object 21 | print(AgentAgentIdWebhookSubscriptionsPost201Response.to_json()) 22 | 23 | # convert the object into a dict 24 | agent_agent_id_webhook_subscriptions_post201_response_dict = agent_agent_id_webhook_subscriptions_post201_response_instance.to_dict() 25 | # create an instance of AgentAgentIdWebhookSubscriptionsPost201Response from a dict 26 | agent_agent_id_webhook_subscriptions_post201_response_from_dict = AgentAgentIdWebhookSubscriptionsPost201Response.from_dict(agent_agent_id_webhook_subscriptions_post201_response_dict) 27 | ``` 28 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 29 | 30 | 31 | -------------------------------------------------------------------------------- /docs/atoms/models/OrganizationGet200ResponseData.md: -------------------------------------------------------------------------------- 1 | # OrganizationGet200ResponseData 2 | 3 | 4 | ## Properties 5 | 6 | Name | Type | Description | Notes 7 | ------------ | ------------- | ------------- | ------------- 8 | **id** | **str** | | [optional] 9 | **name** | **str** | | [optional] 10 | **members** | [**List[OrganizationGet200ResponseDataMembersInner]**](OrganizationGet200ResponseDataMembersInner.md) | | [optional] 11 | **subscription** | [**OrganizationGet200ResponseDataSubscription**](OrganizationGet200ResponseDataSubscription.md) | | [optional] 12 | 13 | ## Example 14 | 15 | ```python 16 | from atoms.models.organization_get200_response_data import OrganizationGet200ResponseData 17 | 18 | # TODO update the JSON string below 19 | json = "{}" 20 | # create an instance of OrganizationGet200ResponseData from a JSON string 21 | organization_get200_response_data_instance = OrganizationGet200ResponseData.from_json(json) 22 | # print the JSON string representation of the object 23 | print(OrganizationGet200ResponseData.to_json()) 24 | 25 | # convert the object into a dict 26 | organization_get200_response_data_dict = organization_get200_response_data_instance.to_dict() 27 | # create an instance of OrganizationGet200ResponseData from a dict 28 | organization_get200_response_data_from_dict = OrganizationGet200ResponseData.from_dict(organization_get200_response_data_dict) 29 | ``` 30 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 31 | 32 | 33 | -------------------------------------------------------------------------------- /docs/atoms/models/AgentAgentIdWebhookSubscriptionsGet200Response.md: -------------------------------------------------------------------------------- 1 | # AgentAgentIdWebhookSubscriptionsGet200Response 2 | 3 | 4 | ## Properties 5 | 6 | Name | Type | Description | Notes 7 | ------------ | ------------- | ------------- | ------------- 8 | **status** | **bool** | | [optional] 9 | **data** | [**List[WebhookSubscription]**](WebhookSubscription.md) | | [optional] 10 | 11 | ## Example 12 | 13 | ```python 14 | from atoms.models.agent_agent_id_webhook_subscriptions_get200_response import AgentAgentIdWebhookSubscriptionsGet200Response 15 | 16 | # TODO update the JSON string below 17 | json = "{}" 18 | # create an instance of AgentAgentIdWebhookSubscriptionsGet200Response from a JSON string 19 | agent_agent_id_webhook_subscriptions_get200_response_instance = AgentAgentIdWebhookSubscriptionsGet200Response.from_json(json) 20 | # print the JSON string representation of the object 21 | print(AgentAgentIdWebhookSubscriptionsGet200Response.to_json()) 22 | 23 | # convert the object into a dict 24 | agent_agent_id_webhook_subscriptions_get200_response_dict = agent_agent_id_webhook_subscriptions_get200_response_instance.to_dict() 25 | # create an instance of AgentAgentIdWebhookSubscriptionsGet200Response from a dict 26 | agent_agent_id_webhook_subscriptions_get200_response_from_dict = AgentAgentIdWebhookSubscriptionsGet200Response.from_dict(agent_agent_id_webhook_subscriptions_get200_response_dict) 27 | ``` 28 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 29 | 30 | 31 | -------------------------------------------------------------------------------- /docs/atoms/models/AgentAgentIdWebhookSubscriptionsDelete200Response.md: -------------------------------------------------------------------------------- 1 | # AgentAgentIdWebhookSubscriptionsDelete200Response 2 | 3 | 4 | ## Properties 5 | 6 | Name | Type | Description | Notes 7 | ------------ | ------------- | ------------- | ------------- 8 | **status** | **bool** | | [optional] 9 | **data** | **str** | Success message | [optional] 10 | 11 | ## Example 12 | 13 | ```python 14 | from atoms.models.agent_agent_id_webhook_subscriptions_delete200_response import AgentAgentIdWebhookSubscriptionsDelete200Response 15 | 16 | # TODO update the JSON string below 17 | json = "{}" 18 | # create an instance of AgentAgentIdWebhookSubscriptionsDelete200Response from a JSON string 19 | agent_agent_id_webhook_subscriptions_delete200_response_instance = AgentAgentIdWebhookSubscriptionsDelete200Response.from_json(json) 20 | # print the JSON string representation of the object 21 | print(AgentAgentIdWebhookSubscriptionsDelete200Response.to_json()) 22 | 23 | # convert the object into a dict 24 | agent_agent_id_webhook_subscriptions_delete200_response_dict = agent_agent_id_webhook_subscriptions_delete200_response_instance.to_dict() 25 | # create an instance of AgentAgentIdWebhookSubscriptionsDelete200Response from a dict 26 | agent_agent_id_webhook_subscriptions_delete200_response_from_dict = AgentAgentIdWebhookSubscriptionsDelete200Response.from_dict(agent_agent_id_webhook_subscriptions_delete200_response_dict) 27 | ``` 28 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 29 | 30 | 31 | -------------------------------------------------------------------------------- /docs/atoms/models/AgentIdPatchRequestLanguage.md: -------------------------------------------------------------------------------- 1 | # AgentIdPatchRequestLanguage 2 | 3 | Language configuration for the agent. You can enable or disable language switching for the agent. This will be used to determine the language of the agent. 4 | 5 | ## Properties 6 | 7 | Name | Type | Description | Notes 8 | ------------ | ------------- | ------------- | ------------- 9 | **enabled** | **str** | The language of the agent. You can choose from the list of supported languages. | [optional] [default to 'en'] 10 | **switching** | [**AgentIdPatchRequestLanguageSwitching**](AgentIdPatchRequestLanguageSwitching.md) | | [optional] 11 | 12 | ## Example 13 | 14 | ```python 15 | from atoms.models.agent_id_patch_request_language import AgentIdPatchRequestLanguage 16 | 17 | # TODO update the JSON string below 18 | json = "{}" 19 | # create an instance of AgentIdPatchRequestLanguage from a JSON string 20 | agent_id_patch_request_language_instance = AgentIdPatchRequestLanguage.from_json(json) 21 | # print the JSON string representation of the object 22 | print(AgentIdPatchRequestLanguage.to_json()) 23 | 24 | # convert the object into a dict 25 | agent_id_patch_request_language_dict = agent_id_patch_request_language_instance.to_dict() 26 | # create an instance of AgentIdPatchRequestLanguage from a dict 27 | agent_id_patch_request_language_from_dict = AgentIdPatchRequestLanguage.from_dict(agent_id_patch_request_language_dict) 28 | ``` 29 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 30 | 31 | 32 | -------------------------------------------------------------------------------- /docs/atoms/models/AgentDTOSynthesizer.md: -------------------------------------------------------------------------------- 1 | # AgentDTOSynthesizer 2 | 3 | The synthesizer (TTS) configuration of the agent 4 | 5 | ## Properties 6 | 7 | Name | Type | Description | Notes 8 | ------------ | ------------- | ------------- | ------------- 9 | **voice_config** | [**AgentDTOSynthesizerVoiceConfig**](AgentDTOSynthesizerVoiceConfig.md) | | [optional] 10 | **speed** | **float** | The speed of the synthesizer | [optional] [default to 1.2] 11 | **consistency** | **float** | The consistency of the synthesizer | [optional] [default to 0.5] 12 | **similarity** | **float** | The similarity of the synthesizer | [optional] [default to 0] 13 | **enhancement** | **float** | The enhancement of the synthesizer | [optional] [default to 1] 14 | 15 | ## Example 16 | 17 | ```python 18 | from atoms.models.agent_dto_synthesizer import AgentDTOSynthesizer 19 | 20 | # TODO update the JSON string below 21 | json = "{}" 22 | # create an instance of AgentDTOSynthesizer from a JSON string 23 | agent_dto_synthesizer_instance = AgentDTOSynthesizer.from_json(json) 24 | # print the JSON string representation of the object 25 | print(AgentDTOSynthesizer.to_json()) 26 | 27 | # convert the object into a dict 28 | agent_dto_synthesizer_dict = agent_dto_synthesizer_instance.to_dict() 29 | # create an instance of AgentDTOSynthesizer from a dict 30 | agent_dto_synthesizer_from_dict = AgentDTOSynthesizer.from_dict(agent_dto_synthesizer_dict) 31 | ``` 32 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 33 | 34 | 35 | -------------------------------------------------------------------------------- /docs/atoms/models/UserGet200ResponseData.md: -------------------------------------------------------------------------------- 1 | # UserGet200ResponseData 2 | 3 | 4 | ## Properties 5 | 6 | Name | Type | Description | Notes 7 | ------------ | ------------- | ------------- | ------------- 8 | **id** | **str** | The ID of the user | [optional] 9 | **first_name** | **str** | The first name of the user | [optional] 10 | **last_name** | **str** | The last name of the user | [optional] 11 | **user_email** | **str** | The email of the user | [optional] 12 | **auth_provider** | **str** | The authentication provider of the user | [optional] 13 | **is_email_verified** | **bool** | Whether the user's email is verified | [optional] 14 | **organization_id** | **str** | | [optional] 15 | 16 | ## Example 17 | 18 | ```python 19 | from atoms.models.user_get200_response_data import UserGet200ResponseData 20 | 21 | # TODO update the JSON string below 22 | json = "{}" 23 | # create an instance of UserGet200ResponseData from a JSON string 24 | user_get200_response_data_instance = UserGet200ResponseData.from_json(json) 25 | # print the JSON string representation of the object 26 | print(UserGet200ResponseData.to_json()) 27 | 28 | # convert the object into a dict 29 | user_get200_response_data_dict = user_get200_response_data_instance.to_dict() 30 | # create an instance of UserGet200ResponseData from a dict 31 | user_get200_response_data_from_dict = UserGet200ResponseData.from_dict(user_get200_response_data_dict) 32 | ``` 33 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 34 | 35 | 36 | -------------------------------------------------------------------------------- /docs/atoms/models/AudienceIdMembersPost200ResponseDataInnerData.md: -------------------------------------------------------------------------------- 1 | # AudienceIdMembersPost200ResponseDataInnerData 2 | 3 | 4 | ## Properties 5 | 6 | Name | Type | Description | Notes 7 | ------------ | ------------- | ------------- | ------------- 8 | **added** | **int** | Number of members successfully added | [optional] 9 | **skipped** | **int** | Number of members skipped (e.g., duplicates) | [optional] 10 | 11 | ## Example 12 | 13 | ```python 14 | from atoms.models.audience_id_members_post200_response_data_inner_data import AudienceIdMembersPost200ResponseDataInnerData 15 | 16 | # TODO update the JSON string below 17 | json = "{}" 18 | # create an instance of AudienceIdMembersPost200ResponseDataInnerData from a JSON string 19 | audience_id_members_post200_response_data_inner_data_instance = AudienceIdMembersPost200ResponseDataInnerData.from_json(json) 20 | # print the JSON string representation of the object 21 | print(AudienceIdMembersPost200ResponseDataInnerData.to_json()) 22 | 23 | # convert the object into a dict 24 | audience_id_members_post200_response_data_inner_data_dict = audience_id_members_post200_response_data_inner_data_instance.to_dict() 25 | # create an instance of AudienceIdMembersPost200ResponseDataInnerData from a dict 26 | audience_id_members_post200_response_data_inner_data_from_dict = AudienceIdMembersPost200ResponseDataInnerData.from_dict(audience_id_members_post200_response_data_inner_data_dict) 27 | ``` 28 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 29 | 30 | 31 | -------------------------------------------------------------------------------- /docs/atoms/models/AgentIdWorkflowGet200ResponseDataNodesInnerPosition.md: -------------------------------------------------------------------------------- 1 | # AgentIdWorkflowGet200ResponseDataNodesInnerPosition 2 | 3 | 4 | ## Properties 5 | 6 | Name | Type | Description | Notes 7 | ------------ | ------------- | ------------- | ------------- 8 | **x** | **float** | | [optional] 9 | **y** | **float** | | [optional] 10 | 11 | ## Example 12 | 13 | ```python 14 | from atoms.models.agent_id_workflow_get200_response_data_nodes_inner_position import AgentIdWorkflowGet200ResponseDataNodesInnerPosition 15 | 16 | # TODO update the JSON string below 17 | json = "{}" 18 | # create an instance of AgentIdWorkflowGet200ResponseDataNodesInnerPosition from a JSON string 19 | agent_id_workflow_get200_response_data_nodes_inner_position_instance = AgentIdWorkflowGet200ResponseDataNodesInnerPosition.from_json(json) 20 | # print the JSON string representation of the object 21 | print(AgentIdWorkflowGet200ResponseDataNodesInnerPosition.to_json()) 22 | 23 | # convert the object into a dict 24 | agent_id_workflow_get200_response_data_nodes_inner_position_dict = agent_id_workflow_get200_response_data_nodes_inner_position_instance.to_dict() 25 | # create an instance of AgentIdWorkflowGet200ResponseDataNodesInnerPosition from a dict 26 | agent_id_workflow_get200_response_data_nodes_inner_position_from_dict = AgentIdWorkflowGet200ResponseDataNodesInnerPosition.from_dict(agent_id_workflow_get200_response_data_nodes_inner_position_dict) 27 | ``` 28 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 29 | 30 | 31 | -------------------------------------------------------------------------------- /docs/atoms/models/AgentIdWorkflowGet200ResponseDataEdgesInnerData.md: -------------------------------------------------------------------------------- 1 | # AgentIdWorkflowGet200ResponseDataEdgesInnerData 2 | 3 | Edge-specific data 4 | 5 | ## Properties 6 | 7 | Name | Type | Description | Notes 8 | ------------ | ------------- | ------------- | ------------- 9 | **label** | **str** | | [optional] 10 | **description** | **str** | | [optional] 11 | **is_conditional_edge** | **bool** | | [optional] 12 | 13 | ## Example 14 | 15 | ```python 16 | from atoms.models.agent_id_workflow_get200_response_data_edges_inner_data import AgentIdWorkflowGet200ResponseDataEdgesInnerData 17 | 18 | # TODO update the JSON string below 19 | json = "{}" 20 | # create an instance of AgentIdWorkflowGet200ResponseDataEdgesInnerData from a JSON string 21 | agent_id_workflow_get200_response_data_edges_inner_data_instance = AgentIdWorkflowGet200ResponseDataEdgesInnerData.from_json(json) 22 | # print the JSON string representation of the object 23 | print(AgentIdWorkflowGet200ResponseDataEdgesInnerData.to_json()) 24 | 25 | # convert the object into a dict 26 | agent_id_workflow_get200_response_data_edges_inner_data_dict = agent_id_workflow_get200_response_data_edges_inner_data_instance.to_dict() 27 | # create an instance of AgentIdWorkflowGet200ResponseDataEdgesInnerData from a dict 28 | agent_id_workflow_get200_response_data_edges_inner_data_from_dict = AgentIdWorkflowGet200ResponseDataEdgesInnerData.from_dict(agent_id_workflow_get200_response_data_edges_inner_data_dict) 29 | ``` 30 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 31 | 32 | 33 | -------------------------------------------------------------------------------- /docs/atoms/models/AgentIdWorkflowGet200ResponseData.md: -------------------------------------------------------------------------------- 1 | # AgentIdWorkflowGet200ResponseData 2 | 3 | The workflow graph containing nodes and edges 4 | 5 | ## Properties 6 | 7 | Name | Type | Description | Notes 8 | ------------ | ------------- | ------------- | ------------- 9 | **nodes** | [**List[AgentIdWorkflowGet200ResponseDataNodesInner]**](AgentIdWorkflowGet200ResponseDataNodesInner.md) | Array of workflow nodes | [optional] 10 | **edges** | [**List[AgentIdWorkflowGet200ResponseDataEdgesInner]**](AgentIdWorkflowGet200ResponseDataEdgesInner.md) | Array of workflow edges connecting nodes | [optional] 11 | 12 | ## Example 13 | 14 | ```python 15 | from atoms.models.agent_id_workflow_get200_response_data import AgentIdWorkflowGet200ResponseData 16 | 17 | # TODO update the JSON string below 18 | json = "{}" 19 | # create an instance of AgentIdWorkflowGet200ResponseData from a JSON string 20 | agent_id_workflow_get200_response_data_instance = AgentIdWorkflowGet200ResponseData.from_json(json) 21 | # print the JSON string representation of the object 22 | print(AgentIdWorkflowGet200ResponseData.to_json()) 23 | 24 | # convert the object into a dict 25 | agent_id_workflow_get200_response_data_dict = agent_id_workflow_get200_response_data_instance.to_dict() 26 | # create an instance of AgentIdWorkflowGet200ResponseData from a dict 27 | agent_id_workflow_get200_response_data_from_dict = AgentIdWorkflowGet200ResponseData.from_dict(agent_id_workflow_get200_response_data_dict) 28 | ``` 29 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 30 | 31 | 32 | -------------------------------------------------------------------------------- /docs/atoms/models/AudienceIdMembersGet200ResponseDataMembersInner.md: -------------------------------------------------------------------------------- 1 | # AudienceIdMembersGet200ResponseDataMembersInner 2 | 3 | 4 | ## Properties 5 | 6 | Name | Type | Description | Notes 7 | ------------ | ------------- | ------------- | ------------- 8 | **id** | **str** | The unique identifier for the audience member | [optional] 9 | **data** | **object** | Dynamic data from CSV, structure depends on uploaded file | [optional] 10 | 11 | ## Example 12 | 13 | ```python 14 | from atoms.models.audience_id_members_get200_response_data_members_inner import AudienceIdMembersGet200ResponseDataMembersInner 15 | 16 | # TODO update the JSON string below 17 | json = "{}" 18 | # create an instance of AudienceIdMembersGet200ResponseDataMembersInner from a JSON string 19 | audience_id_members_get200_response_data_members_inner_instance = AudienceIdMembersGet200ResponseDataMembersInner.from_json(json) 20 | # print the JSON string representation of the object 21 | print(AudienceIdMembersGet200ResponseDataMembersInner.to_json()) 22 | 23 | # convert the object into a dict 24 | audience_id_members_get200_response_data_members_inner_dict = audience_id_members_get200_response_data_members_inner_instance.to_dict() 25 | # create an instance of AudienceIdMembersGet200ResponseDataMembersInner from a dict 26 | audience_id_members_get200_response_data_members_inner_from_dict = AudienceIdMembersGet200ResponseDataMembersInner.from_dict(audience_id_members_get200_response_data_members_inner_dict) 27 | ``` 28 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 29 | 30 | 31 | -------------------------------------------------------------------------------- /docs/atoms/models/AudienceIdMembersSearchGet200ResponseData.md: -------------------------------------------------------------------------------- 1 | # AudienceIdMembersSearchGet200ResponseData 2 | 3 | 4 | ## Properties 5 | 6 | Name | Type | Description | Notes 7 | ------------ | ------------- | ------------- | ------------- 8 | **members** | [**List[AudienceIdMembersGet200ResponseDataMembersInner]**](AudienceIdMembersGet200ResponseDataMembersInner.md) | | [optional] 9 | **search_info** | [**AudienceIdMembersSearchGet200ResponseDataSearchInfo**](AudienceIdMembersSearchGet200ResponseDataSearchInfo.md) | | [optional] 10 | 11 | ## Example 12 | 13 | ```python 14 | from atoms.models.audience_id_members_search_get200_response_data import AudienceIdMembersSearchGet200ResponseData 15 | 16 | # TODO update the JSON string below 17 | json = "{}" 18 | # create an instance of AudienceIdMembersSearchGet200ResponseData from a JSON string 19 | audience_id_members_search_get200_response_data_instance = AudienceIdMembersSearchGet200ResponseData.from_json(json) 20 | # print the JSON string representation of the object 21 | print(AudienceIdMembersSearchGet200ResponseData.to_json()) 22 | 23 | # convert the object into a dict 24 | audience_id_members_search_get200_response_data_dict = audience_id_members_search_get200_response_data_instance.to_dict() 25 | # create an instance of AudienceIdMembersSearchGet200ResponseData from a dict 26 | audience_id_members_search_get200_response_data_from_dict = AudienceIdMembersSearchGet200ResponseData.from_dict(audience_id_members_search_get200_response_data_dict) 27 | ``` 28 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 29 | 30 | 31 | -------------------------------------------------------------------------------- /docs/atoms/models/WebhookSubscriptionPopulated.md: -------------------------------------------------------------------------------- 1 | # WebhookSubscriptionPopulated 2 | 3 | 4 | ## Properties 5 | 6 | Name | Type | Description | Notes 7 | ------------ | ------------- | ------------- | ------------- 8 | **id** | **str** | The unique identifier for the subscription | [optional] 9 | **webhook_id** | **str** | The ID of the webhook | [optional] 10 | **agent_id** | [**WebhookAgent**](WebhookAgent.md) | | [optional] 11 | **event_type** | **str** | The type of event subscribed to | [optional] 12 | **created_at** | **datetime** | The date and time when the subscription was created | [optional] 13 | **updated_at** | **datetime** | The date and time when the subscription was last updated | [optional] 14 | 15 | ## Example 16 | 17 | ```python 18 | from atoms.models.webhook_subscription_populated import WebhookSubscriptionPopulated 19 | 20 | # TODO update the JSON string below 21 | json = "{}" 22 | # create an instance of WebhookSubscriptionPopulated from a JSON string 23 | webhook_subscription_populated_instance = WebhookSubscriptionPopulated.from_json(json) 24 | # print the JSON string representation of the object 25 | print(WebhookSubscriptionPopulated.to_json()) 26 | 27 | # convert the object into a dict 28 | webhook_subscription_populated_dict = webhook_subscription_populated_instance.to_dict() 29 | # create an instance of WebhookSubscriptionPopulated from a dict 30 | webhook_subscription_populated_from_dict = WebhookSubscriptionPopulated.from_dict(webhook_subscription_populated_dict) 31 | ``` 32 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 33 | 34 | 35 | -------------------------------------------------------------------------------- /docs/atoms/models/AudienceIdMembersGet200ResponseData.md: -------------------------------------------------------------------------------- 1 | # AudienceIdMembersGet200ResponseData 2 | 3 | 4 | ## Properties 5 | 6 | Name | Type | Description | Notes 7 | ------------ | ------------- | ------------- | ------------- 8 | **members** | [**List[AudienceIdMembersGet200ResponseDataMembersInner]**](AudienceIdMembersGet200ResponseDataMembersInner.md) | | [optional] 9 | **total_count** | **int** | Total number of members in the audience | [optional] 10 | **total_pages** | **int** | Total number of pages available | [optional] 11 | **has_more** | **bool** | Whether there are more pages available | [optional] 12 | 13 | ## Example 14 | 15 | ```python 16 | from atoms.models.audience_id_members_get200_response_data import AudienceIdMembersGet200ResponseData 17 | 18 | # TODO update the JSON string below 19 | json = "{}" 20 | # create an instance of AudienceIdMembersGet200ResponseData from a JSON string 21 | audience_id_members_get200_response_data_instance = AudienceIdMembersGet200ResponseData.from_json(json) 22 | # print the JSON string representation of the object 23 | print(AudienceIdMembersGet200ResponseData.to_json()) 24 | 25 | # convert the object into a dict 26 | audience_id_members_get200_response_data_dict = audience_id_members_get200_response_data_instance.to_dict() 27 | # create an instance of AudienceIdMembersGet200ResponseData from a dict 28 | audience_id_members_get200_response_data_from_dict = AudienceIdMembersGet200ResponseData.from_dict(audience_id_members_get200_response_data_dict) 29 | ``` 30 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 31 | 32 | 33 | -------------------------------------------------------------------------------- /docs/atoms/models/AgentIdWorkflowGet200ResponseDataEdgesInnerMarkerEnd.md: -------------------------------------------------------------------------------- 1 | # AgentIdWorkflowGet200ResponseDataEdgesInnerMarkerEnd 2 | 3 | Arrow marker configuration 4 | 5 | ## Properties 6 | 7 | Name | Type | Description | Notes 8 | ------------ | ------------- | ------------- | ------------- 9 | **type** | **str** | | [optional] 10 | **width** | **float** | | [optional] 11 | **height** | **float** | | [optional] 12 | 13 | ## Example 14 | 15 | ```python 16 | from atoms.models.agent_id_workflow_get200_response_data_edges_inner_marker_end import AgentIdWorkflowGet200ResponseDataEdgesInnerMarkerEnd 17 | 18 | # TODO update the JSON string below 19 | json = "{}" 20 | # create an instance of AgentIdWorkflowGet200ResponseDataEdgesInnerMarkerEnd from a JSON string 21 | agent_id_workflow_get200_response_data_edges_inner_marker_end_instance = AgentIdWorkflowGet200ResponseDataEdgesInnerMarkerEnd.from_json(json) 22 | # print the JSON string representation of the object 23 | print(AgentIdWorkflowGet200ResponseDataEdgesInnerMarkerEnd.to_json()) 24 | 25 | # convert the object into a dict 26 | agent_id_workflow_get200_response_data_edges_inner_marker_end_dict = agent_id_workflow_get200_response_data_edges_inner_marker_end_instance.to_dict() 27 | # create an instance of AgentIdWorkflowGet200ResponseDataEdgesInnerMarkerEnd from a dict 28 | agent_id_workflow_get200_response_data_edges_inner_marker_end_from_dict = AgentIdWorkflowGet200ResponseDataEdgesInnerMarkerEnd.from_dict(agent_id_workflow_get200_response_data_edges_inner_marker_end_dict) 29 | ``` 30 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 31 | 32 | 33 | -------------------------------------------------------------------------------- /docs/atoms/LogsApi.md: -------------------------------------------------------------------------------- 1 | # atoms.LogsApi 2 | 3 | All URIs are relative to *https://atoms-api.smallest.ai/api/v1* 4 | 5 | Method | HTTP request | Description 6 | ------------- | ------------- | ------------- 7 | [**get_conversation_logs**](LogsApi.md#get_conversation_logs) | **GET** /conversation/{id} | Get conversation logs 8 | 9 | # **get_conversation_logs** 10 | 11 | Get conversation logs for a specific conversation ID. 12 | 13 | ### Example 14 | 15 | ```python 16 | from smallestai.atoms import AtomsClient 17 | 18 | def main(): 19 | atoms_client = AtomsClient() 20 | 21 | conversation_id = "your_conversation_id" 22 | response = atoms_client.get_conversation_logs(id=conversation_id) 23 | print(f"Conversation logs: {response.data}") 24 | 25 | if __name__ == "__main__": 26 | main() 27 | ``` 28 | 29 | ### Parameters 30 | 31 | Name | Type | Description | Notes 32 | ------------- | ------------- | ------------- | ------------- 33 | **id** | **str** | The conversation ID to retrieve logs for | 34 | 35 | ### Return type 36 | 37 | [**GetConversationLogs200Response**](./models/GetConversationLogs200Response.md) 38 | 39 | ### Authorization 40 | 41 | [BearerAuth](../README.md#BearerAuth) 42 | 43 | ### HTTP request headers 44 | 45 | - **Content-Type**: Not defined 46 | - **Accept**: application/json 47 | 48 | ### HTTP response details 49 | 50 | | Status code | Description | Response headers | 51 | |-------------|-------------|------------------| 52 | **200** | Successful response | - | 53 | **400** | Invalid input | - | 54 | **401** | Unauthorized access | - | 55 | **500** | Internal server error | - | 56 | 57 | [[Back to API list]](../../README.md#documentation-for-api-endpoints) 58 | 59 | -------------------------------------------------------------------------------- /docs/atoms/models/ProductPhoneNumbersGet200ResponseDataInnerAttributes.md: -------------------------------------------------------------------------------- 1 | # ProductPhoneNumbersGet200ResponseDataInnerAttributes 2 | 3 | Additional attributes of the phone number 4 | 5 | ## Properties 6 | 7 | Name | Type | Description | Notes 8 | ------------ | ------------- | ------------- | ------------- 9 | **provider** | **str** | The telephony provider | [optional] 10 | **phone_number** | **str** | The actual phone number | [optional] 11 | 12 | ## Example 13 | 14 | ```python 15 | from atoms.models.product_phone_numbers_get200_response_data_inner_attributes import ProductPhoneNumbersGet200ResponseDataInnerAttributes 16 | 17 | # TODO update the JSON string below 18 | json = "{}" 19 | # create an instance of ProductPhoneNumbersGet200ResponseDataInnerAttributes from a JSON string 20 | product_phone_numbers_get200_response_data_inner_attributes_instance = ProductPhoneNumbersGet200ResponseDataInnerAttributes.from_json(json) 21 | # print the JSON string representation of the object 22 | print(ProductPhoneNumbersGet200ResponseDataInnerAttributes.to_json()) 23 | 24 | # convert the object into a dict 25 | product_phone_numbers_get200_response_data_inner_attributes_dict = product_phone_numbers_get200_response_data_inner_attributes_instance.to_dict() 26 | # create an instance of ProductPhoneNumbersGet200ResponseDataInnerAttributes from a dict 27 | product_phone_numbers_get200_response_data_inner_attributes_from_dict = ProductPhoneNumbersGet200ResponseDataInnerAttributes.from_dict(product_phone_numbers_get200_response_data_inner_attributes_dict) 28 | ``` 29 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 30 | 31 | 32 | -------------------------------------------------------------------------------- /docs/atoms/models/AgentDTOLanguageSwitching.md: -------------------------------------------------------------------------------- 1 | # AgentDTOLanguageSwitching 2 | 3 | Language switching configuration for the agent 4 | 5 | ## Properties 6 | 7 | Name | Type | Description | Notes 8 | ------------ | ------------- | ------------- | ------------- 9 | **is_enabled** | **bool** | Whether language switching is enabled for the agent | [optional] 10 | **min_words_for_detection** | **float** | Minimum number of words required for language detection | [optional] 11 | **strong_signal_threshold** | **float** | Threshold for strong language signal detection | [optional] 12 | **weak_signal_threshold** | **float** | Threshold for weak language signal detection | [optional] 13 | **min_consecutive_for_weak_threshold_switch** | **float** | Minimum consecutive detections required for weak threshold language switch | [optional] 14 | 15 | ## Example 16 | 17 | ```python 18 | from atoms.models.agent_dto_language_switching import AgentDTOLanguageSwitching 19 | 20 | # TODO update the JSON string below 21 | json = "{}" 22 | # create an instance of AgentDTOLanguageSwitching from a JSON string 23 | agent_dto_language_switching_instance = AgentDTOLanguageSwitching.from_json(json) 24 | # print the JSON string representation of the object 25 | print(AgentDTOLanguageSwitching.to_json()) 26 | 27 | # convert the object into a dict 28 | agent_dto_language_switching_dict = agent_dto_language_switching_instance.to_dict() 29 | # create an instance of AgentDTOLanguageSwitching from a dict 30 | agent_dto_language_switching_from_dict = AgentDTOLanguageSwitching.from_dict(agent_dto_language_switching_dict) 31 | ``` 32 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 33 | 34 | 35 | -------------------------------------------------------------------------------- /docs/atoms/models/AgentTemplateGet200ResponseDataInner.md: -------------------------------------------------------------------------------- 1 | # AgentTemplateGet200ResponseDataInner 2 | 3 | 4 | ## Properties 5 | 6 | Name | Type | Description | Notes 7 | ------------ | ------------- | ------------- | ------------- 8 | **id** | **str** | The ID of the agent template | [optional] 9 | **name** | **str** | The name of the agent template | [optional] 10 | **description** | **str** | The description of the agent template | [optional] 11 | **avatar_url** | **str** | The avatar URL of the agent template | [optional] 12 | **reference_url** | **str** | The docs url of the agent template | [optional] 13 | **category** | **str** | The category of the agent template | [optional] 14 | 15 | ## Example 16 | 17 | ```python 18 | from atoms.models.agent_template_get200_response_data_inner import AgentTemplateGet200ResponseDataInner 19 | 20 | # TODO update the JSON string below 21 | json = "{}" 22 | # create an instance of AgentTemplateGet200ResponseDataInner from a JSON string 23 | agent_template_get200_response_data_inner_instance = AgentTemplateGet200ResponseDataInner.from_json(json) 24 | # print the JSON string representation of the object 25 | print(AgentTemplateGet200ResponseDataInner.to_json()) 26 | 27 | # convert the object into a dict 28 | agent_template_get200_response_data_inner_dict = agent_template_get200_response_data_inner_instance.to_dict() 29 | # create an instance of AgentTemplateGet200ResponseDataInner from a dict 30 | agent_template_get200_response_data_inner_from_dict = AgentTemplateGet200ResponseDataInner.from_dict(agent_template_get200_response_data_inner_dict) 31 | ``` 32 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 33 | 34 | 35 | -------------------------------------------------------------------------------- /docs/atoms/models/Webhook.md: -------------------------------------------------------------------------------- 1 | # Webhook 2 | 3 | 4 | ## Properties 5 | 6 | Name | Type | Description | Notes 7 | ------------ | ------------- | ------------- | ------------- 8 | **id** | **str** | The unique identifier for the webhook | [optional] 9 | **url** | **str** | The webhook endpoint URL | [optional] 10 | **description** | **str** | The description of the webhook | [optional] 11 | **status** | **str** | The status of the webhook | [optional] 12 | **organization_id** | **str** | The organization ID | [optional] 13 | **created_by** | **str** | The user ID who created the webhook | [optional] 14 | **subscriptions** | [**List[WebhookSubscriptionPopulated]**](WebhookSubscriptionPopulated.md) | A list of subscriptions for the webhook with populated agent details. | [optional] 15 | **decrypted_secret_key** | **str** | The decrypted signing secret for the webhook. This is only returned when fetching a single webhook by ID. | [optional] 16 | **created_at** | **datetime** | The date and time when the webhook was created | [optional] 17 | **updated_at** | **datetime** | The date and time when the webhook was last updated | [optional] 18 | 19 | ## Example 20 | 21 | ```python 22 | from atoms.models.webhook import Webhook 23 | 24 | # TODO update the JSON string below 25 | json = "{}" 26 | # create an instance of Webhook from a JSON string 27 | webhook_instance = Webhook.from_json(json) 28 | # print the JSON string representation of the object 29 | print(Webhook.to_json()) 30 | 31 | # convert the object into a dict 32 | webhook_dict = webhook_instance.to_dict() 33 | # create an instance of Webhook from a dict 34 | webhook_from_dict = Webhook.from_dict(webhook_dict) 35 | ``` 36 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 37 | 38 | 39 | -------------------------------------------------------------------------------- /docs/atoms/models/AgentIdWorkflowGet200ResponseDataNodesInnerDataVariables.md: -------------------------------------------------------------------------------- 1 | # AgentIdWorkflowGet200ResponseDataNodesInnerDataVariables 2 | 3 | Variables configuration 4 | 5 | ## Properties 6 | 7 | Name | Type | Description | Notes 8 | ------------ | ------------- | ------------- | ------------- 9 | **is_enabled** | **bool** | | [optional] 10 | **data** | [**List[AgentIdWorkflowGet200ResponseDataNodesInnerDataVariablesDataInner]**](AgentIdWorkflowGet200ResponseDataNodesInnerDataVariablesDataInner.md) | | [optional] 11 | 12 | ## Example 13 | 14 | ```python 15 | from atoms.models.agent_id_workflow_get200_response_data_nodes_inner_data_variables import AgentIdWorkflowGet200ResponseDataNodesInnerDataVariables 16 | 17 | # TODO update the JSON string below 18 | json = "{}" 19 | # create an instance of AgentIdWorkflowGet200ResponseDataNodesInnerDataVariables from a JSON string 20 | agent_id_workflow_get200_response_data_nodes_inner_data_variables_instance = AgentIdWorkflowGet200ResponseDataNodesInnerDataVariables.from_json(json) 21 | # print the JSON string representation of the object 22 | print(AgentIdWorkflowGet200ResponseDataNodesInnerDataVariables.to_json()) 23 | 24 | # convert the object into a dict 25 | agent_id_workflow_get200_response_data_nodes_inner_data_variables_dict = agent_id_workflow_get200_response_data_nodes_inner_data_variables_instance.to_dict() 26 | # create an instance of AgentIdWorkflowGet200ResponseDataNodesInnerDataVariables from a dict 27 | agent_id_workflow_get200_response_data_nodes_inner_data_variables_from_dict = AgentIdWorkflowGet200ResponseDataNodesInnerDataVariables.from_dict(agent_id_workflow_get200_response_data_nodes_inner_data_variables_dict) 28 | ``` 29 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 30 | 31 | 32 | -------------------------------------------------------------------------------- /docs/atoms/models/AgentIdWorkflowGet200ResponseDataNodesInnerDataVariablesDataInner.md: -------------------------------------------------------------------------------- 1 | # AgentIdWorkflowGet200ResponseDataNodesInnerDataVariablesDataInner 2 | 3 | 4 | ## Properties 5 | 6 | Name | Type | Description | Notes 7 | ------------ | ------------- | ------------- | ------------- 8 | **name** | **str** | | [optional] 9 | **type** | **str** | | [optional] 10 | **description** | **str** | | [optional] 11 | 12 | ## Example 13 | 14 | ```python 15 | from atoms.models.agent_id_workflow_get200_response_data_nodes_inner_data_variables_data_inner import AgentIdWorkflowGet200ResponseDataNodesInnerDataVariablesDataInner 16 | 17 | # TODO update the JSON string below 18 | json = "{}" 19 | # create an instance of AgentIdWorkflowGet200ResponseDataNodesInnerDataVariablesDataInner from a JSON string 20 | agent_id_workflow_get200_response_data_nodes_inner_data_variables_data_inner_instance = AgentIdWorkflowGet200ResponseDataNodesInnerDataVariablesDataInner.from_json(json) 21 | # print the JSON string representation of the object 22 | print(AgentIdWorkflowGet200ResponseDataNodesInnerDataVariablesDataInner.to_json()) 23 | 24 | # convert the object into a dict 25 | agent_id_workflow_get200_response_data_nodes_inner_data_variables_data_inner_dict = agent_id_workflow_get200_response_data_nodes_inner_data_variables_data_inner_instance.to_dict() 26 | # create an instance of AgentIdWorkflowGet200ResponseDataNodesInnerDataVariablesDataInner from a dict 27 | agent_id_workflow_get200_response_data_nodes_inner_data_variables_data_inner_from_dict = AgentIdWorkflowGet200ResponseDataNodesInnerDataVariablesDataInner.from_dict(agent_id_workflow_get200_response_data_nodes_inner_data_variables_data_inner_dict) 28 | ``` 29 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 30 | 31 | 32 | -------------------------------------------------------------------------------- /docs/atoms/models/AgentIdPatchRequestSynthesizerVoiceConfigOneOf1.md: -------------------------------------------------------------------------------- 1 | # AgentIdPatchRequestSynthesizerVoiceConfigOneOf1 2 | 3 | 4 | ## Properties 5 | 6 | Name | Type | Description | Notes 7 | ------------ | ------------- | ------------- | ------------- 8 | **model** | **str** | We currently support 3 types of models for the synthesizer. Waves, Waves Lightning Large and Waves Lightning Large Voice Clone. You can clone your voice using waves platform and use the voiceId for this field and select the model as waves_lightning_large_voice_clone to use your cloned voice. | [optional] 9 | **voice_id** | **str** | The voice ID to use | [optional] [default to 'nyah'] 10 | 11 | ## Example 12 | 13 | ```python 14 | from atoms.models.agent_id_patch_request_synthesizer_voice_config_one_of1 import AgentIdPatchRequestSynthesizerVoiceConfigOneOf1 15 | 16 | # TODO update the JSON string below 17 | json = "{}" 18 | # create an instance of AgentIdPatchRequestSynthesizerVoiceConfigOneOf1 from a JSON string 19 | agent_id_patch_request_synthesizer_voice_config_one_of1_instance = AgentIdPatchRequestSynthesizerVoiceConfigOneOf1.from_json(json) 20 | # print the JSON string representation of the object 21 | print(AgentIdPatchRequestSynthesizerVoiceConfigOneOf1.to_json()) 22 | 23 | # convert the object into a dict 24 | agent_id_patch_request_synthesizer_voice_config_one_of1_dict = agent_id_patch_request_synthesizer_voice_config_one_of1_instance.to_dict() 25 | # create an instance of AgentIdPatchRequestSynthesizerVoiceConfigOneOf1 from a dict 26 | agent_id_patch_request_synthesizer_voice_config_one_of1_from_dict = AgentIdPatchRequestSynthesizerVoiceConfigOneOf1.from_dict(agent_id_patch_request_synthesizer_voice_config_one_of1_dict) 27 | ``` 28 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 29 | 30 | 31 | -------------------------------------------------------------------------------- /docs/atoms/models/AudienceIdMembersSearchGet200ResponseDataSearchInfo.md: -------------------------------------------------------------------------------- 1 | # AudienceIdMembersSearchGet200ResponseDataSearchInfo 2 | 3 | Information about the search performed 4 | 5 | ## Properties 6 | 7 | Name | Type | Description | Notes 8 | ------------ | ------------- | ------------- | ------------- 9 | **search_type** | **str** | The type of search performed | [optional] 10 | **search_term** | **str** | The search term(s) used | [optional] 11 | **search_fields** | **List[str]** | The specific fields searched (for field-specific searches) | [optional] 12 | **total_results** | **int** | The number of results returned | [optional] 13 | 14 | ## Example 15 | 16 | ```python 17 | from atoms.models.audience_id_members_search_get200_response_data_search_info import AudienceIdMembersSearchGet200ResponseDataSearchInfo 18 | 19 | # TODO update the JSON string below 20 | json = "{}" 21 | # create an instance of AudienceIdMembersSearchGet200ResponseDataSearchInfo from a JSON string 22 | audience_id_members_search_get200_response_data_search_info_instance = AudienceIdMembersSearchGet200ResponseDataSearchInfo.from_json(json) 23 | # print the JSON string representation of the object 24 | print(AudienceIdMembersSearchGet200ResponseDataSearchInfo.to_json()) 25 | 26 | # convert the object into a dict 27 | audience_id_members_search_get200_response_data_search_info_dict = audience_id_members_search_get200_response_data_search_info_instance.to_dict() 28 | # create an instance of AudienceIdMembersSearchGet200ResponseDataSearchInfo from a dict 29 | audience_id_members_search_get200_response_data_search_info_from_dict = AudienceIdMembersSearchGet200ResponseDataSearchInfo.from_dict(audience_id_members_search_get200_response_data_search_info_dict) 30 | ``` 31 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 32 | 33 | 34 | -------------------------------------------------------------------------------- /docs/atoms/models/AudienceGet200ResponseDataInner.md: -------------------------------------------------------------------------------- 1 | # AudienceGet200ResponseDataInner 2 | 3 | 4 | ## Properties 5 | 6 | Name | Type | Description | Notes 7 | ------------ | ------------- | ------------- | ------------- 8 | **id** | **str** | The unique identifier for the audience | [optional] 9 | **name** | **str** | The name of the audience | [optional] 10 | **description** | **str** | The description of the audience | [optional] 11 | **phone_number_column_name** | **str** | The name of the column in the CSV that contains phone numbers | [optional] 12 | **organization** | **str** | The organization ID | [optional] 13 | **created_by** | **str** | The user ID who created the audience | [optional] 14 | **created_at** | **datetime** | The date and time when the audience was created | [optional] 15 | **updated_at** | **datetime** | The date and time when the audience was last updated | [optional] 16 | 17 | ## Example 18 | 19 | ```python 20 | from atoms.models.audience_get200_response_data_inner import AudienceGet200ResponseDataInner 21 | 22 | # TODO update the JSON string below 23 | json = "{}" 24 | # create an instance of AudienceGet200ResponseDataInner from a JSON string 25 | audience_get200_response_data_inner_instance = AudienceGet200ResponseDataInner.from_json(json) 26 | # print the JSON string representation of the object 27 | print(AudienceGet200ResponseDataInner.to_json()) 28 | 29 | # convert the object into a dict 30 | audience_get200_response_data_inner_dict = audience_get200_response_data_inner_instance.to_dict() 31 | # create an instance of AudienceGet200ResponseDataInner from a dict 32 | audience_get200_response_data_inner_from_dict = AudienceGet200ResponseDataInner.from_dict(audience_get200_response_data_inner_dict) 33 | ``` 34 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 35 | 36 | 37 | -------------------------------------------------------------------------------- /docs/atoms/models/ProductPhoneNumbersGet200ResponseDataInner.md: -------------------------------------------------------------------------------- 1 | # ProductPhoneNumbersGet200ResponseDataInner 2 | 3 | 4 | ## Properties 5 | 6 | Name | Type | Description | Notes 7 | ------------ | ------------- | ------------- | ------------- 8 | **id** | **str** | The unique identifier for the phone number | [optional] 9 | **is_active** | **bool** | Whether the phone number is active | [optional] 10 | **attributes** | [**ProductPhoneNumbersGet200ResponseDataInnerAttributes**](ProductPhoneNumbersGet200ResponseDataInnerAttributes.md) | | [optional] 11 | **created_at** | **datetime** | The date and time when the phone number was created | [optional] 12 | **updated_at** | **datetime** | The date and time when the phone number was last updated | [optional] 13 | 14 | ## Example 15 | 16 | ```python 17 | from atoms.models.product_phone_numbers_get200_response_data_inner import ProductPhoneNumbersGet200ResponseDataInner 18 | 19 | # TODO update the JSON string below 20 | json = "{}" 21 | # create an instance of ProductPhoneNumbersGet200ResponseDataInner from a JSON string 22 | product_phone_numbers_get200_response_data_inner_instance = ProductPhoneNumbersGet200ResponseDataInner.from_json(json) 23 | # print the JSON string representation of the object 24 | print(ProductPhoneNumbersGet200ResponseDataInner.to_json()) 25 | 26 | # convert the object into a dict 27 | product_phone_numbers_get200_response_data_inner_dict = product_phone_numbers_get200_response_data_inner_instance.to_dict() 28 | # create an instance of ProductPhoneNumbersGet200ResponseDataInner from a dict 29 | product_phone_numbers_get200_response_data_inner_from_dict = ProductPhoneNumbersGet200ResponseDataInner.from_dict(product_phone_numbers_get200_response_data_inner_dict) 30 | ``` 31 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 32 | 33 | 34 | -------------------------------------------------------------------------------- /docs/atoms/models/CreateAgentRequestLanguage.md: -------------------------------------------------------------------------------- 1 | # CreateAgentRequestLanguage 2 | 3 | Language configuration for the agent. You can enable or disable language switching for the agent. This will be used to determine the language of the agent. 4 | 5 | ## Properties 6 | 7 | Name | Type | Description | Notes 8 | ------------ | ------------- | ------------- | ------------- 9 | **enabled** | **str** | The language of the agent. You can choose from the list of supported languages. | [optional] [default to 'en'] 10 | **switching** | [**AgentIdPatchRequestLanguageSwitching**](AgentIdPatchRequestLanguageSwitching.md) | | [optional] 11 | **synthesizer** | [**CreateAgentRequestLanguageSynthesizer**](CreateAgentRequestLanguageSynthesizer.md) | | [optional] 12 | **speed** | **float** | | [optional] [default to 1.2] 13 | **consistency** | **float** | | [optional] [default to 0.5] 14 | **similarity** | **float** | | [optional] [default to 0] 15 | **enhancement** | **float** | | [optional] [default to 1] 16 | 17 | ## Example 18 | 19 | ```python 20 | from atoms.models.create_agent_request_language import CreateAgentRequestLanguage 21 | 22 | # TODO update the JSON string below 23 | json = "{}" 24 | # create an instance of CreateAgentRequestLanguage from a JSON string 25 | create_agent_request_language_instance = CreateAgentRequestLanguage.from_json(json) 26 | # print the JSON string representation of the object 27 | print(CreateAgentRequestLanguage.to_json()) 28 | 29 | # convert the object into a dict 30 | create_agent_request_language_dict = create_agent_request_language_instance.to_dict() 31 | # create an instance of CreateAgentRequestLanguage from a dict 32 | create_agent_request_language_from_dict = CreateAgentRequestLanguage.from_dict(create_agent_request_language_dict) 33 | ``` 34 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 35 | 36 | 37 | -------------------------------------------------------------------------------- /docs/atoms/models/AgentIdPatchRequestSynthesizerVoiceConfig.md: -------------------------------------------------------------------------------- 1 | # AgentIdPatchRequestSynthesizerVoiceConfig 2 | 3 | 4 | ## Properties 5 | 6 | Name | Type | Description | Notes 7 | ------------ | ------------- | ------------- | ------------- 8 | **model** | **str** | We currently support 3 types of models for the synthesizer. Waves, Waves Lightning Large and Waves Lightning Large Voice Clone. You can clone your voice using waves platform and use the voiceId for this field and select the model as waves_lightning_large_voice_clone to use your cloned voice. | [optional] 9 | **voice_id** | **str** | The voice ID to use | [optional] [default to 'nyah'] 10 | **gender** | **str** | The gender of the synthesizer. When selecting gender, you have to select the model and voiceId which are required fields. | [optional] 11 | 12 | ## Example 13 | 14 | ```python 15 | from atoms.models.agent_id_patch_request_synthesizer_voice_config import AgentIdPatchRequestSynthesizerVoiceConfig 16 | 17 | # TODO update the JSON string below 18 | json = "{}" 19 | # create an instance of AgentIdPatchRequestSynthesizerVoiceConfig from a JSON string 20 | agent_id_patch_request_synthesizer_voice_config_instance = AgentIdPatchRequestSynthesizerVoiceConfig.from_json(json) 21 | # print the JSON string representation of the object 22 | print(AgentIdPatchRequestSynthesizerVoiceConfig.to_json()) 23 | 24 | # convert the object into a dict 25 | agent_id_patch_request_synthesizer_voice_config_dict = agent_id_patch_request_synthesizer_voice_config_instance.to_dict() 26 | # create an instance of AgentIdPatchRequestSynthesizerVoiceConfig from a dict 27 | agent_id_patch_request_synthesizer_voice_config_from_dict = AgentIdPatchRequestSynthesizerVoiceConfig.from_dict(agent_id_patch_request_synthesizer_voice_config_dict) 28 | ``` 29 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 30 | 31 | 32 | -------------------------------------------------------------------------------- /docs/atoms/CallsApi.md: -------------------------------------------------------------------------------- 1 | # atoms.CallsApi 2 | 3 | All URIs are relative to *https://atoms-api.smallest.ai/api/v1* 4 | 5 | Method | HTTP request | Description 6 | ------------- | ------------- | ------------- 7 | [**start_outbound_call**](CallsApi.md#start_outbound_call) | **POST** /conversation/outbound | Start an outbound call 8 | 9 | # **start_outbound_call** 10 | 11 | Initiates an outbound conversation with a specified agent and phone number. 12 | 13 | ### Example 14 | 15 | ```python 16 | from smallestai.atoms import AtomsClient 17 | 18 | def main(): 19 | atoms_client = AtomsClient() 20 | 21 | call_request = { 22 | "agent_id": "your_agent_id", 23 | "phone_number": "+1234567890" 24 | } 25 | 26 | response = atoms_client.start_outbound_call(start_outbound_call_request=call_request) 27 | print(f"Started call with conversation ID: {response.conversation_id}") 28 | 29 | if __name__ == "__main__": 30 | main() 31 | ``` 32 | 33 | ### Parameters 34 | 35 | Name | Type | Description | Notes 36 | ------------- | ------------- | ------------- | ------------- 37 | **start_outbound_call_request** | [**StartOutboundCallRequest**](./models/StartOutboundCallRequest.md) | Call configuration | 38 | 39 | ### Return type 40 | 41 | [**StartOutboundCall200Response**](./models/StartOutboundCall200Response.md) 42 | 43 | ### Authorization 44 | 45 | [BearerAuth](../README.md#BearerAuth) 46 | 47 | ### HTTP request headers 48 | 49 | - **Content-Type**: application/json 50 | - **Accept**: application/json 51 | 52 | ### HTTP response details 53 | 54 | | Status code | Description | Response headers | 55 | |-------------|-------------|------------------| 56 | **200** | Successfully started the outbound conversation | - | 57 | **400** | Invalid input | - | 58 | **401** | Unauthorized access | - | 59 | **500** | Internal server error | - | 60 | 61 | [[Back to API list]](../../README.md#documentation-for-api-endpoints) 62 | 63 | -------------------------------------------------------------------------------- /docs/atoms/models/AudiencePost200ResponseData.md: -------------------------------------------------------------------------------- 1 | # AudiencePost200ResponseData 2 | 3 | 4 | ## Properties 5 | 6 | Name | Type | Description | Notes 7 | ------------ | ------------- | ------------- | ------------- 8 | **id** | **str** | The unique identifier for the audience | [optional] 9 | **name** | **str** | The name of the audience | [optional] 10 | **description** | **str** | The description of the audience | [optional] 11 | **phone_number_column_name** | **str** | The name of the column in the CSV that contains phone numbers | [optional] 12 | **identifier_column_name** | **str** | The name of the column in the CSV that contains identifiers | [optional] 13 | **organization** | **str** | The organization ID | [optional] 14 | **created_by** | **str** | The user ID who created the audience | [optional] 15 | **created_at** | **datetime** | The date and time when the audience was created | [optional] 16 | **updated_at** | **datetime** | The date and time when the audience was last updated | [optional] 17 | 18 | ## Example 19 | 20 | ```python 21 | from atoms.models.audience_post200_response_data import AudiencePost200ResponseData 22 | 23 | # TODO update the JSON string below 24 | json = "{}" 25 | # create an instance of AudiencePost200ResponseData from a JSON string 26 | audience_post200_response_data_instance = AudiencePost200ResponseData.from_json(json) 27 | # print the JSON string representation of the object 28 | print(AudiencePost200ResponseData.to_json()) 29 | 30 | # convert the object into a dict 31 | audience_post200_response_data_dict = audience_post200_response_data_instance.to_dict() 32 | # create an instance of AudiencePost200ResponseData from a dict 33 | audience_post200_response_data_from_dict = AudiencePost200ResponseData.from_dict(audience_post200_response_data_dict) 34 | ``` 35 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 36 | 37 | 38 | -------------------------------------------------------------------------------- /docs/atoms/models/AgentIdPatchRequestSynthesizerVoiceConfigOneOf.md: -------------------------------------------------------------------------------- 1 | # AgentIdPatchRequestSynthesizerVoiceConfigOneOf 2 | 3 | 4 | ## Properties 5 | 6 | Name | Type | Description | Notes 7 | ------------ | ------------- | ------------- | ------------- 8 | **model** | **str** | We currently support 3 types of models for the synthesizer. Waves, Waves Lightning Large and Waves Lightning Large Voice Clone. You can clone your voice using waves platform and use the voiceId for this field and select the model as waves_lightning_large_voice_clone to use your cloned voice. | [optional] 9 | **voice_id** | **str** | | [optional] 10 | **gender** | **str** | The gender of the synthesizer. When selecting gender, you have to select the model and voiceId which are required fields. | [optional] 11 | 12 | ## Example 13 | 14 | ```python 15 | from atoms.models.agent_id_patch_request_synthesizer_voice_config_one_of import AgentIdPatchRequestSynthesizerVoiceConfigOneOf 16 | 17 | # TODO update the JSON string below 18 | json = "{}" 19 | # create an instance of AgentIdPatchRequestSynthesizerVoiceConfigOneOf from a JSON string 20 | agent_id_patch_request_synthesizer_voice_config_one_of_instance = AgentIdPatchRequestSynthesizerVoiceConfigOneOf.from_json(json) 21 | # print the JSON string representation of the object 22 | print(AgentIdPatchRequestSynthesizerVoiceConfigOneOf.to_json()) 23 | 24 | # convert the object into a dict 25 | agent_id_patch_request_synthesizer_voice_config_one_of_dict = agent_id_patch_request_synthesizer_voice_config_one_of_instance.to_dict() 26 | # create an instance of AgentIdPatchRequestSynthesizerVoiceConfigOneOf from a dict 27 | agent_id_patch_request_synthesizer_voice_config_one_of_from_dict = AgentIdPatchRequestSynthesizerVoiceConfigOneOf.from_dict(agent_id_patch_request_synthesizer_voice_config_one_of_dict) 28 | ``` 29 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 30 | 31 | 32 | -------------------------------------------------------------------------------- /docs/atoms/models/KnowledgeBaseItem.md: -------------------------------------------------------------------------------- 1 | # KnowledgeBaseItem 2 | 3 | 4 | ## Properties 5 | 6 | Name | Type | Description | Notes 7 | ------------ | ------------- | ------------- | ------------- 8 | **id** | **str** | The unique identifier for the knowledge base item | 9 | **item_type** | **str** | The type of the knowledge base item | 10 | **metadata** | **object** | Additional metadata for the item | [optional] 11 | **knowledge_base_id** | **str** | The ID of the knowledge base this item belongs to | 12 | **processing_status** | **str** | The processing status of the item | 13 | **file_name** | **str** | The name of the file (for file type items) | [optional] 14 | **content_type** | **str** | The MIME type of the content | [optional] 15 | **size** | **float** | The size of the file in bytes | [optional] 16 | **key** | **str** | The storage key for the file | [optional] 17 | **title** | **str** | The title of the item | [optional] 18 | **content** | **str** | The content of the item (for text type items) | [optional] 19 | **created_at** | **datetime** | The date and time when the item was created | 20 | **updated_at** | **datetime** | The date and time when the item was last updated | 21 | 22 | ## Example 23 | 24 | ```python 25 | from atoms.models.knowledge_base_item import KnowledgeBaseItem 26 | 27 | # TODO update the JSON string below 28 | json = "{}" 29 | # create an instance of KnowledgeBaseItem from a JSON string 30 | knowledge_base_item_instance = KnowledgeBaseItem.from_json(json) 31 | # print the JSON string representation of the object 32 | print(KnowledgeBaseItem.to_json()) 33 | 34 | # convert the object into a dict 35 | knowledge_base_item_dict = knowledge_base_item_instance.to_dict() 36 | # create an instance of KnowledgeBaseItem from a dict 37 | knowledge_base_item_from_dict = KnowledgeBaseItem.from_dict(knowledge_base_item_dict) 38 | ``` 39 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 40 | 41 | 42 | -------------------------------------------------------------------------------- /docs/atoms/models/CreateAgentRequestLanguageSynthesizerVoiceConfig.md: -------------------------------------------------------------------------------- 1 | # CreateAgentRequestLanguageSynthesizerVoiceConfig 2 | 3 | 4 | ## Properties 5 | 6 | Name | Type | Description | Notes 7 | ------------ | ------------- | ------------- | ------------- 8 | **model** | **str** | We currently support 3 types of models for the synthesizer. Waves, Waves Lightning Large and Waves Lightning Large Voice Clone. You can clone your voice using waves platform and use the voiceId for this field and select the model as waves_lightning_large_voice_clone to use your cloned voice. | [optional] 9 | **voice_id** | **str** | The voice ID to use | [optional] [default to 'nyah'] 10 | **gender** | **str** | The gender of the synthesizer. When selecting gender, you have to select the model and voiceId which are required fields. | [optional] 11 | 12 | ## Example 13 | 14 | ```python 15 | from atoms.models.create_agent_request_language_synthesizer_voice_config import CreateAgentRequestLanguageSynthesizerVoiceConfig 16 | 17 | # TODO update the JSON string below 18 | json = "{}" 19 | # create an instance of CreateAgentRequestLanguageSynthesizerVoiceConfig from a JSON string 20 | create_agent_request_language_synthesizer_voice_config_instance = CreateAgentRequestLanguageSynthesizerVoiceConfig.from_json(json) 21 | # print the JSON string representation of the object 22 | print(CreateAgentRequestLanguageSynthesizerVoiceConfig.to_json()) 23 | 24 | # convert the object into a dict 25 | create_agent_request_language_synthesizer_voice_config_dict = create_agent_request_language_synthesizer_voice_config_instance.to_dict() 26 | # create an instance of CreateAgentRequestLanguageSynthesizerVoiceConfig from a dict 27 | create_agent_request_language_synthesizer_voice_config_from_dict = CreateAgentRequestLanguageSynthesizerVoiceConfig.from_dict(create_agent_request_language_synthesizer_voice_config_dict) 28 | ``` 29 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 30 | 31 | 32 | -------------------------------------------------------------------------------- /docs/atoms/models/AgentIdPatchRequest.md: -------------------------------------------------------------------------------- 1 | # AgentIdPatchRequest 2 | 3 | 4 | ## Properties 5 | 6 | Name | Type | Description | Notes 7 | ------------ | ------------- | ------------- | ------------- 8 | **name** | **str** | | [optional] 9 | **description** | **str** | | [optional] 10 | **language** | [**AgentIdPatchRequestLanguage**](AgentIdPatchRequestLanguage.md) | | [optional] 11 | **synthesizer** | [**AgentIdPatchRequestSynthesizer**](AgentIdPatchRequestSynthesizer.md) | | [optional] 12 | **global_knowledge_base_id** | **str** | | [optional] 13 | **slm_model** | **str** | | [optional] [default to 'electron'] 14 | **default_variables** | **object** | The default variables to use for the agent. These variables will be used if no variables are provided when initiating a conversation with the agent. | [optional] 15 | **global_prompt** | **str** | Set global instructions for your agent's personality, role, and behavior throughout conversations | [optional] 16 | **telephony_product_id** | **str** | The telephony product ID of the agent. This is the product ID of the telephony product that will be used to make the outbound call. You can buy telephone number and assign it to the agent. | [optional] 17 | 18 | ## Example 19 | 20 | ```python 21 | from atoms.models.agent_id_patch_request import AgentIdPatchRequest 22 | 23 | # TODO update the JSON string below 24 | json = "{}" 25 | # create an instance of AgentIdPatchRequest from a JSON string 26 | agent_id_patch_request_instance = AgentIdPatchRequest.from_json(json) 27 | # print the JSON string representation of the object 28 | print(AgentIdPatchRequest.to_json()) 29 | 30 | # convert the object into a dict 31 | agent_id_patch_request_dict = agent_id_patch_request_instance.to_dict() 32 | # create an instance of AgentIdPatchRequest from a dict 33 | agent_id_patch_request_from_dict = AgentIdPatchRequest.from_dict(agent_id_patch_request_dict) 34 | ``` 35 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 36 | 37 | 38 | -------------------------------------------------------------------------------- /docs/atoms/models/WebhookGet200ResponseData.md: -------------------------------------------------------------------------------- 1 | # WebhookGet200ResponseData 2 | 3 | 4 | ## Properties 5 | 6 | Name | Type | Description | Notes 7 | ------------ | ------------- | ------------- | ------------- 8 | **id** | **str** | The unique identifier for the webhook | [optional] 9 | **url** | **str** | The webhook endpoint URL | [optional] 10 | **description** | **str** | The description of the webhook | [optional] 11 | **status** | **str** | The status of the webhook | [optional] 12 | **organization_id** | **str** | The organization ID | [optional] 13 | **created_by** | **str** | The user ID who created the webhook | [optional] 14 | **subscriptions** | [**List[WebhookSubscriptionPopulated]**](WebhookSubscriptionPopulated.md) | A list of subscriptions for the webhook with populated agent details. | [optional] 15 | **decrypted_secret_key** | **str** | The decrypted signing secret for the webhook. This is only returned when fetching a single webhook by ID. | [optional] 16 | **created_at** | **datetime** | The date and time when the webhook was created | [optional] 17 | **updated_at** | **datetime** | The date and time when the webhook was last updated | [optional] 18 | 19 | ## Example 20 | 21 | ```python 22 | from atoms.models.webhook_get200_response_data import WebhookGet200ResponseData 23 | 24 | # TODO update the JSON string below 25 | json = "{}" 26 | # create an instance of WebhookGet200ResponseData from a JSON string 27 | webhook_get200_response_data_instance = WebhookGet200ResponseData.from_json(json) 28 | # print the JSON string representation of the object 29 | print(WebhookGet200ResponseData.to_json()) 30 | 31 | # convert the object into a dict 32 | webhook_get200_response_data_dict = webhook_get200_response_data_instance.to_dict() 33 | # create an instance of WebhookGet200ResponseData from a dict 34 | webhook_get200_response_data_from_dict = WebhookGet200ResponseData.from_dict(webhook_get200_response_data_dict) 35 | ``` 36 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 37 | 38 | 39 | -------------------------------------------------------------------------------- /docs/atoms/models/AgentIdPatchRequestLanguageSwitching.md: -------------------------------------------------------------------------------- 1 | # AgentIdPatchRequestLanguageSwitching 2 | 3 | Language switching configuration for the agent. If enabled, the agent will be able to switch between languages based on the user's language. 4 | 5 | ## Properties 6 | 7 | Name | Type | Description | Notes 8 | ------------ | ------------- | ------------- | ------------- 9 | **is_enabled** | **bool** | Whether to enable language switching for the agent | [optional] [default to False] 10 | **min_words_for_detection** | **float** | Minimum number of words required for language detection | [optional] [default to 2] 11 | **strong_signal_threshold** | **float** | Threshold for strong language signal detection (0.1 to 0.9) | [optional] [default to 0.7] 12 | **weak_signal_threshold** | **float** | Threshold for weak language signal detection (0.1 to 0.9) | [optional] [default to 0.3] 13 | **min_consecutive_for_weak_threshold_switch** | **float** | Minimum consecutive detections required for weak threshold language switch | [optional] [default to 2] 14 | 15 | ## Example 16 | 17 | ```python 18 | from atoms.models.agent_id_patch_request_language_switching import AgentIdPatchRequestLanguageSwitching 19 | 20 | # TODO update the JSON string below 21 | json = "{}" 22 | # create an instance of AgentIdPatchRequestLanguageSwitching from a JSON string 23 | agent_id_patch_request_language_switching_instance = AgentIdPatchRequestLanguageSwitching.from_json(json) 24 | # print the JSON string representation of the object 25 | print(AgentIdPatchRequestLanguageSwitching.to_json()) 26 | 27 | # convert the object into a dict 28 | agent_id_patch_request_language_switching_dict = agent_id_patch_request_language_switching_instance.to_dict() 29 | # create an instance of AgentIdPatchRequestLanguageSwitching from a dict 30 | agent_id_patch_request_language_switching_from_dict = AgentIdPatchRequestLanguageSwitching.from_dict(agent_id_patch_request_language_switching_dict) 31 | ``` 32 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 33 | 34 | 35 | -------------------------------------------------------------------------------- /docs/atoms/AgentTemplatesApi.md: -------------------------------------------------------------------------------- 1 | # atoms.AgentTemplatesApi 2 | 3 | All URIs are relative to *https://atoms-api.smallest.ai/api/v1* 4 | 5 | Method | HTTP request | Description 6 | ------------- | ------------- | ------------- 7 | [**create_agent_from_template**](AgentTemplatesApi.md#create_agent_from_template) | **POST** /agent/from-template | Create agent from template 8 | [**get_agent_templates**](AgentTemplatesApi.md#get_agent_templates) | **GET** /agent/template | Get agent templates 9 | 10 | # **create_agent_from_template** 11 | 12 | Create a new agent using a predefined template. 13 | 14 | ### Example 15 | 16 | ```python 17 | from smallestai.atoms import AtomsClient 18 | 19 | def main(): 20 | atoms_client = AtomsClient() 21 | 22 | template_request = { 23 | "template_id": "your_template_id", 24 | "name": "My Template Agent" 25 | } 26 | 27 | response = atoms_client.create_agent_from_template(create_agent_from_template_request=template_request) 28 | print(f"Created agent with ID: {response.data}") 29 | 30 | if __name__ == "__main__": 31 | main() 32 | ``` 33 | 34 | ### Parameters 35 | 36 | Name | Type | Description | Notes 37 | ------------- | ------------- | ------------- | ------------- 38 | **create_agent_from_template_request** | [**CreateAgentFromTemplateRequest**](./models/CreateAgentFromTemplateRequest.md) | Template configuration | 39 | 40 | ### Return type 41 | 42 | [**CreateAgentFromTemplate200Response**](./models/CreateAgentFromTemplate200Response.md) 43 | 44 | # **get_agent_templates** 45 | 46 | Get a list of available agent templates. 47 | 48 | ### Example 49 | 50 | ```python 51 | from smallestai.atoms import AtomsClient 52 | 53 | def main(): 54 | atoms_client = AtomsClient() 55 | 56 | response = atoms_client.get_agent_templates() 57 | print(f"Available templates: {response.data}") 58 | 59 | if __name__ == "__main__": 60 | main() 61 | ``` 62 | 63 | ### Parameters 64 | 65 | This endpoint does not need any parameter. 66 | 67 | ### Return type 68 | 69 | [**GetAgentTemplates200Response**](./models/GetAgentTemplates200Response.md) 70 | 71 | -------------------------------------------------------------------------------- /docs/atoms/models/CampaignIdGet200ResponseData.md: -------------------------------------------------------------------------------- 1 | # CampaignIdGet200ResponseData 2 | 3 | 4 | ## Properties 5 | 6 | Name | Type | Description | Notes 7 | ------------ | ------------- | ------------- | ------------- 8 | **id** | **str** | The unique identifier for the campaign | [optional] 9 | **name** | **str** | The name of the campaign | [optional] 10 | **description** | **str** | The description of the campaign | [optional] 11 | **organization** | **str** | The ID of the organization | [optional] 12 | **agent_id** | **str** | The ID of the agent | [optional] 13 | **created_by** | **str** | The ID of the user who created the campaign | [optional] 14 | **audience_id** | **str** | The ID of the audience | [optional] 15 | **participants_count** | **int** | The number of participants in the campaign | [optional] 16 | **created_at** | **datetime** | The date and time when the campaign was created | [optional] 17 | **updated_at** | **datetime** | The date and time when the campaign was last updated | [optional] 18 | **is_campaign_in_progress** | **bool** | Whether the campaign is in progress | [optional] 19 | **is_campaign_completed** | **bool** | Whether the campaign is completed | [optional] 20 | 21 | ## Example 22 | 23 | ```python 24 | from atoms.models.campaign_id_get200_response_data import CampaignIdGet200ResponseData 25 | 26 | # TODO update the JSON string below 27 | json = "{}" 28 | # create an instance of CampaignIdGet200ResponseData from a JSON string 29 | campaign_id_get200_response_data_instance = CampaignIdGet200ResponseData.from_json(json) 30 | # print the JSON string representation of the object 31 | print(CampaignIdGet200ResponseData.to_json()) 32 | 33 | # convert the object into a dict 34 | campaign_id_get200_response_data_dict = campaign_id_get200_response_data_instance.to_dict() 35 | # create an instance of CampaignIdGet200ResponseData from a dict 36 | campaign_id_get200_response_data_from_dict = CampaignIdGet200ResponseData.from_dict(campaign_id_get200_response_data_dict) 37 | ``` 38 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 39 | 40 | 41 | -------------------------------------------------------------------------------- /tests/atoms/test_campaigns_api.py: -------------------------------------------------------------------------------- 1 | import pytest 2 | from smallestai.atoms.atoms_client import AtomsClient 3 | from smallestai.atoms.models.campaign_post_request import CampaignPostRequest 4 | from smallestai.atoms.models.campaign_get_request import CampaignGetRequest 5 | from smallestai.atoms.models.campaign_post201_response import CampaignPost201Response 6 | from smallestai.atoms.models.campaign_id_get200_response import CampaignIdGet200Response 7 | from smallestai.atoms.models.campaign_get200_response import CampaignGet200Response 8 | from smallestai.atoms.models.agent_id_delete200_response import AgentIdDelete200Response 9 | import uuid 10 | 11 | def test_create_campaign(atoms_client, global_state): 12 | request = CampaignPostRequest( 13 | name="Test Campaign", 14 | description="Test campaign description", 15 | agentId=global_state["base_agent"]["id"], 16 | audienceId=global_state["audience"]["id"] 17 | ) 18 | response = atoms_client.create_campaign(campaign_post_request=request) 19 | assert isinstance(response, CampaignPost201Response) # Returns List[CampaignPost201Response] 20 | 21 | def test_get_campaigns(atoms_client): 22 | request = CampaignGetRequest() 23 | response = atoms_client.get_campaigns(campaign_get_request=request) 24 | assert isinstance(response, CampaignGet200Response) 25 | 26 | def test_get_campaign_by_id(atoms_client, global_state): 27 | response = atoms_client.get_campaign_by_id(id=global_state["base_campaign"]["id"]) 28 | assert isinstance(response, CampaignIdGet200Response) 29 | 30 | def test_start_campaign(atoms_client, global_state): 31 | response = atoms_client.start_campaign(id=global_state["base_campaign"]["id"]) 32 | assert isinstance(response, AgentIdDelete200Response) 33 | 34 | def test_pause_campaign(atoms_client, global_state): 35 | response = atoms_client.pause_campaign(id=global_state["base_campaign"]["id"]) 36 | assert isinstance(response, AgentIdDelete200Response) 37 | 38 | def test_delete_campaign(atoms_client, global_state): 39 | response = atoms_client.delete_campaign(id=global_state["temp_campaign"]["id"]) 40 | assert isinstance(response, AgentIdDelete200Response) -------------------------------------------------------------------------------- /docs/atoms/models/AgentIdWorkflowGet200ResponseDataNodesInner.md: -------------------------------------------------------------------------------- 1 | # AgentIdWorkflowGet200ResponseDataNodesInner 2 | 3 | 4 | ## Properties 5 | 6 | Name | Type | Description | Notes 7 | ------------ | ------------- | ------------- | ------------- 8 | **id** | **str** | Unique identifier for the node | [optional] 9 | **type** | **str** | Type of the node (e.g., default_node, end_call, pre_call_api) | [optional] 10 | **position** | [**AgentIdWorkflowGet200ResponseDataNodesInnerPosition**](AgentIdWorkflowGet200ResponseDataNodesInnerPosition.md) | | [optional] 11 | **position_absolute** | [**AgentIdWorkflowGet200ResponseDataNodesInnerPosition**](AgentIdWorkflowGet200ResponseDataNodesInnerPosition.md) | | [optional] 12 | **data** | [**AgentIdWorkflowGet200ResponseDataNodesInnerData**](AgentIdWorkflowGet200ResponseDataNodesInnerData.md) | | [optional] 13 | **width** | **float** | | [optional] 14 | **height** | **float** | | [optional] 15 | **selected** | **bool** | | [optional] 16 | **dragging** | **bool** | | [optional] 17 | 18 | ## Example 19 | 20 | ```python 21 | from atoms.models.agent_id_workflow_get200_response_data_nodes_inner import AgentIdWorkflowGet200ResponseDataNodesInner 22 | 23 | # TODO update the JSON string below 24 | json = "{}" 25 | # create an instance of AgentIdWorkflowGet200ResponseDataNodesInner from a JSON string 26 | agent_id_workflow_get200_response_data_nodes_inner_instance = AgentIdWorkflowGet200ResponseDataNodesInner.from_json(json) 27 | # print the JSON string representation of the object 28 | print(AgentIdWorkflowGet200ResponseDataNodesInner.to_json()) 29 | 30 | # convert the object into a dict 31 | agent_id_workflow_get200_response_data_nodes_inner_dict = agent_id_workflow_get200_response_data_nodes_inner_instance.to_dict() 32 | # create an instance of AgentIdWorkflowGet200ResponseDataNodesInner from a dict 33 | agent_id_workflow_get200_response_data_nodes_inner_from_dict = AgentIdWorkflowGet200ResponseDataNodesInner.from_dict(agent_id_workflow_get200_response_data_nodes_inner_dict) 34 | ``` 35 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 36 | 37 | 38 | -------------------------------------------------------------------------------- /docs/atoms/models/AgentDTO.md: -------------------------------------------------------------------------------- 1 | # AgentDTO 2 | 3 | 4 | ## Properties 5 | 6 | Name | Type | Description | Notes 7 | ------------ | ------------- | ------------- | ------------- 8 | **id** | **str** | The ID of the agent | [optional] 9 | **name** | **str** | The name of the agent | [optional] 10 | **description** | **str** | The description of the agent | [optional] 11 | **background_sound** | **bool** | Whether ambient background sound is enabled during calls | [optional] 12 | **organization** | **str** | The organization ID of the agent | [optional] 13 | **workflow_id** | **str** | The workflow ID of the agent | [optional] 14 | **created_by** | **str** | The user ID of the user who created the agent | [optional] 15 | **global_knowledge_base_id** | **str** | The global knowledge base ID of the agent | [optional] 16 | **language** | [**AgentDTOLanguage**](AgentDTOLanguage.md) | | [optional] 17 | **synthesizer** | [**AgentDTOSynthesizer**](AgentDTOSynthesizer.md) | | [optional] 18 | **slm_model** | **str** | The LLM model to use for the agent. LLM model will be used to generate the response and take decisions based on the user's query. | [optional] 19 | **default_variables** | **object** | The default variables to use for the agent. These variables will be used if no variables are provided when initiating a conversation with the agent. | [optional] 20 | **created_at** | **datetime** | The date and time when the agent was created | [optional] 21 | **updated_at** | **datetime** | The date and time when the agent was last updated | [optional] 22 | 23 | ## Example 24 | 25 | ```python 26 | from atoms.models.agent_dto import AgentDTO 27 | 28 | # TODO update the JSON string below 29 | json = "{}" 30 | # create an instance of AgentDTO from a JSON string 31 | agent_dto_instance = AgentDTO.from_json(json) 32 | # print the JSON string representation of the object 33 | print(AgentDTO.to_json()) 34 | 35 | # convert the object into a dict 36 | agent_dto_dict = agent_dto_instance.to_dict() 37 | # create an instance of AgentDTO from a dict 38 | agent_dto_from_dict = AgentDTO.from_dict(agent_dto_dict) 39 | ``` 40 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 41 | 42 | 43 | -------------------------------------------------------------------------------- /docs/atoms/models/AgentIdPatchRequestSynthesizer.md: -------------------------------------------------------------------------------- 1 | # AgentIdPatchRequestSynthesizer 2 | 3 | Synthesizer configuration for the agent. You can configure the synthesizer to use different voices and models. Currently we support 3 types of models for the synthesizer. Waves, Waves Lightning Large and Waves Lightning Large Voice Clone. You can clone your voice using waves platform https://waves.smallest.ai/voice-clone and use the voiceId for this field and select the model as waves_lightning_large_voice_clone to use your cloned voice. When updating the synthesizer configuration to voice clone model, you have to provide model and voiceId and gender all are required fields but when selecting the model as waves or waves and waves_lightning_large, you have to provide only model field and voiceId. 4 | 5 | ## Properties 6 | 7 | Name | Type | Description | Notes 8 | ------------ | ------------- | ------------- | ------------- 9 | **voice_config** | [**AgentIdPatchRequestSynthesizerVoiceConfig**](AgentIdPatchRequestSynthesizerVoiceConfig.md) | | [optional] 10 | **speed** | **float** | | [optional] [default to 1.2] 11 | **consistency** | **float** | | [optional] [default to 0.5] 12 | **similarity** | **float** | | [optional] [default to 0] 13 | **enhancement** | **float** | | [optional] [default to 1] 14 | 15 | ## Example 16 | 17 | ```python 18 | from atoms.models.agent_id_patch_request_synthesizer import AgentIdPatchRequestSynthesizer 19 | 20 | # TODO update the JSON string below 21 | json = "{}" 22 | # create an instance of AgentIdPatchRequestSynthesizer from a JSON string 23 | agent_id_patch_request_synthesizer_instance = AgentIdPatchRequestSynthesizer.from_json(json) 24 | # print the JSON string representation of the object 25 | print(AgentIdPatchRequestSynthesizer.to_json()) 26 | 27 | # convert the object into a dict 28 | agent_id_patch_request_synthesizer_dict = agent_id_patch_request_synthesizer_instance.to_dict() 29 | # create an instance of AgentIdPatchRequestSynthesizer from a dict 30 | agent_id_patch_request_synthesizer_from_dict = AgentIdPatchRequestSynthesizer.from_dict(agent_id_patch_request_synthesizer_dict) 31 | ``` 32 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 33 | 34 | 35 | -------------------------------------------------------------------------------- /docs/atoms/models/AgentIdWorkflowGet200ResponseDataEdgesInner.md: -------------------------------------------------------------------------------- 1 | # AgentIdWorkflowGet200ResponseDataEdgesInner 2 | 3 | 4 | ## Properties 5 | 6 | Name | Type | Description | Notes 7 | ------------ | ------------- | ------------- | ------------- 8 | **id** | **str** | Unique identifier for the edge | [optional] 9 | **source** | **str** | ID of the source node | [optional] 10 | **source_handle** | **str** | Source handle ID | [optional] 11 | **target** | **str** | ID of the target node | [optional] 12 | **target_handle** | **str** | Target handle ID | [optional] 13 | **type** | **str** | Type of the edge (e.g., smoothstep, direct) | [optional] 14 | **label** | **str** | Label for the edge | [optional] 15 | **description** | **str** | Description of the edge | [optional] 16 | **selected** | **bool** | | [optional] 17 | **animated** | **bool** | | [optional] 18 | **marker_end** | [**AgentIdWorkflowGet200ResponseDataEdgesInnerMarkerEnd**](AgentIdWorkflowGet200ResponseDataEdgesInnerMarkerEnd.md) | | [optional] 19 | **data** | [**AgentIdWorkflowGet200ResponseDataEdgesInnerData**](AgentIdWorkflowGet200ResponseDataEdgesInnerData.md) | | [optional] 20 | 21 | ## Example 22 | 23 | ```python 24 | from atoms.models.agent_id_workflow_get200_response_data_edges_inner import AgentIdWorkflowGet200ResponseDataEdgesInner 25 | 26 | # TODO update the JSON string below 27 | json = "{}" 28 | # create an instance of AgentIdWorkflowGet200ResponseDataEdgesInner from a JSON string 29 | agent_id_workflow_get200_response_data_edges_inner_instance = AgentIdWorkflowGet200ResponseDataEdgesInner.from_json(json) 30 | # print the JSON string representation of the object 31 | print(AgentIdWorkflowGet200ResponseDataEdgesInner.to_json()) 32 | 33 | # convert the object into a dict 34 | agent_id_workflow_get200_response_data_edges_inner_dict = agent_id_workflow_get200_response_data_edges_inner_instance.to_dict() 35 | # create an instance of AgentIdWorkflowGet200ResponseDataEdgesInner from a dict 36 | agent_id_workflow_get200_response_data_edges_inner_from_dict = AgentIdWorkflowGet200ResponseDataEdgesInner.from_dict(agent_id_workflow_get200_response_data_edges_inner_dict) 37 | ``` 38 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 39 | 40 | 41 | -------------------------------------------------------------------------------- /docs/atoms/models/ConversationIdGet200ResponseData.md: -------------------------------------------------------------------------------- 1 | # ConversationIdGet200ResponseData 2 | 3 | 4 | ## Properties 5 | 6 | Name | Type | Description | Notes 7 | ------------ | ------------- | ------------- | ------------- 8 | **id** | **str** | The ID of the conversation | [optional] 9 | **call_id** | **str** | The ID of the conversation | [optional] 10 | **agent** | [**AgentDTO**](AgentDTO.md) | | [optional] 11 | **status** | **str** | The status of the conversation | [optional] 12 | **duration** | **float** | The duration of the conversation in seconds | [optional] 13 | **recording_url** | **str** | The recording URL of the conversation | [optional] 14 | **var_from** | **str** | The phone number of the caller | [optional] 15 | **to** | **str** | The phone number of the callee | [optional] 16 | **transcript** | **List[str]** | The transcript of the conversation | [optional] 17 | **average_transcriber_latency** | **float** | The average time taken by the TTS to transcribe the conversation | [optional] 18 | **average_agent_latency** | **float** | The average time taken by the LLM to respond to the conversation | [optional] 19 | **average_synthesizer_latency** | **float** | The average time taken by the TTS to synthesize the conversation | [optional] 20 | **type** | **str** | The type of the conversation | [optional] 21 | 22 | ## Example 23 | 24 | ```python 25 | from atoms.models.conversation_id_get200_response_data import ConversationIdGet200ResponseData 26 | 27 | # TODO update the JSON string below 28 | json = "{}" 29 | # create an instance of ConversationIdGet200ResponseData from a JSON string 30 | conversation_id_get200_response_data_instance = ConversationIdGet200ResponseData.from_json(json) 31 | # print the JSON string representation of the object 32 | print(ConversationIdGet200ResponseData.to_json()) 33 | 34 | # convert the object into a dict 35 | conversation_id_get200_response_data_dict = conversation_id_get200_response_data_instance.to_dict() 36 | # create an instance of ConversationIdGet200ResponseData from a dict 37 | conversation_id_get200_response_data_from_dict = ConversationIdGet200ResponseData.from_dict(conversation_id_get200_response_data_dict) 38 | ``` 39 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 40 | 41 | 42 | -------------------------------------------------------------------------------- /docs/atoms/models/CreateAgentRequestLanguageSynthesizer.md: -------------------------------------------------------------------------------- 1 | # CreateAgentRequestLanguageSynthesizer 2 | 3 | Synthesizer configuration for the agent. You can configure the synthesizer to use different voices and models. Currently we support 3 types of models for the synthesizer. Waves, Waves Lightning Large and Waves Lightning Large Voice Clone. You can clone your voice using waves platform https://waves.smallest.ai/voice-clone and use the voiceId for this field and select the model as waves_lightning_large_voice_clone to use your cloned voice. When updating the synthesizer configuration to voice clone model, you have to provide model and voiceId and gender all are required fields but when selecting the model as waves or waves and waves_lightning_large, you have to provide only model field and voiceId. 4 | 5 | ## Properties 6 | 7 | Name | Type | Description | Notes 8 | ------------ | ------------- | ------------- | ------------- 9 | **voice_config** | [**CreateAgentRequestLanguageSynthesizerVoiceConfig**](CreateAgentRequestLanguageSynthesizerVoiceConfig.md) | | [optional] 10 | **speed** | **float** | | [optional] [default to 1.2] 11 | **consistency** | **float** | | [optional] [default to 0.5] 12 | **similarity** | **float** | | [optional] [default to 0] 13 | **enhancement** | **float** | | [optional] [default to 1] 14 | 15 | ## Example 16 | 17 | ```python 18 | from atoms.models.create_agent_request_language_synthesizer import CreateAgentRequestLanguageSynthesizer 19 | 20 | # TODO update the JSON string below 21 | json = "{}" 22 | # create an instance of CreateAgentRequestLanguageSynthesizer from a JSON string 23 | create_agent_request_language_synthesizer_instance = CreateAgentRequestLanguageSynthesizer.from_json(json) 24 | # print the JSON string representation of the object 25 | print(CreateAgentRequestLanguageSynthesizer.to_json()) 26 | 27 | # convert the object into a dict 28 | create_agent_request_language_synthesizer_dict = create_agent_request_language_synthesizer_instance.to_dict() 29 | # create an instance of CreateAgentRequestLanguageSynthesizer from a dict 30 | create_agent_request_language_synthesizer_from_dict = CreateAgentRequestLanguageSynthesizer.from_dict(create_agent_request_language_synthesizer_dict) 31 | ``` 32 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 33 | 34 | 35 | -------------------------------------------------------------------------------- /docs/atoms/models/CreateAgentRequest.md: -------------------------------------------------------------------------------- 1 | # CreateAgentRequest 2 | 3 | 4 | ## Properties 5 | 6 | Name | Type | Description | Notes 7 | ------------ | ------------- | ------------- | ------------- 8 | **name** | **str** | | 9 | **description** | **str** | | [optional] 10 | **background_sound** | **bool** | Whether to add ambient background sound during calls. Currently provides office ambience by default. Additional sound options available upon request. | [optional] [default to False] 11 | **language** | [**CreateAgentRequestLanguage**](CreateAgentRequestLanguage.md) | | [optional] 12 | **global_knowledge_base_id** | **str** | The global knowledge base ID of the agent. You can create a global knowledge base by using the /knowledgebase endpoint and assign it to the agent. The agent will use this knowledge base for its responses. | [optional] 13 | **slm_model** | **str** | The LLM model to use for the agent. LLM model will be used to generate the response and take decisions based on the user's query. | [optional] [default to 'electron'] 14 | **default_variables** | **object** | The default variables to use for the agent. These variables will be used if no variables are provided when initiating a conversation with the agent. | [optional] 15 | **global_prompt** | **str** | Set global instructions for your agent's personality, role, and behavior throughout conversations | [optional] 16 | **telephony_product_id** | **str** | The telephony product ID of the agent. This is the product ID of the telephony product that will be used to make the outbound call. You can buy telephone number and assign it to the agent. | [optional] 17 | 18 | ## Example 19 | 20 | ```python 21 | from atoms.models.create_agent_request import CreateAgentRequest 22 | 23 | # TODO update the JSON string below 24 | json = "{}" 25 | # create an instance of CreateAgentRequest from a JSON string 26 | create_agent_request_instance = CreateAgentRequest.from_json(json) 27 | # print the JSON string representation of the object 28 | print(CreateAgentRequest.to_json()) 29 | 30 | # convert the object into a dict 31 | create_agent_request_dict = create_agent_request_instance.to_dict() 32 | # create an instance of CreateAgentRequest from a dict 33 | create_agent_request_from_dict = CreateAgentRequest.from_dict(create_agent_request_dict) 34 | ``` 35 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 36 | 37 | 38 | -------------------------------------------------------------------------------- /docs/atoms/models/AgentIdWorkflowGet200ResponseDataNodesInnerData.md: -------------------------------------------------------------------------------- 1 | # AgentIdWorkflowGet200ResponseDataNodesInnerData 2 | 3 | Node-specific data and configuration 4 | 5 | ## Properties 6 | 7 | Name | Type | Description | Notes 8 | ------------ | ------------- | ------------- | ------------- 9 | **label** | **str** | Display label for the node | [optional] 10 | **action** | **str** | The action/prompt text for the node | [optional] 11 | **is_start_node** | **bool** | Whether this is the starting node | [optional] 12 | **static_text** | **bool** | Whether the text is static | [optional] 13 | **knowledge_base** | **str** | Knowledge base ID for the node | [optional] 14 | **use_global_knowledge_base** | **bool** | Whether to use global knowledge base | [optional] 15 | **is_disconnected** | **bool** | Whether the node is disconnected | [optional] 16 | **type** | **str** | Node type | [optional] 17 | **variables** | [**AgentIdWorkflowGet200ResponseDataNodesInnerDataVariables**](AgentIdWorkflowGet200ResponseDataNodesInnerDataVariables.md) | | [optional] 18 | **has_error** | **bool** | | [optional] 19 | **validation_errors** | **List[str]** | | [optional] 20 | **http_request** | **object** | HTTP request configuration (for pre_call_api nodes) | [optional] 21 | **response_data** | **object** | Response data configuration (for pre_call_api nodes) | [optional] 22 | 23 | ## Example 24 | 25 | ```python 26 | from atoms.models.agent_id_workflow_get200_response_data_nodes_inner_data import AgentIdWorkflowGet200ResponseDataNodesInnerData 27 | 28 | # TODO update the JSON string below 29 | json = "{}" 30 | # create an instance of AgentIdWorkflowGet200ResponseDataNodesInnerData from a JSON string 31 | agent_id_workflow_get200_response_data_nodes_inner_data_instance = AgentIdWorkflowGet200ResponseDataNodesInnerData.from_json(json) 32 | # print the JSON string representation of the object 33 | print(AgentIdWorkflowGet200ResponseDataNodesInnerData.to_json()) 34 | 35 | # convert the object into a dict 36 | agent_id_workflow_get200_response_data_nodes_inner_data_dict = agent_id_workflow_get200_response_data_nodes_inner_data_instance.to_dict() 37 | # create an instance of AgentIdWorkflowGet200ResponseDataNodesInnerData from a dict 38 | agent_id_workflow_get200_response_data_nodes_inner_data_from_dict = AgentIdWorkflowGet200ResponseDataNodesInnerData.from_dict(agent_id_workflow_get200_response_data_nodes_inner_data_dict) 39 | ``` 40 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 41 | 42 | 43 | -------------------------------------------------------------------------------- /smallestai/__init__.py: -------------------------------------------------------------------------------- 1 | """ 2 | SmallestAI Python SDK 3 | 4 | This package provides access to both the Atoms API (agent management) 5 | and Waves API components. 6 | """ 7 | 8 | from smallestai.atoms import ( 9 | AgentTemplatesApi, 10 | AgentsApi, 11 | CallsApi, 12 | CampaignsApi, 13 | KnowledgeBaseApi, 14 | LogsApi, 15 | OrganizationApi, 16 | UserApi, 17 | ApiResponse, 18 | ApiClient, 19 | Configuration, 20 | OpenApiException, 21 | ApiTypeError, 22 | ApiValueError, 23 | ApiKeyError, 24 | ApiAttributeError, 25 | ApiException, 26 | AgentDTO, 27 | AgentDTOLanguage, 28 | AgentDTOSynthesizer, 29 | AgentDTOSynthesizerVoiceConfig, 30 | BadRequestErrorResponse, 31 | AgentFromTemplatePost200Response, 32 | CreateAgentFromTemplateRequest, 33 | CreateAgentRequest, 34 | CreateAgentRequestLanguage, 35 | CreateAgentRequestLanguageSynthesizer, 36 | CreateAgentRequestLanguageSynthesizerVoiceConfig, 37 | CampaignPost201Response, 38 | CampaignPostRequest, 39 | CampaignGetRequest, 40 | AgentIdDelete200Response, 41 | AgentIdGet200Response, 42 | AgentTemplateGet200Response, 43 | AgentTemplateGet200ResponseDataInner, 44 | AgentGet200Response, 45 | CampaignIdGet200Response, 46 | CampaignGet200Response, 47 | ConversationIdGet200Response, 48 | ConversationIdGet200ResponseData, 49 | UserGet200Response, 50 | UserGet200ResponseData, 51 | KnowledgebaseIdGet200Response, 52 | KnowledgebasePost201Response, 53 | KnowledgebasePostRequest, 54 | KnowledgebaseIdItemsUploadTextPostRequest, 55 | OrganizationGet200Response, 56 | OrganizationGet200ResponseData, 57 | OrganizationGet200ResponseDataMembersInner, 58 | OrganizationGet200ResponseDataSubscription, 59 | InternalServerErrorResponse, 60 | ConversationOutboundPost200Response, 61 | ConversationOutboundPost200ResponseData, 62 | ConversationOutboundPostRequest, 63 | UnauthorizedErrorReponse, 64 | AgentIdPatch200Response, 65 | AgentIdPatchRequest, 66 | AgentIdPatchRequestLanguage, 67 | AgentIdPatchRequestSynthesizer, 68 | AgentIdPatchRequestSynthesizerVoiceConfig, 69 | AgentIdPatchRequestSynthesizerVoiceConfigOneOf, 70 | AgentIdPatchRequestSynthesizerVoiceConfigOneOf1, 71 | AtomsClient 72 | ) 73 | 74 | from smallestai.waves import ( 75 | WavesClient, 76 | AsyncWavesClient, 77 | WavesStreamingTTS 78 | ) 79 | 80 | from smallestai.atoms import __all__ as atoms_all 81 | from smallestai.waves import __all__ as waves_all 82 | 83 | __all__ = atoms_all + waves_all 84 | 85 | __version__ = "4.0.1" -------------------------------------------------------------------------------- /tests/atoms/test_agents_api.py: -------------------------------------------------------------------------------- 1 | import pytest 2 | from smallestai.atoms.atoms_client import AtomsClient 3 | from smallestai.atoms.models.create_agent_request import CreateAgentRequest 4 | from smallestai.atoms.models.agent_id_patch_request import AgentIdPatchRequest 5 | from smallestai.atoms.models.agent_from_template_post200_response import AgentFromTemplatePost200Response 6 | from smallestai.atoms.models.agent_id_get200_response import AgentIdGet200Response 7 | from smallestai.atoms.models.agent_get200_response import AgentGet200Response 8 | from smallestai.atoms.models.agent_id_patch200_response import AgentIdPatch200Response 9 | from smallestai.atoms.models.agent_id_delete200_response import AgentIdDelete200Response 10 | 11 | def test_create_agent(atoms_client, global_state): 12 | request = CreateAgentRequest( 13 | name="Test Agent", 14 | description="Test agent description", 15 | # language={ 16 | # "enabled": "en", 17 | # "synthesizer": { 18 | # "voiceConfig": { 19 | # "model": "waves_lightning_large", 20 | # "voiceId": "nyah" 21 | # }, 22 | # "speed": 1.2, 23 | # "consistency": 0.5, 24 | # "similarity": 0, 25 | # "enhancement": 1 26 | # }, 27 | # "speed": 1.2, 28 | # "consistency": 0.5, 29 | # "similarity": 0, 30 | # "enhancement": 1 31 | # }, 32 | slm_model="electron", 33 | global_knowledge_base_id=global_state["base_knowledge_base"]["id"] 34 | ) 35 | 36 | response = atoms_client.create_agent(create_agent_request=request) 37 | assert isinstance(response, AgentFromTemplatePost200Response) 38 | 39 | def test_get_agent_by_id(atoms_client, global_state): 40 | response = atoms_client.get_agent_by_id(id=global_state["base_agent"]["id"]) 41 | assert isinstance(response, AgentIdGet200Response) 42 | 43 | def test_get_agents(atoms_client): 44 | response = atoms_client.get_agents() 45 | assert isinstance(response, AgentGet200Response) 46 | 47 | def test_update_agent(atoms_client, global_state): 48 | request = AgentIdPatchRequest( 49 | name="Updated Test Agent" 50 | ) 51 | 52 | response = atoms_client.update_agent( 53 | id=global_state["base_agent"]["id"], 54 | agent_id_patch_request=request 55 | ) 56 | assert isinstance(response, AgentIdPatch200Response) 57 | 58 | def test_delete_agent(atoms_client, global_state): 59 | response = atoms_client.delete_agent(id=global_state["temp_agent"]["id"]) 60 | assert isinstance(response, AgentIdDelete200Response) 61 | -------------------------------------------------------------------------------- /tests/waves/test_utils.py: -------------------------------------------------------------------------------- 1 | import pytest 2 | from smallestai.waves.utils import validate_input, get_smallest_languages, get_smallest_models 3 | from smallestai.waves.exceptions import ValidationError 4 | from smallestai.waves.models import TTSModels, TTSLanguages_lightning, TTSLanguages_lightning_large, TTSLanguages_lightning_v2 5 | 6 | def test_validate_input_valid(): 7 | """Tests that validate_input passes with valid parameters.""" 8 | validate_input(text="hello world", model="lightning", sample_rate=16000, speed=1.0) 9 | validate_input( 10 | text="test", 11 | model="lightning-large", 12 | sample_rate=24000, 13 | speed=2.0, 14 | consistency=0.5, 15 | similarity=0.5, 16 | enhancement=1 17 | ) 18 | 19 | def test_validate_input_invalid(): 20 | """Tests that validate_input raises ValidationError for invalid parameters.""" 21 | with pytest.raises(ValidationError, match="Text cannot be empty"): 22 | validate_input(text="", model="lightning", sample_rate=16000, speed=1.0) 23 | 24 | with pytest.raises(ValidationError, match="Invalid model"): 25 | validate_input(text="test", model="invalid-model", sample_rate=16000, speed=1.0) 26 | 27 | with pytest.raises(ValidationError, match="Invalid sample rate"): 28 | validate_input(text="test", model="lightning", sample_rate=7000, speed=1.0) 29 | 30 | with pytest.raises(ValidationError, match="Invalid speed"): 31 | validate_input(text="test", model="lightning", sample_rate=16000, speed=3.0) 32 | 33 | with pytest.raises(ValidationError, match="Invalid consistency"): 34 | validate_input(text="test", model="lightning-large", sample_rate=16000, speed=1.0, consistency=1.1) 35 | 36 | with pytest.raises(ValidationError, match="Invalid similarity"): 37 | validate_input(text="test", model="lightning-large", sample_rate=16000, speed=1.0, similarity=-0.1) 38 | 39 | with pytest.raises(ValidationError, match="Invalid enhancement"): 40 | validate_input(text="test", model="lightning-large", sample_rate=16000, speed=1.0, enhancement=3) 41 | 42 | def test_get_smallest_languages(): 43 | """Tests the get_smallest_languages function.""" 44 | assert get_smallest_languages("lightning") == TTSLanguages_lightning 45 | assert get_smallest_languages("lightning-large") == TTSLanguages_lightning_large 46 | assert get_smallest_languages("lightning-v2") == TTSLanguages_lightning_v2 47 | with pytest.raises(ValidationError, match="Invalid model"): 48 | get_smallest_languages("invalid-model") 49 | 50 | def test_get_smallest_models(): 51 | """Tests the get_smallest_models function.""" 52 | assert get_smallest_models() == TTSModels -------------------------------------------------------------------------------- /smallestai/atoms/models/agent_id_delete200_response.py: -------------------------------------------------------------------------------- 1 | # coding: utf-8 2 | 3 | """ 4 | Agent Management API 5 | 6 | API for managing agents, their templates, and call logs 7 | 8 | The version of the OpenAPI document: 1.0.0 9 | Generated by OpenAPI Generator (https://openapi-generator.tech) 10 | 11 | Do not edit the class manually. 12 | """ # noqa: E501 13 | 14 | 15 | from __future__ import annotations 16 | import pprint 17 | import re # noqa: F401 18 | import json 19 | 20 | from pydantic import BaseModel, ConfigDict, StrictBool 21 | from typing import Any, ClassVar, Dict, List, Optional 22 | from typing import Optional, Set 23 | from typing_extensions import Self 24 | 25 | class AgentIdDelete200Response(BaseModel): 26 | """ 27 | AgentIdDelete200Response 28 | """ # noqa: E501 29 | status: Optional[StrictBool] = None 30 | __properties: ClassVar[List[str]] = ["status"] 31 | 32 | model_config = ConfigDict( 33 | populate_by_name=True, 34 | validate_assignment=True, 35 | protected_namespaces=(), 36 | ) 37 | 38 | 39 | def to_str(self) -> str: 40 | """Returns the string representation of the model using alias""" 41 | return pprint.pformat(self.model_dump(by_alias=True)) 42 | 43 | def to_json(self) -> str: 44 | """Returns the JSON representation of the model using alias""" 45 | # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead 46 | return json.dumps(self.to_dict()) 47 | 48 | @classmethod 49 | def from_json(cls, json_str: str) -> Optional[Self]: 50 | """Create an instance of AgentIdDelete200Response from a JSON string""" 51 | return cls.from_dict(json.loads(json_str)) 52 | 53 | def to_dict(self) -> Dict[str, Any]: 54 | """Return the dictionary representation of the model using alias. 55 | 56 | This has the following differences from calling pydantic's 57 | `self.model_dump(by_alias=True)`: 58 | 59 | * `None` is only added to the output dict for nullable fields that 60 | were set at model initialization. Other fields with value `None` 61 | are ignored. 62 | """ 63 | excluded_fields: Set[str] = set([ 64 | ]) 65 | 66 | _dict = self.model_dump( 67 | by_alias=True, 68 | exclude=excluded_fields, 69 | exclude_none=True, 70 | ) 71 | return _dict 72 | 73 | @classmethod 74 | def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: 75 | """Create an instance of AgentIdDelete200Response from a dict""" 76 | if obj is None: 77 | return None 78 | 79 | if not isinstance(obj, dict): 80 | return cls.model_validate(obj) 81 | 82 | _obj = cls.model_validate({ 83 | "status": obj.get("status") 84 | }) 85 | return _obj 86 | 87 | 88 | -------------------------------------------------------------------------------- /smallestai/atoms/models/campaign_get200_response_data.py: -------------------------------------------------------------------------------- 1 | # coding: utf-8 2 | 3 | """ 4 | Agent Management API 5 | 6 | API for managing agents, their templates, and call logs 7 | 8 | The version of the OpenAPI document: 1.0.0 9 | Generated by OpenAPI Generator (https://openapi-generator.tech) 10 | 11 | Do not edit the class manually. 12 | """ # noqa: E501 13 | 14 | 15 | from __future__ import annotations 16 | import pprint 17 | import re # noqa: F401 18 | import json 19 | 20 | from pydantic import BaseModel, ConfigDict 21 | from typing import Any, ClassVar, Dict, List, Optional 22 | from typing import Optional, Set 23 | from typing_extensions import Self 24 | 25 | class CampaignGet200ResponseData(BaseModel): 26 | """ 27 | CampaignGet200ResponseData 28 | """ # noqa: E501 29 | campaigns: Optional[List[Dict[str, Any]]] = None 30 | __properties: ClassVar[List[str]] = ["campaigns"] 31 | 32 | model_config = ConfigDict( 33 | populate_by_name=True, 34 | validate_assignment=True, 35 | protected_namespaces=(), 36 | ) 37 | 38 | 39 | def to_str(self) -> str: 40 | """Returns the string representation of the model using alias""" 41 | return pprint.pformat(self.model_dump(by_alias=True)) 42 | 43 | def to_json(self) -> str: 44 | """Returns the JSON representation of the model using alias""" 45 | # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead 46 | return json.dumps(self.to_dict()) 47 | 48 | @classmethod 49 | def from_json(cls, json_str: str) -> Optional[Self]: 50 | """Create an instance of CampaignGet200ResponseData from a JSON string""" 51 | return cls.from_dict(json.loads(json_str)) 52 | 53 | def to_dict(self) -> Dict[str, Any]: 54 | """Return the dictionary representation of the model using alias. 55 | 56 | This has the following differences from calling pydantic's 57 | `self.model_dump(by_alias=True)`: 58 | 59 | * `None` is only added to the output dict for nullable fields that 60 | were set at model initialization. Other fields with value `None` 61 | are ignored. 62 | """ 63 | excluded_fields: Set[str] = set([ 64 | ]) 65 | 66 | _dict = self.model_dump( 67 | by_alias=True, 68 | exclude=excluded_fields, 69 | exclude_none=True, 70 | ) 71 | return _dict 72 | 73 | @classmethod 74 | def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: 75 | """Create an instance of CampaignGet200ResponseData from a dict""" 76 | if obj is None: 77 | return None 78 | 79 | if not isinstance(obj, dict): 80 | return cls.model_validate(obj) 81 | 82 | _obj = cls.model_validate({ 83 | "campaigns": obj.get("campaigns") 84 | }) 85 | return _obj 86 | 87 | 88 | -------------------------------------------------------------------------------- /smallestai/atoms/models/api_response.py: -------------------------------------------------------------------------------- 1 | # coding: utf-8 2 | 3 | """ 4 | Agent Management API 5 | 6 | API for managing agents, their templates, and call logs 7 | 8 | The version of the OpenAPI document: 1.0.0 9 | Generated by OpenAPI Generator (https://openapi-generator.tech) 10 | 11 | Do not edit the class manually. 12 | """ # noqa: E501 13 | 14 | 15 | from __future__ import annotations 16 | import pprint 17 | import re # noqa: F401 18 | import json 19 | 20 | from pydantic import BaseModel, ConfigDict, StrictBool 21 | from typing import Any, ClassVar, Dict, List, Optional 22 | from typing import Optional, Set 23 | from typing_extensions import Self 24 | 25 | class ApiResponse(BaseModel): 26 | """ 27 | ApiResponse 28 | """ # noqa: E501 29 | status: Optional[StrictBool] = None 30 | data: Optional[Dict[str, Any]] = None 31 | __properties: ClassVar[List[str]] = ["status", "data"] 32 | 33 | model_config = ConfigDict( 34 | populate_by_name=True, 35 | validate_assignment=True, 36 | protected_namespaces=(), 37 | ) 38 | 39 | 40 | def to_str(self) -> str: 41 | """Returns the string representation of the model using alias""" 42 | return pprint.pformat(self.model_dump(by_alias=True)) 43 | 44 | def to_json(self) -> str: 45 | """Returns the JSON representation of the model using alias""" 46 | # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead 47 | return json.dumps(self.to_dict()) 48 | 49 | @classmethod 50 | def from_json(cls, json_str: str) -> Optional[Self]: 51 | """Create an instance of ApiResponse from a JSON string""" 52 | return cls.from_dict(json.loads(json_str)) 53 | 54 | def to_dict(self) -> Dict[str, Any]: 55 | """Return the dictionary representation of the model using alias. 56 | 57 | This has the following differences from calling pydantic's 58 | `self.model_dump(by_alias=True)`: 59 | 60 | * `None` is only added to the output dict for nullable fields that 61 | were set at model initialization. Other fields with value `None` 62 | are ignored. 63 | """ 64 | excluded_fields: Set[str] = set([ 65 | ]) 66 | 67 | _dict = self.model_dump( 68 | by_alias=True, 69 | exclude=excluded_fields, 70 | exclude_none=True, 71 | ) 72 | return _dict 73 | 74 | @classmethod 75 | def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: 76 | """Create an instance of ApiResponse from a dict""" 77 | if obj is None: 78 | return None 79 | 80 | if not isinstance(obj, dict): 81 | return cls.model_validate(obj) 82 | 83 | _obj = cls.model_validate({ 84 | "status": obj.get("status"), 85 | "data": obj.get("data") 86 | }) 87 | return _obj 88 | 89 | 90 | --------------------------------------------------------------------------------