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.
About Mastra
Mastra is a TypeScript-first framework for building AI agents and workflows. It provides type-safe tool definitions and composable agent pipelines.
Integration Guide
Install Mastra
npm install mastraGet your SettleGrid API key
Purchase credits for Link Preview API, then generate an API key from your Consumer Dashboard.
Register Link Preview API in your Mastra agent
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");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
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: