Installation & Usage

Install this tool and use it with the AI SDK

1. Install the package

npm install @tpmjs/tools-openrouter

pnpm add @tpmjs/tools-openrouter

yarn add @tpmjs/tools-openrouter

bun add @tpmjs/tools-openrouter

deno add npm:@tpmjs/tools-openrouter

2. Import the tool

import { assignGuardrailKeys } from '@tpmjs/tools-openrouter';

3. Use with AI SDK

import { generateText } from 'ai';
import { openai } from '@ai-sdk/openai';
import { assignGuardrailKeys } from '@tpmjs/tools-openrouter';

const result = await generateText({
  model: openai('gpt-4o'),
  tools: { assignGuardrailKeys },
  prompt: 'Your prompt here...',
});

console.log(result.text);

Signature

(id: string, key_hashes: string[]) => Promise<unknown>

Parameters

Available configuration options

Auto-extracted

id

Required

Type: string

Guardrail ID

key_hashes

Required

Type: array

Array of API key hashes to assign

Schema extracted: 2/28/2026, 4:02:23 AM

README

@tpmjs/tools-openrouter

Complete OpenRouter API tools for AI agents. 33 tools covering chat completions, embeddings, model discovery, API key management, credits, analytics, and guardrails.

Installation

npm install @tpmjs/tools-openrouter

Environment Variables

Variable	Required	Description
`OPENROUTER_API_KEY`	Yes	Your OpenRouter API key
`OPENROUTER_REFERER`	No	HTTP Referer header (default: https://tpmjs.com)
`OPENROUTER_TITLE`	No	X-Title header (default: TPMJS Agent)

Tools

Chat & AI

Tool	Description
`chatCompletion`	Send chat completions to 400+ models
`createResponse`	Responses API (beta)
`createEmbedding`	Generate text embeddings

Models & Discovery

Tool	Description
`listModels`	List all models with pricing
`countModels`	Get total model count
`listUserModels`	Models filtered by user prefs
`listEmbeddingModels`	List embedding models
`listProviders`	List all providers
`listEndpoints`	Endpoints for a specific model
`previewZdr`	Preview ZDR impact

Account

Tool	Description
`getCredits`	Get remaining credits
`createCoinbaseCharge`	Add credits via crypto
`getUserActivity`	Usage analytics
`getGeneration`	Generation metadata by ID

API Keys

Tool	Description
`listApiKeys`	List all API keys
`createApiKey`	Create new key
`getApiKey`	Get key by hash
`getCurrentApiKey`	Get current key details
`updateApiKey`	Update key settings
`deleteApiKey`	Delete a key

Guardrails

Tool	Description
`listGuardrails`	List all guardrails
`createGuardrail`	Create guardrail
`getGuardrail`	Get guardrail details
`updateGuardrail`	Update guardrail
`deleteGuardrail`	Delete guardrail
`listGuardrailKeyAssignments`	All key assignments
`listGuardrailMemberAssignments`	All member assignments
`getGuardrailKeys`	Keys for a guardrail
`assignGuardrailKeys`	Assign keys
`getGuardrailMembers`	Members for a guardrail
`assignGuardrailMembers`	Assign members
`unassignGuardrailKeys`	Unassign keys
`unassignGuardrailMembers`	Unassign members

Usage

import { chatCompletion, listModels, getCredits } from '@tpmjs/tools-openrouter';

// Chat completion
const result = await chatCompletion.execute({
  model: 'openai/gpt-4o',
  messages: [{ role: 'user', content: 'Hello!' }],
});

// List models
const models = await listModels.execute({});

// Check credits
const credits = await getCredits.execute({});

License

MIT

assignGuardrailKeys

Interactive Playground