GPT Core Client SDK

TypeScript SDK for GPT Core Platform

Quick Start Guide

Get up and running with the GPT Core Client SDK in minutes.

Installation

npm install @gpt-core/client

Configuration

Create a client instance with your API key:

import { GPTCore } from '@gpt-core/client';

const client = new GPTCore({
  apiKey: process.env.GPT_API_KEY,
  baseURL: 'https://api.gptintegrators.com'
});

API Key

Get your API key from the Platform Dashboard.

Environment Variables

# .env
GPT_API_KEY=sk_live_your_key_here
GPT_BASE_URL=https://api.gptintegrators.com

Basic Usage

Document Extraction

// Upload and extract a document
const result = await client.extraction.documents.create({
  workspaceId: 'ws_123',
  fileId: 'file_456',
  agentId: 'agent_789'
});

console.log(result.data);
// { id: 'ext_123', status: 'completed', data: {...} }

Streaming Results

// Stream extraction results in real-time
const stream = await client.extraction.documents.stream({
  documentId: 'ext_123'
});

for await (const chunk of stream) {
  console.log(chunk);
}

List Workspaces

// List all workspaces with pagination
const workspaces = await client.platform.workspaces.list({
  page: { number: 1, size: 20 }
});

console.log(workspaces.data);

Error Handling

import { GPTCore, ApiError } from '@gpt-core/client';

try {
  const result = await client.extraction.documents.create({...});
} catch (error) {
  if (error instanceof ApiError) {
    console.error('API Error:', error.status, error.message);
    if (error.status === 401) {
      console.error('Invalid API key');
    } else if (error.status === 429) {
      console.error('Rate limit exceeded');
    }
  }
}

Next Steps

Need Help?