|
| 1 | +# openapi-client |
| 2 | +API for application developers |
| 3 | + |
| 4 | +This Python package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project: |
| 5 | + |
| 6 | +- API version: 1.0.0 |
| 7 | +- Package version: 1.0.0 |
| 8 | +- Generator version: 7.12.0 |
| 9 | +- Build package: org.openapitools.codegen.languages.PythonClientCodegen |
| 10 | + |
| 11 | +## Requirements. |
| 12 | + |
| 13 | +Python 3.8+ |
| 14 | + |
| 15 | +## Installation & Usage |
| 16 | +### pip install |
| 17 | + |
| 18 | +If the python package is hosted on a repository, you can install directly using: |
| 19 | + |
| 20 | +```sh |
| 21 | +pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git |
| 22 | +``` |
| 23 | +(you may need to run `pip` with root permission: `sudo pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git`) |
| 24 | + |
| 25 | +Then import the package: |
| 26 | +```python |
| 27 | +import openapi_client |
| 28 | +``` |
| 29 | + |
| 30 | +### Setuptools |
| 31 | + |
| 32 | +Install via [Setuptools](http://pypi.python.org/pypi/setuptools). |
| 33 | + |
| 34 | +```sh |
| 35 | +python setup.py install --user |
| 36 | +``` |
| 37 | +(or `sudo python setup.py install` to install the package for all users) |
| 38 | + |
| 39 | +Then import the package: |
| 40 | +```python |
| 41 | +import openapi_client |
| 42 | +``` |
| 43 | + |
| 44 | +### Tests |
| 45 | + |
| 46 | +Execute `pytest` to run the tests. |
| 47 | + |
| 48 | +## Getting Started |
| 49 | + |
| 50 | +Please follow the [installation procedure](#installation--usage) and then run the following: |
| 51 | + |
| 52 | +```python |
| 53 | + |
| 54 | +import openapi_client |
| 55 | +from openapi_client.rest import ApiException |
| 56 | +from pprint import pprint |
| 57 | + |
| 58 | +# Defining the host is optional and defaults to http://localhost |
| 59 | +# See configuration.py for a list of all supported configuration parameters. |
| 60 | +configuration = openapi_client.Configuration( |
| 61 | + host = "http://localhost" |
| 62 | +) |
| 63 | + |
| 64 | + |
| 65 | + |
| 66 | +# Enter a context with an instance of the API client |
| 67 | +with openapi_client.ApiClient(configuration) as api_client: |
| 68 | + # Create an instance of the API class |
| 69 | + api_instance = openapi_client.AgentsApi(api_client) |
| 70 | + org_id = 56 # int | |
| 71 | + create_agent_run_input = openapi_client.CreateAgentRunInput() # CreateAgentRunInput | |
| 72 | + authorization = None # object | (optional) |
| 73 | + |
| 74 | + try: |
| 75 | + # Create Agent Run |
| 76 | + api_response = api_instance.create_agent_run_v1_organizations_org_id_agent_run_post(org_id, create_agent_run_input, authorization=authorization) |
| 77 | + print("The response of AgentsApi->create_agent_run_v1_organizations_org_id_agent_run_post:\n") |
| 78 | + pprint(api_response) |
| 79 | + except ApiException as e: |
| 80 | + print("Exception when calling AgentsApi->create_agent_run_v1_organizations_org_id_agent_run_post: %s\n" % e) |
| 81 | + |
| 82 | +``` |
| 83 | + |
| 84 | +## Documentation for API Endpoints |
| 85 | + |
| 86 | +All URIs are relative to *http://localhost* |
| 87 | + |
| 88 | +Class | Method | HTTP request | Description |
| 89 | +------------ | ------------- | ------------- | ------------- |
| 90 | +*AgentsApi* | [**create_agent_run_v1_organizations_org_id_agent_run_post**](docs/AgentsApi.md#create_agent_run_v1_organizations_org_id_agent_run_post) | **POST** /v1/organizations/{org_id}/agent/run | Create Agent Run |
| 91 | +*AgentsApi* | [**create_agent_run_v1_organizations_org_id_agent_run_post_0**](docs/AgentsApi.md#create_agent_run_v1_organizations_org_id_agent_run_post_0) | **POST** /v1/organizations/{org_id}/agent/run | Create Agent Run |
| 92 | +*AgentsApi* | [**create_agent_run_v1_organizations_org_id_agent_run_post_1**](docs/AgentsApi.md#create_agent_run_v1_organizations_org_id_agent_run_post_1) | **POST** /v1/organizations/{org_id}/agent/run | Create Agent Run |
| 93 | +*AgentsApi* | [**get_agent_run_v1_organizations_org_id_agent_run_agent_run_id_get**](docs/AgentsApi.md#get_agent_run_v1_organizations_org_id_agent_run_agent_run_id_get) | **GET** /v1/organizations/{org_id}/agent/run/{agent_run_id} | Get Agent Run |
| 94 | +*AgentsApi* | [**get_agent_run_v1_organizations_org_id_agent_run_agent_run_id_get_0**](docs/AgentsApi.md#get_agent_run_v1_organizations_org_id_agent_run_agent_run_id_get_0) | **GET** /v1/organizations/{org_id}/agent/run/{agent_run_id} | Get Agent Run |
| 95 | +*AgentsApi* | [**get_agent_run_v1_organizations_org_id_agent_run_agent_run_id_get_1**](docs/AgentsApi.md#get_agent_run_v1_organizations_org_id_agent_run_agent_run_id_get_1) | **GET** /v1/organizations/{org_id}/agent/run/{agent_run_id} | Get Agent Run |
| 96 | +*OrganizationsApi* | [**get_organizations_v1_organizations_get**](docs/OrganizationsApi.md#get_organizations_v1_organizations_get) | **GET** /v1/organizations | Get Organizations |
| 97 | +*OrganizationsApi* | [**get_organizations_v1_organizations_get_0**](docs/OrganizationsApi.md#get_organizations_v1_organizations_get_0) | **GET** /v1/organizations | Get Organizations |
| 98 | +*OrganizationsApi* | [**get_organizations_v1_organizations_get_1**](docs/OrganizationsApi.md#get_organizations_v1_organizations_get_1) | **GET** /v1/organizations | Get Organizations |
| 99 | +*UsersApi* | [**get_user_v1_organizations_org_id_users_user_id_get**](docs/UsersApi.md#get_user_v1_organizations_org_id_users_user_id_get) | **GET** /v1/organizations/{org_id}/users/{user_id} | Get User |
| 100 | +*UsersApi* | [**get_user_v1_organizations_org_id_users_user_id_get_0**](docs/UsersApi.md#get_user_v1_organizations_org_id_users_user_id_get_0) | **GET** /v1/organizations/{org_id}/users/{user_id} | Get User |
| 101 | +*UsersApi* | [**get_user_v1_organizations_org_id_users_user_id_get_1**](docs/UsersApi.md#get_user_v1_organizations_org_id_users_user_id_get_1) | **GET** /v1/organizations/{org_id}/users/{user_id} | Get User |
| 102 | +*UsersApi* | [**get_users_v1_organizations_org_id_users_get**](docs/UsersApi.md#get_users_v1_organizations_org_id_users_get) | **GET** /v1/organizations/{org_id}/users | Get Users |
| 103 | +*UsersApi* | [**get_users_v1_organizations_org_id_users_get_0**](docs/UsersApi.md#get_users_v1_organizations_org_id_users_get_0) | **GET** /v1/organizations/{org_id}/users | Get Users |
| 104 | +*UsersApi* | [**get_users_v1_organizations_org_id_users_get_1**](docs/UsersApi.md#get_users_v1_organizations_org_id_users_get_1) | **GET** /v1/organizations/{org_id}/users | Get Users |
| 105 | + |
| 106 | + |
| 107 | +## Documentation For Models |
| 108 | + |
| 109 | + - [AgentRunResponse](docs/AgentRunResponse.md) |
| 110 | + - [CreateAgentRunInput](docs/CreateAgentRunInput.md) |
| 111 | + - [FastAPIRateLimitResponse](docs/FastAPIRateLimitResponse.md) |
| 112 | + - [HTTPValidationError](docs/HTTPValidationError.md) |
| 113 | + - [OrganizationResponse](docs/OrganizationResponse.md) |
| 114 | + - [OrganizationSettings](docs/OrganizationSettings.md) |
| 115 | + - [PageOrganizationResponse](docs/PageOrganizationResponse.md) |
| 116 | + - [PageUserResponse](docs/PageUserResponse.md) |
| 117 | + - [UserResponse](docs/UserResponse.md) |
| 118 | + - [ValidationError](docs/ValidationError.md) |
| 119 | + - [ValidationErrorLocInner](docs/ValidationErrorLocInner.md) |
| 120 | + |
| 121 | + |
| 122 | +<a id="documentation-for-authorization"></a> |
| 123 | +## Documentation For Authorization |
| 124 | + |
| 125 | +Endpoints do not require authorization. |
| 126 | + |
| 127 | + |
| 128 | +## Author |
| 129 | + |
| 130 | + |
| 131 | + |
| 132 | + |
0 commit comments