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 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
Requirements.
Python 3.9+
Installation & Usage
pip install
If the python package is hosted on a repository, you can install directly using:
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:
import spokest
Setuptools
Install via Setuptools.
python setup.py install --user
(or sudo python setup.py install to install the package for all users)
Then import the package:
import spokest
Tests
Execute pytest to run the tests.
Getting Started
Please follow the installation procedure and then run the following:
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 | GET /api-keys | List API keys (Mastermind only) |
| APIKeysApi | api_keys_id_delete | DELETE /api-keys/{id} | Revoke API key (Mastermind only) |
| APIKeysApi | api_keys_post | POST /api-keys | Create API key (Mastermind only) |
| CRUDApi | memories_get | GET /memories | List memories (paginated) |
| CRUDApi | memories_id_delete | DELETE /memories/{id} | Delete a memory |
| CRUDApi | memories_id_get | GET /memories/{id} | Get a memory by ID |
| CRUDApi | memories_id_history_get | GET /memories/{id}/history | Get memory version history |
| CRUDApi | memories_id_put | PUT /memories/{id} | Update a memory |
| CRUDApi | memories_id_ttl_patch | PATCH /memories/{id}/ttl | Update memory expiration |
| ChatApi | chat_post | POST /chat | Chat with your brain |
| EventsApi | memory_events_get | GET /memory/events | Poll memory events |
| ImportApi | jobs_id_get | GET /jobs/{id} | Check import job status |
| ImportApi | memory_import_post | POST /memory/import | Bulk import memories |
| MemoryApi | memory_connect_post | POST /memory/connect | Connect two memories |
| MemoryApi | memory_cross_agent_post | POST /memory/cross-agent | Cross-agent memory recall |
| MemoryApi | memory_graph_post | POST /memory/graph | Traverse memory graph |
| MemoryApi | memory_recall_post | POST /memory/recall | Recall memories |
| MemoryApi | memory_store_post | POST /memory/store | Store a memory |
| MemoryApi | memory_story_post | POST /memory/story | Reconstruct narrative timeline |
| StatusApi | status_get | GET /status | API health check |
| WebhooksApi | webhooks_get | GET /webhooks | List webhooks (Mastermind only) |
| WebhooksApi | webhooks_id_delete | DELETE /webhooks/{id} | Delete webhook |
| WebhooksApi | webhooks_id_deliveries_get | GET /webhooks/{id}/deliveries | Webhook delivery log |
| WebhooksApi | webhooks_id_get | GET /webhooks/{id} | Get webhook |
| WebhooksApi | webhooks_id_patch | PATCH /webhooks/{id} | Update webhook |
| WebhooksApi | webhooks_id_test_post | POST /webhooks/{id}/test | Test webhook |
| WebhooksApi | webhooks_post | POST /webhooks | Create webhook (Mastermind only) |
Documentation For Models
- ApiKeysPostRequest
- ChatPost200Response
- ChatRequest
- ConnectRequest
- Error
- MemoriesIdPutRequest
- MemoriesIdTtlPatchRequest
- Memory
- MemoryCrossAgentPostRequest
- MemoryGraphPostRequest
- MemoryImportPostRequest
- MemoryImportPostRequestMemoriesInner
- MemoryRecallPost200Response
- MemoryStoryPostRequest
- RecallRequest
- RecallRequestTimeRange
- StoreRequest
- WebhooksIdPatchRequest
- WebhooksPostRequest
Documentation For Authorization
Authentication schemes defined for the API:
BearerAuth
- Type: Bearer authentication
Author
Metadata
Release files for spokest 1.0.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| spokest-1.0.0.tar.gz | 39.8 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| spokest-1.0.0-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 108.3 kB
Release files / spokest-1.0.0.tar.gz
| Download URL | spokest-1.0.0.tar.gz |
|---|---|
| Size | 39.8 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
2e156125c801659ceae96a856a714b349a36843c6660886c5305f518ac2bb5ab
|
|
BLAKE2b-256 checksum How to use checksums |
2f03d314537e088f9ed8409bea9d05b6c58e551d4a1cb1de12422bab6dd95be0
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.2.0 CPython/3.9.6
|
Release files / spokest-1.0.0-py3-none-any.whl
| Download URL | spokest-1.0.0-py3-none-any.whl |
|---|---|
| Size | 68.5 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
77b3b380b561bec323cb2f3494aa8fb18cf861d757f85688b465d61e3dcfa60f
|
|
BLAKE2b-256 checksum How to use checksums |
f80b361d8534b6f1045d7a3dfdd995da41ca5cf70f786d9603e1bc79935b0f6f
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.2.0 CPython/3.9.6
|