Authentication

Getting Your App ID

1. Sign up at dashboard.opengraph.io
2. Navigate to your dashboard after logging in
3. Copy your App ID from the dashboard

Free accounts include 100 API credits per month—enough to test and build small projects.

Using Your App ID

Pass your App ID as the app_id query parameter on every request:

curl "https://opengraph.io/api/1.1/site/https%3A%2F%2Fgithub.com?app_id=YOUR_APP_ID"

const appId = process.env.OPENGRAPH_APP_ID;
const url = encodeURIComponent('https://github.com');

const response = await fetch(
  `https://opengraph.io/api/1.1/site/${url}?app_id=${appId}`
);

Security Best Practices

Server-Side Applications

Store your App ID in environment variables:

OPENGRAPH_APP_ID=your_app_id_here

Frontend Applications

Create a backend proxy to make OpenGraph.io requests on behalf of your frontend. Never include the App ID in JavaScript that runs in the browser.

// pages/api/unfurl.ts
export default async function handler(req, res) {
  const { url } = req.query;
  const appId = process.env.OPENGRAPH_APP_ID;
  
  const response = await fetch(
    `https://opengraph.io/api/1.1/site/${encodeURIComponent(url)}?app_id=${appId}`
  );
  
  const data = await response.json();
  res.json(data);
}

MCP Integration

When using MCP, your App ID is stored in your local config file and never sent to the AI model. This is secure by design.

Learn more about MCP security →

Rotating Your App ID

If you believe your App ID has been compromised:

1. Log into the dashboard
2. Generate a new App ID
3. Delete the old App ID
4. Update your applications with the new ID
5. The old ID will be invalidated

Related