How to use Whois with Mastra

Integrate Whois into your Mastra agent with SettleGrid's per-call billing. No subscriptions, no minimums — pay only for what you use.

About Whois

Domain WHOIS registration and availability lookup.

Security & Compliancev1.0.0by Lex Whiting

About Mastra

Mastra is a TypeScript-first framework for building AI agents and workflows. It provides type-safe tool definitions and composable agent pipelines.

TypeScript

Integration Guide

1

Install Mastra

Terminal
npm install mastra
2

Get your SettleGrid API key

Purchase credits for Whois, then generate an API key from your Consumer Dashboard.

3

Register Whois in your Mastra agent

TypeScript
import { Agent, createTool } from "mastra";
import { z } from "zod";

// Define the tool with Zod schema
const whoisTool = createTool({
  id: "whois",
  description: "Whois — call via SettleGrid",
  inputSchema: z.object({
    query: z.string().describe("Input query"),
  }),
  execute: async ({ context }) => {
    const resp = await fetch(
      "https://proxy.settlegrid.ai/v1/whois",
      {
        method: "POST",
        headers: {
          "x-api-key": "sg_live_your_key_here",
          "Content-Type": "application/json",
        },
        body: JSON.stringify({ query: context.query }),
      }
    );
    if (!resp.ok) throw new Error(`Whois failed: ${resp.status}`);
    return resp.json();
  },
});

// Create an agent with the tool
const agent = new Agent({
  name: "whois-agent",
  instructions: "Use Whois to accomplish the task.",
  model: { provider: "OPEN_AI", name: "gpt-4o" },
  tools: { whois: whoisTool },
});

const result = await agent.generate("Use Whois for this input");
4

Run your agent

Execute your Mastra agent. SettleGrid automatically meters each call to Whois and deducts from your credit balance. No rate limits beyond your purchased credits.

Pricing

Cost per call3¢

No subscriptions or minimums. Credits never expire. See full pricing details.

Try Whois

Purchase credits and start using Whois in your Mastra agent today.

View Whois →

SettleGrid Help

AI-powered support

How can I help?

Ask me anything about SettleGrid