File size: 4,516 Bytes
6993919 | 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 | # rugmunch.ReportsApi
All URIs are relative to *http://localhost*
Method | HTTP request | Description
------------- | ------------- | -------------
[**generate_report_api_v1_reports_generate_post**](ReportsApi.md#generate_report_api_v1_reports_generate_post) | **POST** /api/v1/reports/generate | Generate Report
[**get_report_api_v1_reports_report_id_get**](ReportsApi.md#get_report_api_v1_reports_report_id_get) | **GET** /api/v1/reports/{report_id} | Get Report
# **generate_report_api_v1_reports_generate_post**
> GenerateResponse generate_report_api_v1_reports_generate_post(generate_request)
Generate Report
Generate a research report for a token or wallet.
Composes 7 sections in parallel via LiteLLM. Falls back to templated
content if LLM is unreachable. Saves to Postgres on success.
### Example
```python
import rugmunch
from rugmunch.models.generate_request import GenerateRequest
from rugmunch.models.generate_response import GenerateResponse
from rugmunch.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 = rugmunch.Configuration(
host = "http://localhost"
)
# Enter a context with an instance of the API client
with rugmunch.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = rugmunch.ReportsApi(api_client)
generate_request = rugmunch.GenerateRequest() # GenerateRequest |
try:
# Generate Report
api_response = api_instance.generate_report_api_v1_reports_generate_post(generate_request)
print("The response of ReportsApi->generate_report_api_v1_reports_generate_post:\n")
pprint(api_response)
except Exception as e:
print("Exception when calling ReportsApi->generate_report_api_v1_reports_generate_post: %s\n" % e)
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**generate_request** | [**GenerateRequest**](GenerateRequest.md)| |
### Return type
[**GenerateResponse**](GenerateResponse.md)
### Authorization
No authorization required
### HTTP request headers
- **Content-Type**: application/json
- **Accept**: application/json
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
**200** | Successful Response | - |
**422** | Validation Error | - |
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
# **get_report_api_v1_reports_report_id_get**
> Dict[str, object] get_report_api_v1_reports_report_id_get(report_id)
Get Report
Retrieve a previously generated report from Postgres.
### Example
```python
import rugmunch
from rugmunch.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 = rugmunch.Configuration(
host = "http://localhost"
)
# Enter a context with an instance of the API client
with rugmunch.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = rugmunch.ReportsApi(api_client)
report_id = 'report_id_example' # str |
try:
# Get Report
api_response = api_instance.get_report_api_v1_reports_report_id_get(report_id)
print("The response of ReportsApi->get_report_api_v1_reports_report_id_get:\n")
pprint(api_response)
except Exception as e:
print("Exception when calling ReportsApi->get_report_api_v1_reports_report_id_get: %s\n" % e)
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**report_id** | **str**| |
### Return type
**Dict[str, object]**
### Authorization
No authorization required
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
**200** | Successful Response | - |
**422** | Validation Error | - |
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|