How to use Link Preview API with Mastra

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

About Link Preview API

Extract metadata, Open Graph data, and preview info from any URL. Returns title, description, image, favicon, and domain information.

Analytics & BIv1.0.0by Twam

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 Link Preview API, then generate an API key from your Consumer Dashboard.

3

Register Link Preview API in your Mastra agent

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

// Define the tool with Zod schema
const opik_analytics_apiTool = createTool({
  id: "opik_analytics_api",
  description: "LinkPreviewAPI — call via SettleGrid",
  inputSchema: z.object({
    query: z.string().describe("Input query"),
  }),
  execute: async ({ context }) => {
    const resp = await fetch(
      "https://proxy.settlegrid.ai/v1/opik_analytics_api",
      {
        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(`LinkPreviewAPI failed: ${resp.status}`);
    return resp.json();
  },
});

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

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

Run your agent

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

Pricing

Cost per call1¢

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

Try Link Preview API

Purchase credits and start using Link Preview API in your Mastra agent today.

View Link Preview API →

Other Frameworks

Use Link Preview API with other agent frameworks:

SettleGrid Help

AI-powered support

How can I help?

Ask me anything about SettleGrid