Quickstart
Synoppy turns any URL into clean, structured data for your agents and pipelines. The fastest way to see it work is to scrape a single page with the live Read endpoint. You only need an API key.
1. Get an API key
Create a key in the dashboard. It is shown once at creation, so copy it somewhere safe. See Authentication for how keys are stored and used.
2. Make your first call
Send a POST request to /api/scrape with the URL you want and the formats you want back.
curl -X POST https://synoppy.com/api/scrape \
-H "Authorization: Bearer $SYNOPPY_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"url": "https://example.com",
"formats": ["markdown"]
}'3. Read the response
You get back clean content plus page metadata. From here, drop the SDK into your app or wire Synoppy into an agent over MCP.
{
"success": true,
"markdown": "# Example Domain\n\nThis domain is for use in...",
"metadata": {
"title": "Example Domain",
"sourceUrl": "https://example.com",
"statusCode": 200
},
"latencyMs": 512,
"creditsUsed": 1,
"creditsRemaining": 4999
}creditsUsed is metered per request and varies with the work — a small page is cheap, a larger one costs more.