@gpt-core/client 1.0.0

package/README.md

@@ -0,0 +1,64 @@
+# @gpt-core/client
+
+The official TypeScript Client SDK for the GPT Core Platform.
+
+## Installation
+
+```bash
+npm install @gpt-core/client
+# or
+yarn add @gpt-core/client
+```
+
+## Quick Start
+
+```typescript
+import { GptClient } from '@gpt-core/client';
+
+const client = new GptClient({
+  baseUrl: 'https://api.gpt-core.com',
+  apiKey: 'your-public-key', // Optional for some endpoints
+  token: 'user-jwt-token',   // Optional for authenticated endpoints
+});
+
+// Authenticate
+const { user, token } = await client.identity.login('user@example.com', 'password');
+console.log(`Welcome, ${user.attributes.full_name}`);
+
+// Search AI
+const results = await client.ai.search('quarterly earnings');
+```
+
+## Features
+
+- **Typed Inputs & Outputs**: Fully typed request/response bodies generated from OpenAPI specs.
+- **Auto-Unwrapping**: Automatically handles JSON:API envelopes (`data: { type: ..., attributes: ... }`) so you get clean objects.
+- **Modular**: Grouped by domain (`identity`, `platform`, `ai`, `extraction`, `billing`).
+
+## Domains
+
+### Identity
+Manage users, profiles, and API keys.
+```typescript
+await client.identity.me();
+await client.identity.apiKeys.create('My Key');
+```
+
+### Platform
+Manage applications, workspaces, and tenants.
+```typescript
+await client.platform.applications.list();
+await client.platform.workspaces.create('New Workspace');
+```
+
+### AI
+Interact with Agents, Threads, and semantic search.
+```typescript
+await client.ai.threads.sendMessage('thread-id', 'Hello AI');
+```
+
+### Extraction & Storage
+Upload documents and manage files.
+```typescript
+await client.extraction.documents.uploadBase64('file.pdf', 'base64string...');
+```