awesome-bookmarks/goose
3
0
Fork 0
mirror of https://github.com/block/goose.git synced 2026-07-17 12:56:20 +02:00
Code Issues Packages Projects Releases Wiki Activity
Files
generate-api-clients
goose/api_clients/python/README.md
T
Douwe Osinga 2676254851 Well this is one way
2025-10-02 20:13:20 -04:00

266 lines
14 KiB
Markdown
Raw Permalink Blame History

# goose-api
An AI agent
This Python package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
- API version: 1.9.0
- Package version: 1.0.0
- Generator version: 7.14.0
- 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 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 goose_api
```
### 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 goose_api
```
### Tests
Execute `pytest` to run the tests.
## Getting Started
Please follow the [installation procedure](#installation--usage) and then run the following:
```python
import goose_api
from goose_api.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 = goose_api.Configuration(
host = "http://localhost"
)
# Enter a context with an instance of the API client
with goose_api.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = goose_api.ContextManagementApi(api_client)
context_manage_request = goose_api.ContextManageRequest() # ContextManageRequest |
try:
api_response = api_instance.manage_context(context_manage_request)
print("The response of ContextManagementApi->manage_context:\n")
pprint(api_response)
except ApiException as e:
print("Exception when calling ContextManagementApi->manage_context: %s\n" % e)
```
## Documentation for API Endpoints
All URIs are relative to *http://localhost*
Class | Method | HTTP request | Description
------------ | ------------- | ------------- | -------------
*ContextManagementApi* | [**manage_context**](docs/ContextManagementApi.md#manage_context) | **POST** /context/manage |
*RecipeManagementApi* | [**create_recipe**](docs/RecipeManagementApi.md#create_recipe) | **POST** /recipes/create | Create a Recipe configuration from the current session
*RecipeManagementApi* | [**decode_recipe**](docs/RecipeManagementApi.md#decode_recipe) | **POST** /recipes/decode |
*RecipeManagementApi* | [**delete_recipe**](docs/RecipeManagementApi.md#delete_recipe) | **POST** /recipes/delete |
*RecipeManagementApi* | [**encode_recipe**](docs/RecipeManagementApi.md#encode_recipe) | **POST** /recipes/encode |
*RecipeManagementApi* | [**list_recipes**](docs/RecipeManagementApi.md#list_recipes) | **GET** /recipes/list |
*RecipeManagementApi* | [**scan_recipe**](docs/RecipeManagementApi.md#scan_recipe) | **POST** /recipes/scan |
*SessionManagementApi* | [**delete_session**](docs/SessionManagementApi.md#delete_session) | **DELETE** /sessions/{session_id} |
*SessionManagementApi* | [**get_session**](docs/SessionManagementApi.md#get_session) | **GET** /sessions/{session_id} |
*SessionManagementApi* | [**get_session_insights**](docs/SessionManagementApi.md#get_session_insights) | **GET** /sessions/insights |
*SessionManagementApi* | [**list_sessions**](docs/SessionManagementApi.md#list_sessions) | **GET** /sessions |
*SessionManagementApi* | [**update_session_description**](docs/SessionManagementApi.md#update_session_description) | **PUT** /sessions/{session_id}/description |
*ScheduleApi* | [**create_schedule**](docs/ScheduleApi.md#create_schedule) | **POST** /schedule/create |
*ScheduleApi* | [**delete_schedule**](docs/ScheduleApi.md#delete_schedule) | **DELETE** /schedule/delete/{id} |
*ScheduleApi* | [**inspect_running_job**](docs/ScheduleApi.md#inspect_running_job) | **GET** /schedule/{id}/inspect |
*ScheduleApi* | [**kill_running_job**](docs/ScheduleApi.md#kill_running_job) | **POST** /schedule/{id}/kill |
*ScheduleApi* | [**list_schedules**](docs/ScheduleApi.md#list_schedules) | **GET** /schedule/list |
*ScheduleApi* | [**pause_schedule**](docs/ScheduleApi.md#pause_schedule) | **POST** /schedule/{id}/pause |
*ScheduleApi* | [**run_now_handler**](docs/ScheduleApi.md#run_now_handler) | **POST** /schedule/{id}/run_now |
*ScheduleApi* | [**sessions_handler**](docs/ScheduleApi.md#sessions_handler) | **GET** /schedule/{id}/sessions |
*ScheduleApi* | [**unpause_schedule**](docs/ScheduleApi.md#unpause_schedule) | **POST** /schedule/{id}/unpause |
*ScheduleApi* | [**update_schedule**](docs/ScheduleApi.md#update_schedule) | **PUT** /schedule/{id} |
*SuperRoutesAgentApi* | [**add_sub_recipes**](docs/SuperRoutesAgentApi.md#add_sub_recipes) | **POST** /agent/add_sub_recipes |
*SuperRoutesAgentApi* | [**extend_prompt**](docs/SuperRoutesAgentApi.md#extend_prompt) | **POST** /agent/prompt |
*SuperRoutesAgentApi* | [**get_tools**](docs/SuperRoutesAgentApi.md#get_tools) | **GET** /agent/tools |
*SuperRoutesAgentApi* | [**resume_agent**](docs/SuperRoutesAgentApi.md#resume_agent) | **POST** /agent/resume |
*SuperRoutesAgentApi* | [**start_agent**](docs/SuperRoutesAgentApi.md#start_agent) | **POST** /agent/start |
*SuperRoutesAgentApi* | [**update_agent_provider**](docs/SuperRoutesAgentApi.md#update_agent_provider) | **POST** /agent/update_provider |
*SuperRoutesAgentApi* | [**update_router_tool_selector**](docs/SuperRoutesAgentApi.md#update_router_tool_selector) | **POST** /agent/update_router_tool_selector |
*SuperRoutesAgentApi* | [**update_session_config**](docs/SuperRoutesAgentApi.md#update_session_config) | **POST** /agent/session_config |
*SuperRoutesConfigManagementApi* | [**add_extension**](docs/SuperRoutesConfigManagementApi.md#add_extension) | **POST** /config/extensions |
*SuperRoutesConfigManagementApi* | [**backup_config**](docs/SuperRoutesConfigManagementApi.md#backup_config) | **POST** /config/backup |
*SuperRoutesConfigManagementApi* | [**create_custom_provider**](docs/SuperRoutesConfigManagementApi.md#create_custom_provider) | **POST** /config/custom-providers |
*SuperRoutesConfigManagementApi* | [**get_extensions**](docs/SuperRoutesConfigManagementApi.md#get_extensions) | **GET** /config/extensions |
*SuperRoutesConfigManagementApi* | [**get_provider_models**](docs/SuperRoutesConfigManagementApi.md#get_provider_models) | **GET** /config/providers/{name}/models |
*SuperRoutesConfigManagementApi* | [**init_config**](docs/SuperRoutesConfigManagementApi.md#init_config) | **POST** /config/init |
*SuperRoutesConfigManagementApi* | [**providers**](docs/SuperRoutesConfigManagementApi.md#providers) | **GET** /config/providers |
*SuperRoutesConfigManagementApi* | [**read_all_config**](docs/SuperRoutesConfigManagementApi.md#read_all_config) | **GET** /config |
*SuperRoutesConfigManagementApi* | [**read_config**](docs/SuperRoutesConfigManagementApi.md#read_config) | **POST** /config/read |
*SuperRoutesConfigManagementApi* | [**recover_config**](docs/SuperRoutesConfigManagementApi.md#recover_config) | **POST** /config/recover |
*SuperRoutesConfigManagementApi* | [**remove_config**](docs/SuperRoutesConfigManagementApi.md#remove_config) | **POST** /config/remove |
*SuperRoutesConfigManagementApi* | [**remove_custom_provider**](docs/SuperRoutesConfigManagementApi.md#remove_custom_provider) | **DELETE** /config/custom-providers/{id} |
*SuperRoutesConfigManagementApi* | [**remove_extension**](docs/SuperRoutesConfigManagementApi.md#remove_extension) | **DELETE** /config/extensions/{name} |
*SuperRoutesConfigManagementApi* | [**upsert_config**](docs/SuperRoutesConfigManagementApi.md#upsert_config) | **POST** /config/upsert |
*SuperRoutesConfigManagementApi* | [**upsert_permissions**](docs/SuperRoutesConfigManagementApi.md#upsert_permissions) | **POST** /config/permissions |
*SuperRoutesConfigManagementApi* | [**validate_config**](docs/SuperRoutesConfigManagementApi.md#validate_config) | **GET** /config/validate |
*SuperRoutesHealthApi* | [**status**](docs/SuperRoutesHealthApi.md#status) | **GET** /status |
*SuperRoutesReplyApi* | [**confirm_permission**](docs/SuperRoutesReplyApi.md#confirm_permission) | **POST** /confirm |
*SuperRoutesSetupApi* | [**start_openrouter_setup**](docs/SuperRoutesSetupApi.md#start_openrouter_setup) | **POST** /handle_openrouter |
*SuperRoutesSetupApi* | [**start_tetrate_setup**](docs/SuperRoutesSetupApi.md#start_tetrate_setup) | **POST** /handle_tetrate |
## Documentation For Models
- [AddSubRecipesRequest](docs/AddSubRecipesRequest.md)
- [AddSubRecipesResponse](docs/AddSubRecipesResponse.md)
- [Annotations](docs/Annotations.md)
- [Author](docs/Author.md)
- [AuthorRequest](docs/AuthorRequest.md)
- [ConfigKey](docs/ConfigKey.md)
- [ConfigKeyQuery](docs/ConfigKeyQuery.md)
- [ConfigResponse](docs/ConfigResponse.md)
- [Content](docs/Content.md)
- [ContextLengthExceeded](docs/ContextLengthExceeded.md)
- [ContextManageRequest](docs/ContextManageRequest.md)
- [ContextManageResponse](docs/ContextManageResponse.md)
- [CreateCustomProviderRequest](docs/CreateCustomProviderRequest.md)
- [CreateRecipeRequest](docs/CreateRecipeRequest.md)
- [CreateRecipeResponse](docs/CreateRecipeResponse.md)
- [CreateScheduleRequest](docs/CreateScheduleRequest.md)
- [DecodeRecipeRequest](docs/DecodeRecipeRequest.md)
- [DecodeRecipeResponse](docs/DecodeRecipeResponse.md)
- [DeleteRecipeRequest](docs/DeleteRecipeRequest.md)
- [EmbeddedResource](docs/EmbeddedResource.md)
- [EmbeddedResourceAnnotations](docs/EmbeddedResourceAnnotations.md)
- [EncodeRecipeRequest](docs/EncodeRecipeRequest.md)
- [EncodeRecipeResponse](docs/EncodeRecipeResponse.md)
- [ErrorResponse](docs/ErrorResponse.md)
- [ExtendPromptRequest](docs/ExtendPromptRequest.md)
- [ExtendPromptResponse](docs/ExtendPromptResponse.md)
- [ExtensionConfig](docs/ExtensionConfig.md)
- [ExtensionConfigOneOf](docs/ExtensionConfigOneOf.md)
- [ExtensionConfigOneOf1](docs/ExtensionConfigOneOf1.md)
- [ExtensionConfigOneOf2](docs/ExtensionConfigOneOf2.md)
- [ExtensionConfigOneOf3](docs/ExtensionConfigOneOf3.md)
- [ExtensionConfigOneOf4](docs/ExtensionConfigOneOf4.md)
- [ExtensionConfigOneOf5](docs/ExtensionConfigOneOf5.md)
- [ExtensionEntry](docs/ExtensionEntry.md)
- [ExtensionQuery](docs/ExtensionQuery.md)
- [ExtensionResponse](docs/ExtensionResponse.md)
- [FrontendToolRequest](docs/FrontendToolRequest.md)
- [GetToolsQuery](docs/GetToolsQuery.md)
- [Icon](docs/Icon.md)
- [ImageContent](docs/ImageContent.md)
- [InspectJobResponse](docs/InspectJobResponse.md)
- [KillJobResponse](docs/KillJobResponse.md)
- [ListRecipeResponse](docs/ListRecipeResponse.md)
- [ListSchedulesResponse](docs/ListSchedulesResponse.md)
- [Message](docs/Message.md)
- [MessageContent](docs/MessageContent.md)
- [MessageContentOneOf](docs/MessageContentOneOf.md)
- [MessageContentOneOf1](docs/MessageContentOneOf1.md)
- [MessageContentOneOf2](docs/MessageContentOneOf2.md)
- [MessageContentOneOf3](docs/MessageContentOneOf3.md)
- [MessageContentOneOf4](docs/MessageContentOneOf4.md)
- [MessageContentOneOf5](docs/MessageContentOneOf5.md)
- [MessageContentOneOf6](docs/MessageContentOneOf6.md)
- [MessageContentOneOf7](docs/MessageContentOneOf7.md)
- [MessageContentOneOf8](docs/MessageContentOneOf8.md)
- [MessageContentOneOf9](docs/MessageContentOneOf9.md)
- [MessageMetadata](docs/MessageMetadata.md)
- [ModelInfo](docs/ModelInfo.md)
- [PermissionConfirmationRequest](docs/PermissionConfirmationRequest.md)
- [PermissionLevel](docs/PermissionLevel.md)
- [PrincipalType](docs/PrincipalType.md)
- [ProviderDetails](docs/ProviderDetails.md)
- [ProviderMetadata](docs/ProviderMetadata.md)
- [ProvidersResponse](docs/ProvidersResponse.md)
- [RawAudioContent](docs/RawAudioContent.md)
- [RawEmbeddedResource](docs/RawEmbeddedResource.md)
- [RawImageContent](docs/RawImageContent.md)
- [RawResource](docs/RawResource.md)
- [RawTextContent](docs/RawTextContent.md)
- [Recipe](docs/Recipe.md)
- [RecipeManifestResponse](docs/RecipeManifestResponse.md)
- [RecipeParameter](docs/RecipeParameter.md)
- [RecipeParameterInputType](docs/RecipeParameterInputType.md)
- [RecipeParameterRequirement](docs/RecipeParameterRequirement.md)
- [RedactedThinkingContent](docs/RedactedThinkingContent.md)
- [ResourceContents](docs/ResourceContents.md)
- [ResourceContentsAnyOf](docs/ResourceContentsAnyOf.md)
- [ResourceContentsAnyOf1](docs/ResourceContentsAnyOf1.md)
- [Response](docs/Response.md)
- [ResumeAgentRequest](docs/ResumeAgentRequest.md)
- [RetryConfig](docs/RetryConfig.md)
- [RunNowResponse](docs/RunNowResponse.md)
- [ScanRecipeRequest](docs/ScanRecipeRequest.md)
- [ScanRecipeResponse](docs/ScanRecipeResponse.md)
- [ScheduledJob](docs/ScheduledJob.md)
- [Session](docs/Session.md)
- [SessionConfigRequest](docs/SessionConfigRequest.md)
- [SessionDisplayInfo](docs/SessionDisplayInfo.md)
- [SessionInsights](docs/SessionInsights.md)
- [SessionListResponse](docs/SessionListResponse.md)
- [SessionsQuery](docs/SessionsQuery.md)
- [Settings](docs/Settings.md)
- [SetupResponse](docs/SetupResponse.md)
- [StartAgentRequest](docs/StartAgentRequest.md)
- [SubRecipe](docs/SubRecipe.md)
- [SuccessCheck](docs/SuccessCheck.md)
- [SummarizationRequested](docs/SummarizationRequested.md)
- [TextContent](docs/TextContent.md)
- [ThinkingContent](docs/ThinkingContent.md)
- [Tool](docs/Tool.md)
- [ToolAnnotations](docs/ToolAnnotations.md)
- [ToolConfirmationRequest](docs/ToolConfirmationRequest.md)
- [ToolInfo](docs/ToolInfo.md)
- [ToolPermission](docs/ToolPermission.md)
- [ToolRequest](docs/ToolRequest.md)
- [ToolResponse](docs/ToolResponse.md)
- [UpdateProviderRequest](docs/UpdateProviderRequest.md)
- [UpdateRouterToolSelectorRequest](docs/UpdateRouterToolSelectorRequest.md)
- [UpdateScheduleRequest](docs/UpdateScheduleRequest.md)
- [UpdateSessionDescriptionRequest](docs/UpdateSessionDescriptionRequest.md)
- [UpsertConfigQuery](docs/UpsertConfigQuery.md)
- [UpsertPermissionsQuery](docs/UpsertPermissionsQuery.md)
<a id="documentation-for-authorization"></a>
## Documentation For Authorization
Endpoints do not require authorization.
## Author
ai-oss-tools@block.xyz
Reference in New Issue View Git Blame Copy Permalink