Back to Documentation
Documentation / Developer Tools / SDKs

JavaScript/TypeScript SDK

Official SDK for Node.js and browser environments

SDK Overview

Type-safe SDK with full IntelliSense support and automatic error handling

Installation

npm

npm install @cognexiaai/sdk

yarn

yarn add @cognexiaai/sdk

pnpm

pnpm add @cognexiaai/sdk

Quick Start

import { CognexiaClient } from '@cognexiaai/sdk';

const client = new CognexiaClient({
  apiKey: process.env.COGNEXIA_API_KEY,
  environment: 'production' // or 'sandbox'
});

// Create a contact
const contact = await client.crm.contacts.create({
  firstName: 'Jane',
  lastName: 'Doe',
  email: 'jane@example.com',
  company: 'Acme Corp'
});

console.log(contact.id); // cnt_123

CRM Module

List Contacts

const contacts = await client.crm.contacts.list({
  page: 1,
  limit: 50,
  tags: ['enterprise']
});

for (const contact of contacts.data) {
  console.log(contact.email);
}

Update Contact

await client.crm.contacts.update('cnt_123', {
  tags: ['customer', 'vip'],
  customFields: {
    industry: 'Technology',
    revenue: 5000000
  }
});

Create Deal

const deal = await client.crm.deals.create({
  title: 'Enterprise License',
  value: 50000,
  contactId: 'cnt_123',
  stage: 'proposal',
  expectedCloseDate: '2026-03-31'
});

Python SDK

Installation

pip install cognexiaai

Usage

from cognexiaai import CognexiaClient

client = CognexiaClient(api_key='your_api_key')

# Create contact
contact = client.crm.contacts.create(
    first_name='Jane',
    last_name='Doe',
    email='jane@example.com'
)

# List contacts with filters
contacts = client.crm.contacts.list(
    tags=['enterprise'],
    limit=50
)

for contact in contacts:
    print(contact.email)

Error Handling

import { CognexiaError } from '@cognexiaai/sdk';

try {
  await client.crm.contacts.create({
    email: 'invalid-email'
  });
} catch (error) {
  if (error instanceof CognexiaError) {
    console.error('Status:', error.status);
    console.error('Code:', error.code);
    console.error('Message:', error.message);
  }
}

Next Steps

CLI Tools →

Command line interface

Webhooks →

Event notifications

REST API →

Full API reference