Getting Started

Installation

Install the CogniKin SDK in your preferred language.

Prerequisites

Before installing CogniKin, ensure you have:

Node.js 16+ (for TypeScript/JavaScript)
Python 3.8+ (for Python)
A CogniKin API key (sign up at cognikin.me)

TypeScript / JavaScript

Install the official TypeScript SDK using npm or yarn:

npm install @cognikin/client

Or with yarn:

yarn add @cognikin/client

Or with pnpm:

pnpm add @cognikin/client

Verification

Verify the installation by importing the client:

import { CogniKin } from '@cognikin/client';

const brain = new CogniKin({
  apiKey: process.env.COGNIKIN_API_KEY,
});

console.log('CogniKin client initialised successfully');

Python

Install the official Python SDK using pip:

pip install cognikin

Or with poetry:

poetry add cognikin

Verification

Verify the installation:

from cognikin import CogniKin

brain = CogniKin(api_key=os.environ.get("COGNIKIN_API_KEY"))
print("CogniKin client initialised successfully")

Direct REST API

If you prefer to use the REST API directly without an SDK, you can make HTTP requests to:

https://api.cognikin.me/v1

All requests require an Authorization header with your API key:

curl https://api.cognikin.me/v1/context \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "userId": "user_123",
    "task": "build a login page"
  }'

See the REST API documentation for full details.

Framework-Specific Guides

Next.js

Works seamlessly with App Router and Pages Router.

// app/api/agent/route.ts
import { CogniKin } from '@cognikin/client';

const brain = new CogniKin({
  apiKey: process.env.COGNIKIN_API_KEY,
});

Express.js

Integrate into your Express middleware or routes.

import { CogniKin } from '@cognikin/client';
import express from 'express';

const brain = new CogniKin({
  apiKey: process.env.COGNIKIN_API_KEY,
});

FastAPI

Perfect for Python-based AI agent backends.

from cognikin import CogniKin
from fastapi import FastAPI

brain = CogniKin(api_key=os.getenv("COGNIKIN_API_KEY"))

LangChain

Integrate CogniKin into your LangChain agents.

from cognikin import CogniKin
from langchain.agents import Agent

brain = CogniKin(api_key=os.getenv("COGNIKIN_API_KEY"))

Environment Variables

Store your API key securely using environment variables. Create a .env file:

.env

COGNIKIN_API_KEY=ck_sk_your_secret_key_here

⚠️ Security Warning: Never commit your API key to version control. Add .env to your .gitignore file.

Next Steps

Now that you've installed CogniKin, learn how to: