Documentation

Overview

All customer endpoints are under /api/v1. Send your workspace API key as X-API-Key or Authorization: Bearer <key>. GET /health does not require a key. Catalog defaults below can be adjusted by the operator in admin.

Plans and scopes

Scopes determine which routes your keys can call. Token credits are an abstract monthly budget per plan (not raw LLM tokens).

Endpoint reference

Credit = token credits charged on a successful call (0 = free for metering). Paths use :id as a placeholder for resource IDs.

OpenAPI and explorer

Download the machine-readable spec or open the interactive Swagger UI (same host; no admin login).

https://ai.systemsolveit.com — if PUBLIC_BASE_URL is set, use that host in clients and in Postman imports.

Postman

In Postman: Import → Link → paste your deployment’s OpenAPI URL (replace host with yours if needed).

https://ai.systemsolveit.com/documentation/openapi.json

Code samples

Replace YOUR_API_BASE (origin only, no trailing slash) and YOUR_API_KEY. Paths are under /api/v1.

const axios = require('axios');

const API_BASE = 'YOUR_API_BASE'; // e.g. https://your-domain.com
const API_KEY = 'YOUR_API_KEY';

async function chat() {
  const { data } = await axios.post(
    `${API_BASE}/api/v1/chat`,
    {
      model: 'llama3.2',
      messages: [{ role: 'user', content: 'Hello' }],
    },
    { headers: { 'Content-Type': 'application/json', 'X-API-Key': API_KEY } }
  );
  return data;
}

const API_BASE = 'YOUR_API_BASE';
const API_KEY = 'YOUR_API_KEY';

const res = await fetch(`${API_BASE}/api/v1/chat`, {
  method: 'POST',
  headers: { 'Content-Type': 'application/json', 'X-API-Key': API_KEY },
  body: JSON.stringify({
    model: 'llama3.2',
    messages: [{ role: 'user', content: 'Hello' }],
  }),
});
const data = await res.json();

import requests

API_BASE = 'YOUR_API_BASE'
API_KEY = 'YOUR_API_KEY'

r = requests.post(
    f'{API_BASE}/api/v1/chat',
    headers={'X-API-Key': API_KEY, 'Content-Type': 'application/json'},
    json={'model': 'llama3.2', 'messages': [{'role': 'user', 'content': 'Hello'}]},
    timeout=120,
)
r.raise_for_status()
print(r.json())

<?php
$base = 'YOUR_API_BASE';
$key = 'YOUR_API_KEY';
$payload = json_encode([
  'model' => 'llama3.2',
  'messages' => [['role' => 'user', 'content' => 'Hello']],
]);
$ch = curl_init($base . '/api/v1/chat');
curl_setopt_array($ch, [
  CURLOPT_POST => true,
  CURLOPT_HTTPHEADER => ['Content-Type: application/json', 'X-API-Key: ' . $key],
  CURLOPT_POSTFIELDS => $payload,
  CURLOPT_RETURNTRANSFER => true,
]);
$out = curl_exec($ch);
curl_close($ch);

const API_BASE = 'YOUR_API_BASE';
const API_KEY = 'YOUR_API_KEY';

const res = await fetch(`${API_BASE}/api/v1/chat/stream`, {
  method: 'POST',
  headers: { 'Content-Type': 'application/json', 'X-API-Key': API_KEY },
  body: JSON.stringify({
    model: 'llama3.2',
    messages: [{ role: 'user', content: 'Hello' }],
  }),
});
const reader = res.body.getReader();
const dec = new TextDecoder();
while (true) {
  const { done, value } = await reader.read();
  if (done) break;
  console.log(dec.decode(value, { stream: true }));
}

const API_BASE = 'YOUR_API_BASE';
const API_KEY = 'YOUR_API_KEY';

const res = await fetch(`${API_BASE}/api/v1/generate`, {
  method: 'POST',
  headers: { 'Content-Type': 'application/json', 'X-API-Key': API_KEY },
  body: JSON.stringify({ model: 'llama3.2', prompt: 'Summarize: …' }),
});
const data = await res.json();

const API_BASE = 'YOUR_API_BASE';

const res = await fetch(`${API_BASE}/api/v1/health`);
console.log(await res.text());

const API_BASE = 'YOUR_API_BASE';
const API_KEY = 'YOUR_API_KEY';
const hdr = { 'Content-Type': 'application/json', 'X-API-Key': API_KEY };

// 1) Create dataset
let r = await fetch(`${API_BASE}/api/v1/finetune/datasets`, {
  method: 'POST', headers: hdr,
  body: JSON.stringify({ title: 'My dataset', records: [] }),
});
const ds = await r.json();
const datasetId = ds.id || ds._id;

// 2) Create job
r = await fetch(`${API_BASE}/api/v1/finetune/jobs`, {
  method: 'POST', headers: hdr,
  body: JSON.stringify({ datasetId, baseModel: 'llama3.2' }),
});
const job = await r.json();
const jobId = job.id || job._id;

// 3) Start training
await fetch(`${API_BASE}/api/v1/finetune/jobs/${jobId}/start`, { method: 'POST', headers: hdr });

// 4) Poll status
let status;
do {
  await new Promise((x) => setTimeout(x, 5000));
  r = await fetch(`${API_BASE}/api/v1/finetune/jobs/${jobId}`, { headers: { 'X-API-Key': API_KEY } });
  status = await r.json();
} while (status.state === 'running' || status.state === 'pending');

// 5) Register model in Ollama, then chat with modelName
await fetch(`${API_BASE}/api/v1/finetune/jobs/${jobId}/register`, {
  method: 'POST', headers: hdr,
  body: JSON.stringify({ modelName: 'my-tuned-model' }),
});

await fetch(`${API_BASE}/api/v1/chat`, {
  method: 'POST', headers: hdr,
  body: JSON.stringify({
    model: 'my-tuned-model',
    messages: [{ role: 'user', content: 'Hello' }],
  }),
});