Metadata-Version: 2.4
Name: spokest
Version: 1.0.0
Summary: Spokest Brain API
Home-page: 
Author: Spokest
Author-email: Spokest <team@openapitools.org>
Project-URL: Repository, https://github.com/GIT_USER_ID/GIT_REPO_ID
Keywords: OpenAPI,OpenAPI-Generator,Spokest Brain API
Requires-Python: >=3.9
Description-Content-Type: text/markdown
Requires-Dist: urllib3<3.0.0,>=2.1.0
Requires-Dist: python-dateutil>=2.8.2
Requires-Dist: pydantic>=2.11
Requires-Dist: typing-extensions>=4.7.1
Dynamic: author

# spokest
Personal AI brain that remembers everything, thinks like a genius, and belongs entirely to you. Memory management, cognitive profiling, and conversational AI for developers.

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

- API version: 1.0.0
- Package version: 1.0.0
- Generator version: 7.21.0
- Build package: org.openapitools.codegen.languages.PythonClientCodegen
For more information, please visit [https://spokest.com](https://spokest.com)

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

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

### Tests

Execute `pytest` to run the tests.

## Getting Started

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

```python

import spokest
from spokest.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://brain-api.spokest.com/v1
# See configuration.py for a list of all supported configuration parameters.
configuration = spokest.Configuration(
    host = "https://brain-api.spokest.com/v1"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure Bearer authorization: BearerAuth
configuration = spokest.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)


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

    try:
        # List API keys (Mastermind only)
        api_instance.api_keys_get()
    except ApiException as e:
        print("Exception when calling APIKeysApi->api_keys_get: %s\n" % e)

```

## Documentation for API Endpoints

All URIs are relative to *https://brain-api.spokest.com/v1*

Class | Method | HTTP request | Description
------------ | ------------- | ------------- | -------------
*APIKeysApi* | [**api_keys_get**](docs/APIKeysApi.md#api_keys_get) | **GET** /api-keys | List API keys (Mastermind only)
*APIKeysApi* | [**api_keys_id_delete**](docs/APIKeysApi.md#api_keys_id_delete) | **DELETE** /api-keys/{id} | Revoke API key (Mastermind only)
*APIKeysApi* | [**api_keys_post**](docs/APIKeysApi.md#api_keys_post) | **POST** /api-keys | Create API key (Mastermind only)
*CRUDApi* | [**memories_get**](docs/CRUDApi.md#memories_get) | **GET** /memories | List memories (paginated)
*CRUDApi* | [**memories_id_delete**](docs/CRUDApi.md#memories_id_delete) | **DELETE** /memories/{id} | Delete a memory
*CRUDApi* | [**memories_id_get**](docs/CRUDApi.md#memories_id_get) | **GET** /memories/{id} | Get a memory by ID
*CRUDApi* | [**memories_id_history_get**](docs/CRUDApi.md#memories_id_history_get) | **GET** /memories/{id}/history | Get memory version history
*CRUDApi* | [**memories_id_put**](docs/CRUDApi.md#memories_id_put) | **PUT** /memories/{id} | Update a memory
*CRUDApi* | [**memories_id_ttl_patch**](docs/CRUDApi.md#memories_id_ttl_patch) | **PATCH** /memories/{id}/ttl | Update memory expiration
*ChatApi* | [**chat_post**](docs/ChatApi.md#chat_post) | **POST** /chat | Chat with your brain
*EventsApi* | [**memory_events_get**](docs/EventsApi.md#memory_events_get) | **GET** /memory/events | Poll memory events
*ImportApi* | [**jobs_id_get**](docs/ImportApi.md#jobs_id_get) | **GET** /jobs/{id} | Check import job status
*ImportApi* | [**memory_import_post**](docs/ImportApi.md#memory_import_post) | **POST** /memory/import | Bulk import memories
*MemoryApi* | [**memory_connect_post**](docs/MemoryApi.md#memory_connect_post) | **POST** /memory/connect | Connect two memories
*MemoryApi* | [**memory_cross_agent_post**](docs/MemoryApi.md#memory_cross_agent_post) | **POST** /memory/cross-agent | Cross-agent memory recall
*MemoryApi* | [**memory_graph_post**](docs/MemoryApi.md#memory_graph_post) | **POST** /memory/graph | Traverse memory graph
*MemoryApi* | [**memory_recall_post**](docs/MemoryApi.md#memory_recall_post) | **POST** /memory/recall | Recall memories
*MemoryApi* | [**memory_store_post**](docs/MemoryApi.md#memory_store_post) | **POST** /memory/store | Store a memory
*MemoryApi* | [**memory_story_post**](docs/MemoryApi.md#memory_story_post) | **POST** /memory/story | Reconstruct narrative timeline
*StatusApi* | [**status_get**](docs/StatusApi.md#status_get) | **GET** /status | API health check
*WebhooksApi* | [**webhooks_get**](docs/WebhooksApi.md#webhooks_get) | **GET** /webhooks | List webhooks (Mastermind only)
*WebhooksApi* | [**webhooks_id_delete**](docs/WebhooksApi.md#webhooks_id_delete) | **DELETE** /webhooks/{id} | Delete webhook
*WebhooksApi* | [**webhooks_id_deliveries_get**](docs/WebhooksApi.md#webhooks_id_deliveries_get) | **GET** /webhooks/{id}/deliveries | Webhook delivery log
*WebhooksApi* | [**webhooks_id_get**](docs/WebhooksApi.md#webhooks_id_get) | **GET** /webhooks/{id} | Get webhook
*WebhooksApi* | [**webhooks_id_patch**](docs/WebhooksApi.md#webhooks_id_patch) | **PATCH** /webhooks/{id} | Update webhook
*WebhooksApi* | [**webhooks_id_test_post**](docs/WebhooksApi.md#webhooks_id_test_post) | **POST** /webhooks/{id}/test | Test webhook
*WebhooksApi* | [**webhooks_post**](docs/WebhooksApi.md#webhooks_post) | **POST** /webhooks | Create webhook (Mastermind only)


## Documentation For Models

 - [ApiKeysPostRequest](docs/ApiKeysPostRequest.md)
 - [ChatPost200Response](docs/ChatPost200Response.md)
 - [ChatRequest](docs/ChatRequest.md)
 - [ConnectRequest](docs/ConnectRequest.md)
 - [Error](docs/Error.md)
 - [MemoriesIdPutRequest](docs/MemoriesIdPutRequest.md)
 - [MemoriesIdTtlPatchRequest](docs/MemoriesIdTtlPatchRequest.md)
 - [Memory](docs/Memory.md)
 - [MemoryCrossAgentPostRequest](docs/MemoryCrossAgentPostRequest.md)
 - [MemoryGraphPostRequest](docs/MemoryGraphPostRequest.md)
 - [MemoryImportPostRequest](docs/MemoryImportPostRequest.md)
 - [MemoryImportPostRequestMemoriesInner](docs/MemoryImportPostRequestMemoriesInner.md)
 - [MemoryRecallPost200Response](docs/MemoryRecallPost200Response.md)
 - [MemoryStoryPostRequest](docs/MemoryStoryPostRequest.md)
 - [RecallRequest](docs/RecallRequest.md)
 - [RecallRequestTimeRange](docs/RecallRequestTimeRange.md)
 - [StoreRequest](docs/StoreRequest.md)
 - [WebhooksIdPatchRequest](docs/WebhooksIdPatchRequest.md)
 - [WebhooksPostRequest](docs/WebhooksPostRequest.md)


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


Authentication schemes defined for the API:
<a id="BearerAuth"></a>
### BearerAuth

- **Type**: Bearer authentication


## Author




