katsau Docs

Quickstart

Get started with katsau API in 5 minutes. Extract your first URL metadata.

1

Get your API key

Sign up for a free account and generate an API key from your dashboard.

Your API key will look like this:

ks_live_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
2

Make your first request

Use the /v1/extract endpoint to get metadata from any URL.

curl "https://api.katsau.com/v1/extract?url=https://github.com" \
  -H "Authorization: Bearer ks_live_your_api_key"
3

Parse the response

The API returns comprehensive metadata including Open Graph, Twitter Card, and more.

{
  "success": true,
  "data": {
    "url": "https://github.com",
    "title": "GitHub: Let's build from here",
    "description": "GitHub is where over 100 million developers...",
    "image": "https://github.githubassets.com/images/modules/site/social-cards/github-social.png",
    
    "open_graph": {
      "title": "GitHub: Let's build from here",
      "description": "GitHub is where over 100 million developers...",
      "image": "https://github.githubassets.com/images/...",
      "type": "website",
      "site_name": "GitHub"
    },
    
    "twitter": {
      "card": "summary_large_image",
      "site": "@github",
      "title": "GitHub: Let's build from here"
    },
    
    "meta": {
      "favicon": "https://github.githubassets.com/favicons/favicon.svg",
      "theme_color": "#1e2327",
      "language": "en"
    }
  },
  "meta": {
    "request_id": "req_abc123xyz",
    "response_time_ms": 234,
    "cache_hit": false
  }
}

What's next?