Quickstart
Welcome! In this guide, we'll walk you through the basics of using the Plannix API, from creating an account to making your first request.
Step 1: Create a Plannix account
Sign up for an account at console.plannix.web.id, then load it with credits to start using the API.
Step 2: Generate an API key
Create an API key via the API Keys page, then export it or add it as an environment variable.
export PLANNIX_API_KEY="your_api_key"Or add it to a .env file in your project directory:
PLANNIX_API_KEY=your_api_keyStep 3: Install an SDK
Pick your language and install the SDK:
npm install ai @plannix/sdk zodStep 4: Make your first request
Send a coding prompt to Plannix Build (plannix-3.6-ultra) and get a response. The same model powers agentic coding in Plannix Build and is available on the Plannix API:
import { plannix } from "@plannix/sdk";
import { generateText } from "ai";
const { text } = await generateText({
model: plannix.responses("plannix-3.6-ultra"),
prompt: "Fix this function and explain the bug: function median(a) { a.sort(); return a[a.length / 2]; }",
});
console.log(text);For multi-turn chat, reasoning, and structured outputs, see the Text Generation Guide. For agentic coding workflows, see the Plannix Build overview. For autonomous agent swarms, see Plannix Swarm.
Step 5: Run reasoning & analysis
Execute reasoning models with configurable thinking tokens for complex logic, system architecture, and mathematical proofs:
import { plannix } from "@plannix/sdk";
const reasoning = await plannix.reasoning.solve({
model: "plannix-3.6-ultra",
reasoningEffort: "high",
prompt: "Verify safety properties of Paxos consensus under network partitions",
});
console.log(reasoning.chainOfThought);
console.log(reasoning.finalAnswer);For more advanced use cases like AST syntax validation, database ERD generation, and high-concurrency batch processing, check out the Developer Console.
What's next
Now that you've made your first request, explore what Plannix can do: