adomo 1.1.0
CxO Bot Automation API
Requires Python: >=3.9
Keywords: OpenAPI, OpenAPI-Generator, CxO Bot Automation API

# adomo

CxO Bot Automation API manages the CxO automation platform.

## Workflows

A CxO Workflow defines the overall flow of AI automated tasks.

Conceptually, a Workflow is a sequence of steps. Those steps are defined
by advanced AI units, known as Agents, and are carried out by performing
detailed actions, resulting in a execution run.

## Schedules

CxO Schedules are features allowing you to execute specific CxO Workflows
at specified times or intervals.



This Python package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:

- API version: 0.1.0
- Package version: 1.0.0
- Generator version: 7.15.0-SNAPSHOT
- Build package: org.openapitools.codegen.languages.PythonClientCodegen

## Requirements.

Python 3.9+

## Installation & Usage
### pip install

If the python package is hosted on a repository, you can install directly using:

```sh
pip install adomo
```

Then import the package:
```python
import adomo
```

### Setuptools

Install via [Setuptools](http://pypi.python.org/pypi/setuptools).

```sh
python setup.py install --user
```
(or `sudo python setup.py install` to install the package for all users)

Then import the package:
```python
import adomo
```

### Tests

Execute `pytest` to run the tests.

## Getting Started

Please follow the [installation procedure](#installation--usage) and then run the following:

```python

import os
import adomo
from adomo.rest import ApiException
from pprint import pprint


configuration = adomo.Configuration(
    host = "https://api.[instance name].adomo.ai/"
)

# Enter a context with an instance of the API client
with adomo.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = adomo.AiApi(api_client)
    x_api_token = os.environ.get("ADOMO_API_KEY")

    try:
        # Get all Agents
        api_response = api_instance.get_agents_ai_agents_get(x_api_token=x_api_token)
        print("The response of AgentsApi->get_agents_ai_agents_get:\n")
        pprint(api_response)
    except ApiException as e:
        print(
            "Exception when calling AgentsApi->get_agents_ai_agents_get: %s\n"
            % e
        )
```

## Documentation for API Endpoints

All URIs are relative to *https://api.[instance name].adomo.ai/*

Class | Method | HTTP request | Description
------------ | ------------- | ------------- | -------------
*ActivitiesApi* | [**create_activity_activities_post**](docs/ActivitiesApi.md#create_activity_activities_post) | **POST** /activities | Create Activity
*ActivitiesApi* | [**get_activities_activities_get**](docs/ActivitiesApi.md#get_activities_activities_get) | **GET** /activities | Get Activities
*ActivitiesApi* | [**get_activity_activities_activity_id_get**](docs/ActivitiesApi.md#get_activity_activities_activity_id_get) | **GET** /activities/{activity_id} | Get Activity
*AiApi* | [**create_agent_ai_agents_post**](docs/AiApi.md#create_agent_ai_agents_post) | **POST** /ai/agents | Create Agent
*AiApi* | [**get_agent_ai_agents_agent_id_get**](docs/AiApi.md#get_agent_ai_agents_agent_id_get) | **GET** /ai/agents/{agent_id} | Get Agent
*AiApi* | [**get_agents_ai_agents_get**](docs/AiApi.md#get_agents_ai_agents_get) | **GET** /ai/agents | Get Agents
*ApiServiceApi* | [**health_check_health_get**](docs/ApiServiceApi.md#health_check_health_get) | **GET** /health | Health Check
*ApiServiceApi* | [**metrics_metrics_get**](docs/ApiServiceApi.md#metrics_metrics_get) | **GET** /metrics | Metrics
*AuthApi* | [**callback_auth_callback_get**](docs/AuthApi.md#callback_auth_callback_get) | **GET** /auth/callback | Callback
*AuthApi* | [**callback_auth_callback_get_0**](docs/AuthApi.md#callback_auth_callback_get_0) | **GET** /auth/callback | Callback
*AuthApi* | [**state_auth_callback_state_post**](docs/AuthApi.md#state_auth_callback_state_post) | **POST** /auth/callback/state | State
*AuthApi* | [**state_auth_callback_state_post_0**](docs/AuthApi.md#state_auth_callback_state_post_0) | **POST** /auth/callback/state | State
*GraphqlApi* | [**handle_http_post_graphql_post**](docs/GraphqlApi.md#handle_http_post_graphql_post) | **POST** /graphql | Handle Http Post
*IntegrationsApi* | [**oidc_callback_integrations_callback_integration_type_id_get**](docs/IntegrationsApi.md#oidc_callback_integrations_callback_integration_type_id_get) | **GET** /integrations/callback/{integration_type_id} | Oidc Callback
*JobsApi* | [**get_job_events_jobs_job_id_events_get**](docs/JobsApi.md#get_job_events_jobs_job_id_events_get) | **GET** /jobs/{job_id}/events | Get Job Events
*JobsApi* | [**get_job_jobs_job_id_get**](docs/JobsApi.md#get_job_jobs_job_id_get) | **GET** /jobs/{job_id} | Get Job
*JobsApi* | [**get_jobs_jobs_get**](docs/JobsApi.md#get_jobs_jobs_get) | **GET** /jobs | Get Jobs
*JobsApi* | [**query_job_jobs_job_id_query_get**](docs/JobsApi.md#query_job_jobs_job_id_query_get) | **GET** /jobs/{job_id}/query | Query Job
*JobsApi* | [**signal_job_jobs_job_id_signal_signal_patch**](docs/JobsApi.md#signal_job_jobs_job_id_signal_signal_patch) | **PATCH** /jobs/{job_id}/signal/{signal} | Signal Job
*JobsApi* | [**terminate_job_jobs_job_id_terminate_patch**](docs/JobsApi.md#terminate_job_jobs_job_id_terminate_patch) | **PATCH** /jobs/{job_id}/terminate | Terminate Job
*JobsApi* | [**update_job_jobs_job_id_update_update_patch**](docs/JobsApi.md#update_job_jobs_job_id_update_update_patch) | **PATCH** /jobs{job_id}/update/{update} | Update Job
*SchedulesApi* | [**backfill_schedule_schedules_schedule_id_backfill_post**](docs/SchedulesApi.md#backfill_schedule_schedules_schedule_id_backfill_post) | **POST** /schedules/{schedule_id}/backfill | Backfill Schedule
*SchedulesApi* | [**create_schedule_schedules_post**](docs/SchedulesApi.md#create_schedule_schedules_post) | **POST** /schedules | Create Schedule
*SchedulesApi* | [**delete_schedule_schedules_schedule_id_delete**](docs/SchedulesApi.md#delete_schedule_schedules_schedule_id_delete) | **DELETE** /schedules/{schedule_id} | Delete Schedule
*SchedulesApi* | [**get_schedule_schedules_schedule_id_get**](docs/SchedulesApi.md#get_schedule_schedules_schedule_id_get) | **GET** /schedules/{schedule_id} | Get Schedule
*SchedulesApi* | [**get_schedules_schedules_get**](docs/SchedulesApi.md#get_schedules_schedules_get) | **GET** /schedules | Get Schedules
*SchedulesApi* | [**pause_schedule_schedules_schedule_id_pause_patch**](docs/SchedulesApi.md#pause_schedule_schedules_schedule_id_pause_patch) | **PATCH** /schedules/{schedule_id}/pause | Pause Schedule
*SchedulesApi* | [**resume_schedule_schedules_schedule_id_resume_patch**](docs/SchedulesApi.md#resume_schedule_schedules_schedule_id_resume_patch) | **PATCH** /schedules/{schedule_id}/resume | Resume Schedule
*SchedulesApi* | [**trigger_schedule_schedules_schedule_id_trigger_post**](docs/SchedulesApi.md#trigger_schedule_schedules_schedule_id_trigger_post) | **POST** /schedules/{schedule_id}/trigger | Trigger Schedule
*SchedulesApi* | [**update_schedule_schedules_schedule_id_put**](docs/SchedulesApi.md#update_schedule_schedules_schedule_id_put) | **PUT** /schedules/{schedule_id} | Update Schedule
*UsersApi* | [**read_users_me_users_me_get**](docs/UsersApi.md#read_users_me_users_me_get) | **GET** /users/me | Read Users Me
*WorkflowsApi* | [**create_workflow_schedules_workflows_workflow_id_schedules_post**](docs/WorkflowsApi.md#create_workflow_schedules_workflows_workflow_id_schedules_post) | **POST** /workflows/{workflow_id}/schedules | Create Workflow Schedules
*WorkflowsApi* | [**create_workflow_workflows_post**](docs/WorkflowsApi.md#create_workflow_workflows_post) | **POST** /workflows | Create Workflow
*WorkflowsApi* | [**delete_workflow_workflows_workflow_id_delete**](docs/WorkflowsApi.md#delete_workflow_workflows_workflow_id_delete) | **DELETE** /workflows/{workflow_id} | Delete Workflow
*WorkflowsApi* | [**get_workflow_jobs_workflows_workflow_id_jobs_get**](docs/WorkflowsApi.md#get_workflow_jobs_workflows_workflow_id_jobs_get) | **GET** /workflows/{workflow_id}/jobs | Get Workflow Jobs
*WorkflowsApi* | [**get_workflow_schedules_workflows_workflow_id_schedules_get**](docs/WorkflowsApi.md#get_workflow_schedules_workflows_workflow_id_schedules_get) | **GET** /workflows/{workflow_id}/schedules | Get Workflow Schedules
*WorkflowsApi* | [**get_workflow_workflows_workflow_id_get**](docs/WorkflowsApi.md#get_workflow_workflows_workflow_id_get) | **GET** /workflows/{workflow_id} | Get Workflow
*WorkflowsApi* | [**get_workflows_workflows_get**](docs/WorkflowsApi.md#get_workflows_workflows_get) | **GET** /workflows | Get Workflows
*WorkflowsApi* | [**start_workflow_workflows_workflow_id_start_post**](docs/WorkflowsApi.md#start_workflow_workflows_workflow_id_start_post) | **POST** /workflows/{workflow_id}/start | Start Workflow
*WorkflowsApi* | [**update_workflow_workflows_workflow_id_put**](docs/WorkflowsApi.md#update_workflow_workflows_workflow_id_put) | **PUT** /workflows/{workflow_id} | Update Workflow


## Documentation For Models

 - [ActivityInput](docs/ActivityInput.md)
 - [ActivityInvocationInput](docs/ActivityInvocationInput.md)
 - [ActivityInvocationOutput](docs/ActivityInvocationOutput.md)
 - [ActivityOutput](docs/ActivityOutput.md)
 - [ActivityState](docs/ActivityState.md)
 - [ActivityStatementInput](docs/ActivityStatementInput.md)
 - [ActivityStatementOutput](docs/ActivityStatementOutput.md)
 - [AgentConfigInput](docs/AgentConfigInput.md)
 - [AgentConfigInputMcpServersValue](docs/AgentConfigInputMcpServersValue.md)
 - [AgentConfigOutput](docs/AgentConfigOutput.md)
 - [Attribute](docs/Attribute.md)
 - [BackfillRequest](docs/BackfillRequest.md)
 - [ChildWorkflowInvocationInput](docs/ChildWorkflowInvocationInput.md)
 - [ChildWorkflowInvocationOutput](docs/ChildWorkflowInvocationOutput.md)
 - [ChildWorkflowStatementInput](docs/ChildWorkflowStatementInput.md)
 - [ChildWorkflowStatementOutput](docs/ChildWorkflowStatementOutput.md)
 - [Command](docs/Command.md)
 - [ConditionInvocationInput](docs/ConditionInvocationInput.md)
 - [ConditionInvocationOutput](docs/ConditionInvocationOutput.md)
 - [ConditionStatementInput](docs/ConditionStatementInput.md)
 - [ConditionStatementOutput](docs/ConditionStatementOutput.md)
 - [CreateScheduleRequest](docs/CreateScheduleRequest.md)
 - [Cwd](docs/Cwd.md)
 - [Dependency](docs/Dependency.md)
 - [Dsl](docs/Dsl.md)
 - [ExecutionStatus](docs/ExecutionStatus.md)
 - [FieldType](docs/FieldType.md)
 - [Group](docs/Group.md)
 - [HTTPValidationError](docs/HTTPValidationError.md)
 - [HealthResponse](docs/HealthResponse.md)
 - [HealthStatus](docs/HealthStatus.md)
 - [HistoryEventResponse](docs/HistoryEventResponse.md)
 - [JSONValue](docs/JSONValue.md)
 - [JobResponse](docs/JobResponse.md)
 - [JobsResponse](docs/JobsResponse.md)
 - [JobsSortOn](docs/JobsSortOn.md)
 - [McpImageConfig](docs/McpImageConfig.md)
 - [McpSseConfig](docs/McpSseConfig.md)
 - [McpStdioConfig](docs/McpStdioConfig.md)
 - [ModelField](docs/ModelField.md)
 - [ModelSchema](docs/ModelSchema.md)
 - [OutputFormat](docs/OutputFormat.md)
 - [OutputFormatType](docs/OutputFormatType.md)
 - [PageInfo](docs/PageInfo.md)
 - [PageSize](docs/PageSize.md)
 - [ParallelInput](docs/ParallelInput.md)
 - [ParallelInputBranchesInner](docs/ParallelInputBranchesInner.md)
 - [ParallelOutput](docs/ParallelOutput.md)
 - [ParallelOutputBranchesInner](docs/ParallelOutputBranchesInner.md)
 - [ParallelStatementInput](docs/ParallelStatementInput.md)
 - [ParallelStatementOutput](docs/ParallelStatementOutput.md)
 - [QueryResponse](docs/QueryResponse.md)
 - [Response](docs/Response.md)
 - [Result](docs/Result.md)
 - [Root](docs/Root.md)
 - [Schedule](docs/Schedule.md)
 - [ScheduleActionExecutionStartWorkflow](docs/ScheduleActionExecutionStartWorkflow.md)
 - [ScheduleActionExecutionStartWorkflowModel](docs/ScheduleActionExecutionStartWorkflowModel.md)
 - [ScheduleActionResult](docs/ScheduleActionResult.md)
 - [ScheduleActionResultModel](docs/ScheduleActionResultModel.md)
 - [ScheduleActionStartWorkflowModel](docs/ScheduleActionStartWorkflowModel.md)
 - [ScheduleCalendarSpec](docs/ScheduleCalendarSpec.md)
 - [ScheduleDescription](docs/ScheduleDescription.md)
 - [ScheduleInfo](docs/ScheduleInfo.md)
 - [ScheduleIntervalSpec](docs/ScheduleIntervalSpec.md)
 - [ScheduleListActionStartWorkflow](docs/ScheduleListActionStartWorkflow.md)
 - [ScheduleListDescription](docs/ScheduleListDescription.md)
 - [ScheduleListInfo](docs/ScheduleListInfo.md)
 - [ScheduleListSchedule](docs/ScheduleListSchedule.md)
 - [SchedulePolicyModel](docs/SchedulePolicyModel.md)
 - [ScheduleRange](docs/ScheduleRange.md)
 - [ScheduleSpecInput](docs/ScheduleSpecInput.md)
 - [ScheduleSpecOutput](docs/ScheduleSpecOutput.md)
 - [ScheduleStateModel](docs/ScheduleStateModel.md)
 - [SecretsValue](docs/SecretsValue.md)
 - [SequenceInput](docs/SequenceInput.md)
 - [SequenceOutput](docs/SequenceOutput.md)
 - [SequenceStatementInput](docs/SequenceStatementInput.md)
 - [SequenceStatementOutput](docs/SequenceStatementOutput.md)
 - [Signal](docs/Signal.md)
 - [SleepInvocationInput](docs/SleepInvocationInput.md)
 - [SleepInvocationOutput](docs/SleepInvocationOutput.md)
 - [SleepStatementInput](docs/SleepStatementInput.md)
 - [SleepStatementOutput](docs/SleepStatementOutput.md)
 - [SortDirection](docs/SortDirection.md)
 - [StartWorkflowExecutionRequest](docs/StartWorkflowExecutionRequest.md)
 - [StartWorkflowExecutionResponse](docs/StartWorkflowExecutionResponse.md)
 - [StateInput](docs/StateInput.md)
 - [SystemPrompt](docs/SystemPrompt.md)
 - [Timeout](docs/Timeout.md)
 - [TriggerScheduleRequest](docs/TriggerScheduleRequest.md)
 - [Update](docs/Update.md)
 - [UpdateResponse](docs/UpdateResponse.md)
 - [UpdateScheduleRequest](docs/UpdateScheduleRequest.md)
 - [User](docs/User.md)
 - [ValidationError](docs/ValidationError.md)
 - [ValidationErrorLocInner](docs/ValidationErrorLocInner.md)
 - [WidgetType](docs/WidgetType.md)
 - [WorkflowInput](docs/WorkflowInput.md)
 - [WorkflowOutput](docs/WorkflowOutput.md)
 - [WorkflowState](docs/WorkflowState.md)


<a id="documentation-for-authorization"></a>
## Documentation For Authorization

Endpoints do not require authorization.


## Author