orka
Request AccessSign In

Installation

This guide walks you through setting up Orka for your project, including obtaining API keys and installing the SDK.

Prerequisites

Before you begin, ensure you have:

  • An Orka account (sign up here)
  • Node.js 18+ or Python 3.8+ installed
  • A code editor of your choice

Getting Your API Key

  1. Log in to your Orka dashboard
  2. Navigate to Settings → API Keys
  3. Click Create New Key
  4. Copy your API key and store it securely

Keep Your API Key Secret

Never expose your API key in client-side code or commit it to version control. Use environment variables to manage secrets.

Installing the SDK

JavaScript / TypeScript

Install the Orka SDK using npm or yarn:

bash
1npm install @orka/sdk

Or with yarn:

bash
1yarn add @orka/sdk

Python

Install using pip:

bash
1pip install orka

Configuration

Environment Variables

Create a .env file in your project root:

bash
1ORKA_API_KEY=your_api_key_here
2ORKA_BASE_URL=https://api.orka.ai

JavaScript Setup

javascript
1import { Orka } from '@orka/sdk';
2
3const client = new Orka({
4  apiKey: process.env.ORKA_API_KEY,
5});
6
7// Test the connection
8const agents = await client.agents.list();
9console.log('Connected! Found', agents.length, 'agents');

Python Setup

python
1from orka import Orka
2import os
3
4client = Orka(
5    api_key=os.environ.get("ORKA_API_KEY")
6)
7
8# Test the connection
9agents = client.agents.list()
10print(f"Connected! Found {len(agents)} agents")

What You Can Build

With Orka, you can build AI agents that reason about your business:

  • Answer questions grounded in your documents - Not just keyword search, but real understanding
  • Apply your business rules automatically - Define what "high-risk" or "priority" means once, use it everywhere
  • Resolve entities and relationships - "This customer" becomes Acme Corp, Enterprise tier, 3 active contracts
  • Maintain context across conversations - Session memory, user preferences, and conversation history

The difference from basic RAG? Your agents don't just retrieve—they reason.

Verifying Installation

Run a quick test to verify everything is working:

javascript
1async function testConnection() {
2  try {
3    const response = await client.health.check();
4    console.log('Status:', response.status);  // Should print "ok"
5  } catch (error) {
6    console.error('Connection failed:', error.message);
7  }
8}
9
10testConnection();

Next Steps

Now that you have Orka installed, head over to the Quickstart guide to build your first reasoning agent!

Troubleshooting

Common Issues

| Issue | Solution | |-------|----------| | 401 Unauthorized | Check that your API key is correct and not expired | | Connection timeout | Verify your network allows outbound HTTPS connections | | Module not found | Ensure you've installed the SDK correctly |

Getting Help

If you encounter issues not covered here:

  1. Check the API Reference for detailed endpoint documentation
  2. Search our GitHub Issues
  3. Contact support at support@orka.ai