@spokest/[email protected]

A TypeScript SDK client for the brain-api.spokest.com API.

Usage

First, install the SDK from npm.

npm install @spokest/brain --save

Next, try it out.

import {
  Configuration,
  APIKeysApi,
} from '@spokest/brain';
import type { ApiKeysGetRequest } from '@spokest/brain';

async function example() {
  console.log("🚀 Testing @spokest/brain SDK...");
  const config = new Configuration({ 
    // Configure HTTP bearer authorization: BearerAuth
    accessToken: "YOUR BEARER TOKEN",
  });
  const api = new APIKeysApi(config);

  try {
    const data = await api.apiKeysGet();
    console.log(data);
  } catch (error) {
    console.error(error);
  }
}

// Run the test
example().catch(console.error);

Documentation

API Endpoints

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

| Class | Method | HTTP request | Description | ----- | ------ | ------------ | ------------- APIKeysApi | apiKeysGet | GET /api-keys | List API keys (Mastermind only) APIKeysApi | apiKeysIdDelete | DELETE /api-keys/{id} | Revoke API key (Mastermind only) APIKeysApi | apiKeysPost | POST /api-keys | Create API key (Mastermind only) CRUDApi | memoriesGet | GET /memories | List memories (paginated) CRUDApi | memoriesIdDelete | DELETE /memories/{id} | Delete a memory CRUDApi | memoriesIdGet | GET /memories/{id} | Get a memory by ID CRUDApi | memoriesIdHistoryGet | GET /memories/{id}/history | Get memory version history CRUDApi | memoriesIdPut | PUT /memories/{id} | Update a memory CRUDApi | memoriesIdTtlPatch | PATCH /memories/{id}/ttl | Update memory expiration ChatApi | chatPost | POST /chat | Chat with your brain EventsApi | memoryEventsGet | GET /memory/events | Poll memory events ImportApi | jobsIdGet | GET /jobs/{id} | Check import job status ImportApi | memoryImportPost | POST /memory/import | Bulk import memories MemoryApi | memoryConnectPost | POST /memory/connect | Connect two memories MemoryApi | memoryCrossAgentPost | POST /memory/cross-agent | Cross-agent memory recall MemoryApi | memoryGraphPost | POST /memory/graph | Traverse memory graph MemoryApi | memoryRecallPost | POST /memory/recall | Recall memories MemoryApi | memoryStorePost | POST /memory/store | Store a memory MemoryApi | memoryStoryPost | POST /memory/story | Reconstruct narrative timeline StatusApi | statusGet | GET /status | API health check WebhooksApi | webhooksGet | GET /webhooks | List webhooks (Mastermind only) WebhooksApi | webhooksIdDelete | DELETE /webhooks/{id} | Delete webhook WebhooksApi | webhooksIdDeliveriesGet | GET /webhooks/{id}/deliveries | Webhook delivery log WebhooksApi | webhooksIdGet | GET /webhooks/{id} | Get webhook WebhooksApi | webhooksIdPatch | PATCH /webhooks/{id} | Update webhook WebhooksApi | webhooksIdTestPost | POST /webhooks/{id}/test | Test webhook WebhooksApi | webhooksPost | POST /webhooks | Create webhook (Mastermind only)

Models

• ApiKeysPostRequest
• ChatPost200Response
• ChatRequest
• ConnectRequest
• MemoriesIdPutRequest
• MemoriesIdTtlPatchRequest
• Memory
• MemoryCrossAgentPostRequest
• MemoryGraphPostRequest
• MemoryImportPostRequest
• MemoryImportPostRequestMemoriesInner
• MemoryRecallPost200Response
• MemoryStoryPostRequest
• ModelError
• RecallRequest
• RecallRequestTimeRange
• StoreRequest
• WebhooksIdPatchRequest
• WebhooksPostRequest

Authorization

Authentication schemes defined for the API:

BearerAuth

• Type: HTTP Bearer Token authentication

About

This TypeScript SDK client supports the Fetch API and 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.TypeScriptFetchClientCodegen

The generated npm module supports the following:

• Environments
  • Node.js
  • Webpack
  • Browserify
• Language levels
  • ES5 - you must have a Promises/A+ library installed
  • ES6
• Module systems
  • CommonJS
  • ES6 module system

For more information, please visit https://spokest.com

Development

Building

To build the TypeScript source code, you need to have Node.js and npm installed. After cloning the repository, navigate to the project directory and run:

npm install
npm run build

Publishing

Once you've built the package, you can publish it to npm:

npm publish

License