API reference
One connection.
Every tool.
Search, scrape, read chains, send email, run code, and deploy apps. Browse the full stack below, with the same Orbio credential and CREDIT balance.
Find a tool
Model inference ↓Choose a tool to see its MCP name, SDK call, API endpoint, and schemas. Social publishing needs your connected account; managed providers need no separate login.
145 tools · showing 12
web.searchFirecrawl
web.scrapeFirecrawl
chain.readAlchemy
social.x.postsX
social.instagramApify
social.postZernio
workspace.createE2B
deployment.createVercel
worker.createFly.io
database.createSupabase
mail.inbox.createAgentMail
infra.statusOrbio
The same client, throughout
Quickstart ↗import { createOrbio } from '@orbiodotso/sdk'
const orbio = await createOrbio({
apiKey: process.env.ORBIO_API_KEY,
})
// Search the web.
const search = await orbio.tools.call('web.search', {
query: 'Next.js deployment guide', limit: 5, max_cost: '0.01',
})
// Discover this connection’s running resources. No second key.
const resources = await orbio.infra.resources.list({ limit: 10 })
// Read the inbox price before creating anything.
const pricing = await orbio.infra.call('mail.pricing', {})MCP exposes both groups in the same tool list. In SDK 0.2.1, tools.list() discovers request-based tools; infra.catalogue() discovers resource tools. Both use the same client and key. This reference searches both.
Model inference
Live models ↗Use the OpenAI-compatible gateway with the same Orbio key. Select an exact model ID from the live catalogue; it includes prices, context limits, and supported parameters.
curl 'https://api.orbio.so/api/v1/models?output_modalities=text'Call a model with the OpenAI client
npm install openai
# Set these in your server environment, never in browser code:
# ORBIO_API_KEY: the gateway key from your account dashboard
# ORBIO_MODEL: an id returned by the model catalogue// Save as agent.mjs and run: node agent.mjs
import OpenAI from 'openai'
const orbio = new OpenAI({
apiKey: process.env.ORBIO_API_KEY,
baseURL: 'https://api.orbio.so/api/v1',
})
if (!process.env.ORBIO_MODEL) throw new Error('Set ORBIO_MODEL from the catalogue')
const reply = await orbio.chat.completions.create({
model: process.env.ORBIO_MODEL,
messages: [{ role: 'user', content: 'Plan the next task for my agent.' }],
max_tokens: 256,
})
console.log(reply.choices[0]?.message.content)Costs and ongoing work
Resource lifecycle ↗Request-based tools
Set max_cost in CREDIT. Metered calls settle at provider cost plus 10%. A 202 response means work is still running; cost.status: settling means the result is ready but the bill is pending.
Resources that keep running
Quote or check pricing before creation. Save the operation ID, check funding, and renew explicitly. The default surcharge is 15%; mail sends have a fixed 0.05 CREDIT price. Each credential’s resources remain isolated.
Read the relevant live catalogue for current availability: request tools or resource tools. A 401 means invalid credentials; 402 means insufficient balance. Respect Retry-After on 429 responses.
