Getting started

OleqFiles is an uploads API for organizations and apps. Your backend authenticates with an API key, then creates apps and uploads files.

Portal

You do not need an SDK to get started. The portal lets you create API keys, manage apps, and upload files directly. Use the SDKs when you want to automate the same operations from your backend.

Create an API key

Sign in to the portal.
Open API keys and create a key for your organization.
Pick a role and optional app scope. Copy the secret once (sk_test_… / sk_live_…).

Choose your stack

JavaScript / TypeScript

Node, NestJS, Next.js — @oleq-ai/file-manager

.NET (NuGet)

ASP.NET Core and workers — OleqAI.FileManager

Authentication

API keys, org binding, and environments

Concepts

Orgs, apps, files, and sandbox retention

HTTP API

REST endpoints without an SDK

Quick upload

Set OLEQFILES_API_KEY, then:

import OleqFiles from '@oleq-ai/file-manager';
import { readFile } from 'node:fs/promises';

const oleqfiles = new OleqFiles();

const { id, src } = await oleqfiles.files.upload({
  appId: 'your_app_id',
  name: 'photo.jpg',
  mimeType: 'image/jpeg',
  data: await readFile('./photo.jpg'),
});

Sandbox and production share the same API host. Use sk_test_… with sandbox apps and sk_live_… with production apps.

Production API: https://uploadspi.oleq.app