@orka-js/server
v1.5.2
Published
Dev server with React+Vite playground for OrkaJS agents
Readme
@orka-js/server
Zero-config HTTP server for OrkaJS agents — get a REST API running in one function call.
Installation
npm install @orka-js/server @orka-js/coreQuick Start
import { createOrkaServer } from '@orka-js/server'
import { Orka } from '@orka-js/core'
import { OpenAIAdapter } from '@orka-js/openai'
import { ReActAgent } from '@orka-js/agent'
const orka = new Orka({
llm: new OpenAIAdapter({ apiKey: process.env.OPENAI_API_KEY! }),
})
const server = await createOrkaServer({
orka,
agents: [
{ name: 'assistant', agent: new ReActAgent({ orka, tools: [] }) },
],
port: 3000,
})
console.log(`Server running on port ${server.port}`)
// Routes: GET /ai, GET /ai/:name, POST /ai/:name, POST /ai/:name/streamStart / Stop
const server = createOrkaServer(config) // does not auto-start
await server.start() // start listening
await server.stop() // graceful shutdownConfiguration
| Option | Type | Default | Description |
|--------|------|---------|-------------|
| orka | Orka | — | OrkaJS instance (required) |
| agents | AgentConfig[] | — | Agents to expose (required) |
| port | number | 3000 | HTTP port |
| host | string | '0.0.0.0' | Bind address |
API
createOrkaServer(config): OrkaServerInstance
interface OrkaServerInstance {
port: number
start(): Promise<void>
stop(): Promise<void>
}Related Packages
@orka-js/express— Express middleware (more control)@orka-js/hono— Edge-compatible alternative@orka-js/nestjs— NestJS integration@orka-js/core— Core typesorkajs— Full bundle
