Quick Start Guide

Get up and running with CG SDK in 5 minutes!

1. Installation

npm install @cognipeer/cgate-sdk

2. Get API Key

1. Sign up at cognipeer.com
2. Go to Settings → API Tokens
3. Create a new token
4. Copy your API key

3. Initialize Client

import { CGateClient } from '@cognipeer/cgate-sdk';

const client = new CGateClient({
  apiKey: 'your-api-key',
});

4. Make Your First Request

// Chat completion
const response = await client.chat.completions.create({
  model: 'gpt-4',
  messages: [
    { role: 'user', content: 'Hello, world!' }
  ],
});

console.log(response.choices[0].message.content);

5. Try Streaming

// Streaming response
const stream = await client.chat.completions.create({
  model: 'gpt-4',
  messages: [
    { role: 'user', content: 'Tell me a story' }
  ],
  stream: true,
});

for await (const chunk of stream) {
  process.stdout.write(chunk.choices[0]?.delta?.content || '');
}

Next Steps

• Full Documentation
• API Reference
• Examples
• Chat Guide
• Vector Search

Common Use Cases

RAG System

// 1. Create embeddings
const embedding = await client.embeddings.create({
  model: 'text-embedding-3-small',
  input: 'What is AI?',
});

// 2. Search vectors
const results = await client.vectors.query('my-provider', 'my-index', {
  query: {
    vector: embedding.data[0].embedding,
    topK: 5,
  },
});

// 3. Generate answer with context
const context = results.result.matches
  .map(m => m.metadata?.text)
  .join('\n\n');

const answer = await client.chat.completions.create({
  model: 'gpt-4',
  messages: [
    {
      role: 'system',
      content: `Context: ${context}`,
    },
    {
      role: 'user',
      content: 'What is AI?',
    },
  ],
});

File Processing

// Upload file
const file = await client.files.upload('my-bucket', {
  fileName: 'document.pdf',
  data: 'data:application/pdf;base64,...',
  convertToMarkdown: true,
});

console.log(file.markdownContent);

Agent Tracing

// Track agent execution
await client.tracing.ingest({
  sessionId: 'session-123',
  agent: {
    name: 'MyAgent',
    version: '1.0.0',
  },
  status: 'completed',
  events: [...],
});

Environment Variables

# .env
CGATE_API_KEY=your-api-key

const client = new CGateClient({
  apiKey: process.env.CGATE_API_KEY!,
});

Error Handling

import { CGateAPIError } from '@cognipeer/cgate-sdk';

try {
  const response = await client.chat.completions.create({
    model: 'gpt-4',
    messages: [{ role: 'user', content: 'Hello!' }],
  });
} catch (error) {
  if (error instanceof CGateAPIError) {
    console.error('API Error:', error.message);
    console.error('Status:', error.statusCode);
  }
}

TypeScript Support

Full type safety out of the box:

import type {
  ChatCompletionRequest,
  ChatCompletionResponse,
} from '@cognipeer/cgate-sdk';

const request: ChatCompletionRequest = {
  model: 'gpt-4',
  messages: [{ role: 'user', content: 'Hello!' }],
};

Need Help?

• 📖 Documentation
• 🐛 Issues
• 📧 Email