API

Build with NOXUS tools.

Use one API key, prepaid API USD balance, predictable endpoints, and the same tools available in the web catalog.

api.noxus.lat

curl -X POST https://noxus.lat/api/v1/tools/qr \
  -H "Authorization: Bearer TU_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"text":"https://noxus.lat","output_format":"png"}'

Auth

Bearer token

Create an app and API key from your developer panel. Send the key in every request.

Authorization: Bearer TU_API_KEY

Billing

Separate API USD

Endpoints validate balance before processing and charge only after successful output.

{
  "billing": {
    "currency": "USD",
    "estimated_usd": "0.002",
    "charged_usd": "0.002",
    "balance_after_usd": "9.998"
  }
}

Errors

Consistent responses

Missing key returns 401, insufficient API balance returns 402, and exceeded limits return 413.

{
  "success": false,
  "error": "Saldo API insuficiente.",
  "error_code": "insufficient_api_balance",
  "request_id": "req_...",
  "billing": {"charged_usd": "0"}
}

Start

First API calls

Use these endpoints before processing files: one confirms that the key works, the other shows prepaid API USD balance.

POST

/api/v1/ping

Validates the API key and returns 200 when the connection is ready.

curl -X POST https://noxus.lat/api/v1/ping \
  -H "Authorization: Bearer TU_API_KEY"

{
  "success": true,
  "status": "ok",
  "request_id": "req_...",
  "api_key": {"key_hint": "noxus_test_...", "environment": "test"},
  "account": {"tier": "free", "status": "active"}
}

GET

/api/v1/balance

Reads API USD balance. It does not move credits or create jobs.

curl https://noxus.lat/api/v1/balance \
  -H "Authorization: Bearer TU_API_KEY"

{
  "success": true,
  "balance": {
    "currency": "USD",
    "balance_usd": "10",
    "available_usd": "10",
    "lifetime_spent_usd": "0"
  }
}

Production contract

The API uses scopes, per-key rate limits, usage logs, and idempotency keys so integrations can retry safely.

Scopes

tools:run

Keys can be limited to specific tools. New keys can run the active catalog by default.

{
  "scopes": ["tools:run"],
  "tools": ["crear-qr", "convertir-formato-imagen"]
}

Rate limit

By key and tier

Free keys start with 60 successful API jobs per hour. Higher tiers can be configured from the developer account.

{
  "error_code": "rate_limit_exceeded",
  "limit": {"limit": 60, "window_seconds": 3600}
}

Idempotency-Key

Safe retries

Send the same key when retrying a request. NOXUS returns the original job response instead of charging again.

Idempotency-Key: qr-2026-05-25-001

Workflows

Heavy tools are one-shot in API v1

The web can expose an editor with intermediate steps. The public API v1 receives the final intent and NOXUS runs the internal pipeline in one request.

Script to video

Idea or script

Send idea when you want NOXUS to write the script. Send script when your app already has it. The response includes script, scenes, segments and the rendered video.

POST /api/v1/tools/script-to-video
idea=Un video sobre vender mas con automatizacion

POST /api/v1/tools/script-to-video
script=Hook: deja de perder leads...

Subtitles

Upload video

NOXUS transcribes, builds editable subtitle segments internally, renders the selected style and returns transcript plus segments for your records.

POST /api/v1/tools/auto-subtitles
video=@clip.mp4
language=es
style=yellow_punch

AI video

Prompt and references

Send the prompt directly, plus optional image, video or audio references. Dynamic billing estimates are returned in the response.

POST /api/v1/tools/ai-video-generate
prompt=Anuncio vertical de cafe
first_frame_image=@inicio.jpg
duration=8

Guide

How requests work

Every tool keeps the same contract: validate auth, validate limits, validate balance, process the file, then charge only on success.

Files

multipart/form-data

Recommended for browser, mobile, backend apps, and batch uploads.

curl -X POST https://noxus.lat/api/v1/tools/image-convert \
  -H "Authorization: Bearer TU_API_KEY" \
  -F "image=@foto.png" \
  -F "output_format=webp" \
  -F "filename=mi-imagen"

JSON

base64

Useful when your integration already stores files as base64 or sends jobs from queues.

{
  "filename": "foto.png",
  "content_base64": "...",
  "output_format": "webp"
}

Response

Stable shape

Successful calls include output metadata, billing details, and a job id for history.

{
  "success": true,
  "tool": "image-convert",
  "job_id": 42,
  "billing": {
    "estimated_usd": "0.002",
    "charged_usd": "0.002",
    "balance_after_usd": "9.998"
  },
  "output": {
    "filename": "mi-imagen.webp",
    "mime_type": "image/webp",
    "content_base64": "..."
  }
}

Endpoints

Available API tools

This list is generated from the active tool catalog. Dynamic tools show a starting price because the final charge depends on duration, files, scenes, resolution or provider work.

POST Loading

Loading API tools...

The endpoint catalog is loading in the background so the documentation opens faster.

Create an app

Apps group your API keys and future usage limits.

Recharge API USD

API credits are separate from web NOX and web plans.

Run tools

Responses return job_id, billing, and output metadata.