Quick Start

Get started with Connix in just a few minutes. This guide will walk you through creating your first project and launching an AI agent.

Prerequisites

• An API key from console.connix.io
• Your preferred SDK (Go, JavaScript, Python, Java, or C++)

Step 1: Get Your API Key

1. Sign up at console.connix.io
2. Navigate to Settings → API Keys
3. Click Generate New API Key
4. Copy your API key (keep it secure!)

Step 2: Install the SDK

Choose your preferred language:

JavaScript

npm install @connix/sdk

Python

pip install connix-sdk

Go

go get github.com/connix-io/connix-go

Java

<dependency>
  <groupId>io.connix</groupId>
  <artifactId>connix-sdk</artifactId>
  <version>1.0.0</version>
</dependency>

Step 3: Create Your First Project

JavaScript

import { ConnixClient } from '@connix/sdk';

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

async function quickStart() {
  // Create a project
  const project = await client.createProject({
    name: 'my-first-project'
  });

  console.log(`✅ Project created: ${project.name}`);

  // Launch an agent
  const agent = await client.launchAgent({
    name: 'hello-agent',
    projectId: project.id
  });

  console.log(`🚀 Agent launched: ${agent.message}`);
}

quickStart().catch(console.error);

Python

import connix

client = connix.Client("your-api-key-here")

# Create a project
project = client.create_project(name="my-first-project")
print(f"✅ Project created: {project.name}")

# Launch an agent
agent = client.launch_agent(
    name="hello-agent",
    project_id=project.id
)
print(f"🚀 Agent launched: {agent.message}")

Go

package main

import (
    "context"
    "fmt"
    "log"

    connix "github.com/connix-io/connix-go"
)

func main() {
    client := connix.NewClient("your-api-key-here")
    ctx := context.Background()

    // Create a project
    project, err := client.CreateProject(ctx, &connix.CreateProjectRequest{
        Name: "my-first-project",
    })
    if err != nil {
        log.Fatal(err)
    }
    fmt.Printf("✅ Project created: %s\n", project.Name)

    // Launch an agent
    agent, err := client.LaunchAgent(ctx, &connix.LaunchAgentRequest{
        Name:      "hello-agent",
        ProjectId: project.Id,
    })
    if err != nil {
        log.Fatal(err)
    }
    fmt.Printf("🚀 Agent launched: %s\n", agent.Message)
}

Step 4: Verify Everything Works

Run your code and you should see output similar to:

✅ Project created: my-first-project
🚀 Agent launched: Agent 'hello-agent' successfully launched in project 'my-first-project'

What’s Next?

Congratulations! You’ve successfully:

• ✅ Created your first Connix project
• ✅ Launched an AI agent
• ✅ Verified the Connix API is working

Continue Your Journey

• Build Your First Agent - Create a more sophisticated agent
• Container Orchestration - Deploy with Docker and Kubernetes
• API Reference - Explore all available endpoints
• Authentication Guide - Secure your applications

Get Help

• 📚 Documentation: docs.connix.io
• 💬 Community: Discord
• 🐛 Issues: GitHub
• 📧 Support: engineering@connix.io

Common Issues

Authentication Error (401)

• Double-check your API key is correct
• Ensure you’re using the API key from the correct environment

Network Timeout

• Check your internet connection
• The default timeout is 30 seconds - increase if needed

Rate Limiting (429)

• You’re making requests too quickly
• Implement exponential backoff (built into most SDKs)

Need more help? Check our authentication guide or contact support.