API overview

Connect one Imole API key to apps, IDEs, agents, automations, and media tools.

API

Use the API when your own application controls the workflow and only needs model calls.

Quickstart

Use the Imole router as an OpenAI-compatible base URL. Create a key from the dashboard API page and keep it server-side.

Environment
export IMOLE_API_KEY="imole_live_..."
export IMOLE_BASE_URL="https://api.imole.app/v1"
Node SDK
import OpenAI from "openai";

const client = new OpenAI({
  apiKey: process.env.IMOLE_API_KEY,
  baseURL: process.env.IMOLE_BASE_URL
});

const response = await client.responses.create({
  model: "gpt-5.4",
  input: "Write a short welcome email for Imole."
});

const text =
  response.output_text ??
  response.output
    ?.flatMap((item) => item.content ?? [])
    .filter((content) => content.type === "output_text")
    .map((content) => content.text)
    .join("");

console.log(text);

Base paths

Use /v1/... for the simple default route. User-scoped routes can use /u/{clientId}/v1/... when a client-specific key prefix is needed.

/v1/responses
/v1/images/generations
/v1/videos
/v1/audio/speech
/v1/models

When to use API

Use direct API calls for products, backend services, internal tools, IDE integrations, automations, and your own agents. Use Imole Agent when the website should plan and deliver the full job for the user.

Next

Related docs