Getting Started

Documentation Overview

Welcome to the Victor Consultancy documentation. Here you'll find everything you need to integrate with our platforms and services.

New to our platform? Start with the Quick Start Guide to get up and running in minutes.

What's Covered

  • SAIOS Integration � Connect your systems with our intelligent automation platform
  • BuildEasy Setup � Build and deploy custom applications
  • API Reference � Detailed documentation for all endpoints
  • Best Practices � Guidelines for optimal implementations

Quick Start

Get started with our platform in just a few steps.

1. Get API Credentials

Contact us to receive your API credentials. You'll need:

  • API Key
  • Secret Key
  • Organization ID

2. Install the SDK

Terminal 
# npm
npm install @victor/sdk

# yarn
yarn add @victor/sdk

# pip
pip install victor-sdk

3. Initialize the Client

JavaScript 
import { VictorClient } from '@victor/sdk';

const client = new VictorClient({
  apiKey: process.env.VICTOR_API_KEY,
  secretKey: process.env.VICTOR_SECRET_KEY,
  orgId: process.env.VICTOR_ORG_ID
});

// Test connection
const status = await client.ping();
console.log('Connected:', status.ok);
Security Note: Never expose your API credentials in client-side code. Always use environment variables and server-side requests.
SAIOS

SAIOS Integration Guide

SAIOS (Smart AI Operating System) provides intelligent automation capabilities for your business processes.

Core Concepts

Agents
Specialized AI workers that handle specific tasks like research, content creation, or data analysis.
Workflows
Automated sequences of tasks that can involve multiple agents working together.
Tools
Capabilities that agents can use, like searching, creating documents, or calling APIs.
Memory
Persistent context that allows agents to learn and improve over time.

Basic Usage

JavaScript 
// Send a task to SAIOS
const result = await client.saios.runTask({
  agent: 'atlas',  // Knowledge agent
  task: 'Research the latest trends in AI automation',
  context: {
    industry: 'finance',
    timeframe: 'last 6 months'
  }
});

console.log(result.response);
API Reference

API Endpoints

POST /api/v1/tasks

Create a new task for an agent to process.

Request Body

{
  "agent": "string",       // Agent identifier
  "task": "string",        // Task description
  "context": {},           // Optional context object
  "priority": "normal",    // normal | high | urgent
  "callback_url": "string" // Optional webhook URL
}

Response

{
  "id": "task_abc123",
  "status": "processing",
  "created_at": "2026-03-02T10:00:00Z",
  "estimated_completion": "2026-03-02T10:05:00Z"
}
GET /api/v1/tasks/{id}

Get the status and result of a task.

POST /api/v1/chat

Send a message to the unified chat endpoint.