# deep-agent-sdk
FastAPI service for running Mentortools deep agent

This Python package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:

- API version: 0.1.0
- Package version: 0.1.0+2525545272
- Generator version: 7.22.0
- Build package: org.openapitools.codegen.languages.PythonPydanticV1ClientCodegen

## Requirements.

Python 3.7+

## Installation & Usage
### pip install

If the python package is hosted on a repository, you can install directly using:

```sh
pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git
```
(you may need to run `pip` with root permission: `sudo pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git`)

Then import the package:
```python
import deep_agent_sdk
```

### 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 deep_agent_sdk
```

### Tests

Execute `pytest` to run the tests.

## Getting Started

Please follow the [installation procedure](#installation--usage) and then run the following:

```python

import time
import deep_agent_sdk
from deep_agent_sdk.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = deep_agent_sdk.Configuration(
    host = "http://localhost"
)



# Enter a context with an instance of the API client
async with deep_agent_sdk.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = deep_agent_sdk.CatalogApi(api_client)

    try:
        # List available skills
        api_response = await api_instance.get_skills_catalog_catalog_skills_get()
        print("The response of CatalogApi->get_skills_catalog_catalog_skills_get:\n")
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling CatalogApi->get_skills_catalog_catalog_skills_get: %s\n" % e)

```

## Documentation for API Endpoints

All URIs are relative to *http://localhost*

Class | Method | HTTP request | Description
------------ | ------------- | ------------- | -------------
*CatalogApi* | [**get_skills_catalog_catalog_skills_get**](docs/CatalogApi.md#get_skills_catalog_catalog_skills_get) | **GET** /catalog/skills | List available skills
*CatalogApi* | [**get_tools_catalog_catalog_tools_get**](docs/CatalogApi.md#get_tools_catalog_catalog_tools_get) | **GET** /catalog/tools | List available tools
*HealthApi* | [**health_check_health_get**](docs/HealthApi.md#health_check_health_get) | **GET** /health | Health check
*RunsApi* | [**cancel_run_runs_run_id_cancel_post**](docs/RunsApi.md#cancel_run_runs_run_id_cancel_post) | **POST** /runs/{run_id}/cancel | Cancel a running agent run
*RunsApi* | [**create_run_runs_post**](docs/RunsApi.md#create_run_runs_post) | **POST** /runs | Create a new agent run


## Documentation For Models

 - [CatalogSkillEntry](docs/CatalogSkillEntry.md)
 - [CatalogToolEntry](docs/CatalogToolEntry.md)
 - [ChatMessageAttachment](docs/ChatMessageAttachment.md)
 - [ChatMessageAttachmentType](docs/ChatMessageAttachmentType.md)
 - [DynamicSkillInput](docs/DynamicSkillInput.md)
 - [HTTPValidationError](docs/HTTPValidationError.md)
 - [HealthResponse](docs/HealthResponse.md)
 - [LocationInner](docs/LocationInner.md)
 - [PortalInfo](docs/PortalInfo.md)
 - [PortalOwnerInfo](docs/PortalOwnerInfo.md)
 - [RunAssistantContext](docs/RunAssistantContext.md)
 - [RunCancelResponse](docs/RunCancelResponse.md)
 - [RunChatContext](docs/RunChatContext.md)
 - [RunCreateRequest](docs/RunCreateRequest.md)
 - [RunCreateResponse](docs/RunCreateResponse.md)
 - [RunUserContext](docs/RunUserContext.md)
 - [SkillsCatalogResponse](docs/SkillsCatalogResponse.md)
 - [ToolsCatalogResponse](docs/ToolsCatalogResponse.md)
 - [ValidationError](docs/ValidationError.md)
 - [WrappedResponseHealthResponse](docs/WrappedResponseHealthResponse.md)
 - [WrappedResponseRunCancelResponse](docs/WrappedResponseRunCancelResponse.md)
 - [WrappedResponseRunCreateResponse](docs/WrappedResponseRunCreateResponse.md)
 - [WrappedResponseSkillsCatalogResponse](docs/WrappedResponseSkillsCatalogResponse.md)
 - [WrappedResponseToolsCatalogResponse](docs/WrappedResponseToolsCatalogResponse.md)


<a id="documentation-for-authorization"></a>
## Documentation For Authorization

Endpoints do not require authorization.


## Author




