gtwy-sdk

Official Node.js client for the GTWY API — build and call agentic AI, RAG, and LLM-powered agents.

npm install gtwy-sdk

const { Gtwy } = require('gtwy-sdk');

const client = new Gtwy({ authKey: '<authKey>' });

const response = await client.chat.completions.create({
  agentId: 'my-agent-id',
  user: "What's the capital of France?",
});
console.log(response.content);

authKey is the key you get from the GTWY platform (labeled authkey there). It can also come from the GTWY_AUTH_KEY environment variable. If you hold a GTWY session token instead of a pauthkey, pass Authorization instead of authKey (exactly one of the two is required). baseUrl defaults to https://api.gtwy.ai and is used only for chat/batch/rerun; agent/version/tools/knowledgeBase/apikey use a separate dbBaseUrl, defaulting to https://db.gtwy.ai. Override either (constructor option or GTWY_BASE_URL/GTWY_DB_BASE_URL) to point at a different environment.

Creating and configuring agents

// Create an agent and wait for it to come back inline
const created = await client.agent.create({ purpose: 'A support bot for order tracking', flag: true });
const agentId = created.agent._id;

// Configure its (auto-created) first version
const versionId = created.agent.versions[0];
await client.version.update(versionId, {
  configuration: { model: 'gpt-4o', prompt: 'You are a helpful support assistant.' },
  service: 'openai',
});

// Publish it, making it live
await client.version.publish(versionId);

// Rename the agent (or update any other field — see SKILLS.md)
await client.agent.update(agentId, { name: 'Order Support Bot' });

Body fields for agent/version/tools/knowledgeBase/apikey are sent through exactly as given — no camelCase translation — so field names must match what the GTWY API expects (folder_id, version_id, api_config, etc.); see SKILLS.md for the full field list per method.

See src/SKILLS.md for the full reference: every resource (chat, batch, rerun, agent, version, tools, knowledgeBase, apikey), every request field, response shapes, delivery modes (sync/webhook), and error handling. This file ships inside the installed package (not just this repo) — after npm install gtwy-sdk it's reachable at require('gtwy-sdk').SKILLS_PATH / require('gtwy-sdk').getSkillsDoc(), so an AI agent (e.g. Claude) can read it and use this SDK correctly without ever cloning this repo.

Development

npm install
npm test